displayPixelBoundaries: Plot HEALPix pixel boundaries

Description Usage Arguments Value Examples

View source: R/DisplayHEALPix.R

Description

Plot the HEALPix pixel boundaries at nside

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
displayPixelBoundaries(
  nside,
  eps = pi/90,
  col = "gray",
  lwd = 1,
  ordering,
  incl.labels = 1:(12 * nside^2),
  nums.col = col,
  nums.size = 1,
  font = 2,
  depth_test = "always",
  ...
)

Arguments

nside

the HEALPix nside parameter (integer number 2^k)

eps

controls the smoothness of the plot, smaller eps implies more samples

col

the colour of plotted boundary lines

lwd

the thickness of the plotted boundary lines

ordering

optionally specify an ordering scheme from which to plot HEALPix pixel numbers. Can be either "ring" or "nested"

incl.labels

If ordering is specified then this parameter sets the pixel indices that will be displayed (default is all indices at nside)

nums.col

specifies the colour of pixel numbers if ordering is specified

nums.size

specifies the size of pixel numbers if ordering is specified

font

A numeric font number from 1 to 5, used if ordering is specified

depth_test

The depth test to be applied. This controls how resistant the plotted object is to being obscured. See rgl.material

...

arguments passed to rgl::plot3d

Value

Produces a plot of the HEALPix pixel boundaries.

Examples

1
2
displayPixelBoundaries(1, eps = pi/90, col = "red")
displayPixelBoundaries(2, eps = pi/90, col = "green")

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