plot.HPDataFrame: Plot HPDataFrame

Description Usage Arguments Value Examples

Description

This function produces a plot from a HPDataFrame. If columns x,y,z (cartesian) or theta,phi (colatitude and longitude respectively) are present in x, then these will be used as coordinates for plotting. Otherwise, the HEALPix indices as in pix(x) will be used. If HEALPix indices are used and multiple rows correspond to a single pixel index, then beware that values may be obfuscated in the plot, and all locations are pixel centers.

Usage

1
2
3
4
5
6
## S3 method for class 'HPDataFrame'
plot(x, intensities = "I", add = FALSE,
  sample.size, type = "p", size = 1, box = FALSE, axes = FALSE,
  aspect = FALSE, col = "blue", back.col = "black", labels,
  hp.boundaries = 0, hpb.col = "gray", depth_test = "less",
  lab_depth_test = "always", ...)

Arguments

x

A HPDataFrame.

intensities

The column name for the data in x that is to be treated as intensities for plotting.

add

if TRUE then this plot will be added to any existing plot. Note that if back.col (see below) is specified then a new plot window will be opened and add = TRUE will have no effect

sample.size

optionally specifies the size of a simple random sample to take before plotting. This can make the plot less computationally intensive

type

a single character indicating the type of item to plot. Supported types are: 'p' for points, 's' for spheres, 'l' for lines, 'h' for line segments from z = 0, and 'n' for nothing.

size

the size of plotted points

box

whether to draw a box

axes

whether to draw axes

aspect

either a logical indicating whether to adjust the aspect ratio, or a new ratio.

col

specify the colour(s) of the plotted points

back.col

optionally specifies the background colour of the plot. This argument is passed to rgl::bg3d.

labels

optionally specify a vector of labels to plot, such as words or vertex indices. If this is specified then rgl::text3d is used instead of rgl::plot3d. Then length(labels) must equal nrow(x)

hp.boundaries

integer. If greater than 0 then HEALPix pixel boundaries at nside = hp.boundaries will be added to the plot

hpb.col

colour for the hp.boundaries

depth_test

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

lab_depth_test

The rgl depth test to be applied to the labels and pixel boundaries if present. See rgl.material

...

arguments passed to rgl::plot3d

Value

A plot of the data locations according to coordinate columns or HEALPix index

Examples

1
2
3
hpdf <- HPDataFrame(I = rep(0,12), nside = 1)
plot(hpdf, size = 5, col = "yellow", back.col = "black",
     hp.boundaries = 1)

frycast/rcosmo documentation built on June 4, 2019, 5:13 p.m.