spectral (version 2.0)

summary.lomb: Summarize Lomb objects

Description

The function summarizes properties from the Lomb object.

Usage

# S3 method for lomb
summary(object, p0 = 0.01, ...)

Arguments

object

lomb object

p0

False Alarm Probability threshold, default 1%

...

not used

Value

a list of significant values of the spectral analysis

Details

The false alarm probability threshold p0 value will adjust the number of peaks.

The effectiveBandWidth describes the coverage of processed frequencies by the spec.lomb function. If the ratio to averageSampling is almost 2, then the Nyquist criterion can be assumed to be fullfilled. If the ratio is much less than 2 then only a fraction of information is analysed.

The minFreqStep is an estimate of the minimum frequency step determined from the Lomb-Object.

Average sampling is calculated from the median distance between two spatial points.

The possible frequency resolution originates also from the spatial (temporal) input data by 1/(diff(range(x))), if x is the spatial (temporal) coordinate.

Examples

# NOT RUN {
# see spec.lomb() example
# }