rcosmo (version 1.1.2)

ordering.HPDataFrame: HEALPix ordering scheme from a HPDataFrame

Description

This function returns the HEALPix ordering scheme from a HPDataFrame. The ordering scheme is either "ring" or "nested". If a new ordering is specified, using e.g. new.ordering = "ring", the ordering scheme of the HPDataFrame will be converted.

Usage

# S3 method for HPDataFrame
ordering(x, new.ordering, ...)

Arguments

x

a HPDataFrame.

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 HPDataFrame x, or a new HPDataFrame with the desired new.ordering

Examples

# NOT RUN {
df <- HPDataFrame(I = rep(0,12), nside = 1, ordering = "nested")
ordering(df)
df1 <- ordering(df, new.ordering = "ring")
ordering(df1)

# }