syncopy.specest.compRoutines.superlet_cF

syncopy.specest.compRoutines.superlet_cF(trl_dat, preselect, postselect, toi=None, timeAxis=0, polyremoval=0, output_fmt='pow', noCompute=False, chunkShape=None, method_kwargs=None)[source]

This is the middleware for the superlet() spectral estimation method.

Parameters
  • trl_dat (2D numpy.ndarray) – Uniformly sampled multi-channel time-series

  • preselect (slice) – Begin- to end-samples to perform analysis on (trim data to interval). See Notes for details.

  • postselect (list of slices or list of 1D NumPy arrays) – Actual time-points of interest within interval defined by preselect See Notes for details.

  • toi (1D numpy.ndarray or str) – Either array of equidistant time-points or “all” to perform analysis on all samples in trl_dat. Please refer to freqanalysis() for further details.

  • timeAxis (int) – Index of running time axis in trl_dat (0 or 1)

  • polyremoval (int or None) – Order of polynomial used for de-trending data in the time domain prior to spectral analysis. A value of 0 corresponds to subtracting the mean (“de-meaning”), polyremoval = 1 removes linear trends (subtracting the least squares fit of a linear polynomial). If polyremoval is None, no de-trending is performed.

  • output_fmt (str) – Output of spectral estimation; one of availableOutputs

  • noCompute (bool) – Preprocessing flag. If True, do not perform actual calculation but instead return expected shape and numpy.dtype of output array.

  • chunkShape (None or tuple) – If not None, represents shape of output object gmean_spec (respecting provided values of scales, preselect, postselect etc.)

  • method_kwargs (dict) – Keyword arguments passed to :func:`~syncopy.specest.superlet.superlet controlling the spectral estimation method

Returns

gmean_spec – Complex time-frequency representation of the input data. Shape is (nTime, 1, nScales, nChannels).

Return type

numpy.ndarray

Notes

This method is intended to be used as computeFunction() inside a ComputationalRoutine. Thus, input parameters are presumed to be forwarded from a parent metafunction. Consequently, this function does not perform any error checking and operates under the assumption that all inputs have been externally validated and cross-checked.

See also

syncopy.freqanalysis

parent metafunction

SuperletTransform

ComputationalRoutine instance that calls this method as computeFunction()