summary.fft: Summarize FFT objects

Description Usage Arguments Details Value Examples

View source: R/summaryFFT.R

Description

The function summarizes properties from the class(fft) object.

Usage

1
2
## S3 method for class 'fft'
summary(object, p0 = 0.01, ...)

Arguments

object

lomb object

p0

False Alarm Probability (FAP) threshold, default 1%

...

not used

Details

The false alarm probability threshold p0 value can be changed to modify the amount of significant peaks.

Value

a list of significant values of the spectral analysis

Examples

1
# see spec.fft() example

spectral documentation built on March 29, 2021, 5:10 p.m.