echoIBM.distToPeak: Calculates the distance to the nearest peak of the periodic...

View source: R/echoIBM.distToPeak.R

echoIBM.distToPeakR Documentation

Calculates the distance to the nearest peak of the periodic noise for time step 'indt'.

Description

Calculates the distance to the nearest peak of the periodic noise for time step 'indt'.

Usage

echoIBM.distToPeak(data, indt = NULL)

Arguments

data

is a list containing beam configuration, and periodic noise parameters. Speficically the following variables must be included: Beams variables: 'sint', 'lenb'; periodic noise variables: 'pns1', 'pns2', 'pns3', 'acfq', 'harm'; and either 'bgns' or 'numb'

indt

is the time step index.


arnejohannesholmin/echoIBM documentation built on April 14, 2024, 11:37 p.m.