Analyze Coherency from View object

Analyze Coherency from View object

Usage

analyze_coherency(
  obj,
  columns,
  loess.span = 0,
  dj = 1/50,
  lowerPeriod = 2/obj$recording$fps,
  upperPeriod = 5,
  window.type.t = 1,
  window.type.s = 1,
  window.size.t = 5,
  window.size.s = 1/4,
  make.pval = TRUE,
  method = "white.noise",
  params = NULL,
  n.sim = 1,
  date.format = NULL,
  date.tz = NULL,
  verbose = FALSE
)

Arguments

obj

View object.

columns

Two column names.

loess.span

parameter alpha in loess controlling the degree of time series smoothing, if the time series is to be detrended; no detrending if loess.span = 0. Default: 0.

dj

frequency resolution. Default 1/20.

lowerPeriod

in seconds

upperPeriod

in seconds

window.type.t

see WaveletComp::analyze.coherency().

window.type.s

see WaveletComp::analyze.coherency().

window.size.t

see WaveletComp::analyze.coherency().

window.size.s

see WaveletComp::analyze.coherency().

make.pval

see WaveletComp::analyze.coherency().

method

see WaveletComp::analyze.coherency().

params

see WaveletComp::analyze.coherency().

n.sim

number of simulations (default 1).

date.format

see WaveletComp::analyze.coherency().

date.tz

see WaveletComp::analyze.coherency().

verbose

see WaveletComp::analyze.coherency().

Value

an analyze_coherency object.

See also

Other wavelet functions: analyze_wavelet(), get_local_max_average_power(), plot_average_coherency(), plot_average_power(), plot_cross_spectrum(), plot_cwt_energy(), plot_phase_difference(), plot_power_spectrum(), plot_roll_resultant_length(), plot_sel_phases(), plot_wt_energy()

Examples

r <- get_sample_recording()
rv <- get_raw_view(r, "Central", "", "Sitar")
pv <- get_processed_view(rv)
co <- analyze_coherency(pv, c("Nose_x", "Nose_y"))
#> 
  |                                                                            
  |                                                                      |   0%
  |                                                                            
  |======================================================================| 100%