rcosmo (version 1.1.3)

ordering.CMBDataFrame: 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 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.

Value

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

Details

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

Examples

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

# }