window.CMBDat: Get a sub window from a 'CMBDat' object

Description Usage Arguments Details Value Examples

View source: R/CMBDat.R

Description

This function returns a data.frame containing the data in x restricted to the CMBWindow new.window

Usage

1
2
## S3 method for class 'CMBDat'
window(x, new.window, intersect = TRUE, ...)

Arguments

x

a CMBDat object.

new.window

A single CMBWindow object or a list of them.

intersect

A boolean that determines the behaviour when new.window is a list containing BOTH regular type and "minus" type windows together (see details).

...

Unused arguments.

Details

Windows that are tagged with set.minus (see CMBWindow) are treated differently from other windows.

If the argument is a list of CMBWindows, then interious of all windows whose winType does not include "minus" are united (let A be their union) and exteriors of all windows whose winType does include "minus" are intersected, (let B be their intersection). Then, provided that intersect = TRUE (the default), the returned data.frame will be the points of cmbdat$data in the the intersection of A and B. Otherwise, if intersect = FALSE, the returned data.frame consists of the points of x$data in the union of A and B.

Note that if A (resp. B) is empty then the returned data.frame will be the points of x in B (resp. A).

Value

A CMBDataFrame containing the data in x restricted to the CMBWindow new.window

Examples

1
2
3
4
5
6
7
8
win1 <- CMBWindow(theta = c(0,pi/2,pi/2), phi = c(0,0,pi/2))

## Ensure you have a FITS file with correct path
## before uncommenting and running the rest of the example:
# cmbdat <- CMBDat("CMB_map_smica1024.fits", mmap = TRUE)
# class(cmbdat)
# cmbdat.win <- window(cmbdat, new.window = win1)
# class(cmbdat.win)

rcosmo documentation built on Dec. 11, 2021, 9:29 a.m.