Skip to contents

echelled

Source: R/echelled.R
echelled.Rd

echelled computes echelle diagram from observed oscillation spectrum

Usage

echelled(
  df_ospec = NULL,
  per = NULL,
  collapse = F,
  collvar = NULL,
  norm = NULL
)

Arguments

df_ospec

Dataframe. It must contain at least a column (after the name of sig) that contains the oscillation frequencies

per

Numeric. The value of the periodic pattern with which the frequencies will be sliced.

collapse

Logic. If true, then echelled returns the collapsed diagram using the selected collapsed variable (collvar, default amplitude)

collvar

char. Used only when collapse option is true. Three choices for collapse variable: "a" (default) sums over amplitudes; "sa" sums over frequency x amplitude, and "sa2" sums over (frequency x amplitude)^2.

Value

Dataframe. The input data frame with an additional column with the frequencies scaled by per: sig: (double float) oscillation frequency (frequency units) ech: (double float) sig modulo per (frequency units)

Details

This function takes two arguments, a dataframe containing observed frequencies and the periodicity with which the frequencies are to be scaled as frequency (modulo) periodicity

It also includes the option for collapse diagramme over the amplitudes, the amplitudes weighted by the frequencies (freq x amp), and (freq x amp)^2 that is, the energy of the mode.

See also

read_adipls, read_losc, read_graco, and read_gyre