ordering.CMBDataFrame: HEALPix ordering scheme from a CMBDataFrame

In frycast/rcosmo: Cosmic Microwave Background Data Analysis

HEALPix ordering scheme from a CMBDataFrame

Description

This function returns the HEALPix ordering scheme from a CMBDataFrame. The ordering scheme is either "ring" or "nested".

Usage

## S3 method for class 'CMBDataFrame'
ordering(x, new.ordering, ...)

Arguments

x	A CMBDataFrame.
new.ordering	Specifies the new ordering ("ring" or "nest") if a change of ordering scheme is desired.
...	Unused arguments.

Details

If a new ordering is specified, using e.g. new.ordering = "ring", the ordering scheme of the CMBDataFrame will be converted.

Value

The name of the HEALPix ordering scheme that is used in the CMBDataFrame x.

Examples

df <- CMBDataFrame(nside = 1, ordering = "nested")
ordering(df)
df1 <- ordering(df, new.ordering = "ring")
ordering(df1)

frycast/rcosmo documentation built on Oct. 11, 2022, 5:21 p.m.