Skip to contents

Return the complex overlap between the two TimeSeries or FrequencySeries.

Usage

overlap_cplx(
  vec1,
  vec2,
  psd = NULL,
  low_frequency_cutoff = NULL,
  high_frequency_cutoff = NULL,
  normalized = TRUE
)

Arguments

vec1

A `ts` or `fs`. The input vector containing a waveform.

vec2

A `ts` or `fs`. The input vector containing a waveform.

psd

A `fs` object (default: `NULL`). A power spectral density to weight the overlap.

low_frequency_cutoff

A numeric (default: `NULL`). The frequency to begin the overlap.

high_frequency_cutoff

A numeric (default: `NULL`). The frequency to stop the overlap.

normalized

A logical (default: `TRUE`). Set if the overlap is normalized. If true, it will range from 0 to 1.

Value

overlap: complex