summary.HPDataFrame: Summarise a 'HPDataFrame'

View source: R/HPDataFrame.R

summary.HPDataFrameR Documentation

Summarise a HPDataFrame

Description

This function produces a summary from a HPDataFrame.

Usage

## S3 method for class 'HPDataFrame'
summary(object, intensities = "I", ...)

Arguments

object

A HPDataFrame.

intensities

the name of a column specifying intensities (or potentially another numeric quantity of interest)

...

Unused arguments.

Value

A summary includes window's type and area, total area covered by observations, and main statistics for intensity values

Examples

ns <- 2
hpdf <- HPDataFrame(I = rnorm(12*ns^2), nside = 2,
                    ordering = "nested")
win <- CMBWindow(theta = c(0,pi/2,pi/2), phi = c(0,0,pi/2))
hpdf.win <- window(hpdf, new.window = win)
summary(hpdf.win)


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