API for Developers#

syncopy.datatype#

syncopy.datatype.base_data.BaseData([...])

Abstract base class for all data classes

syncopy.datatype.base_data.Selector(data, select)

Auxiliary class for data selection

syncopy.datatype.base_data.FauxTrial(shape, ...)

Stand-in mockup of NumPy arrays representing trial data

syncopy.shared.StructDict(*args, **kwargs)

Child-class of dict for emulating MATLAB structs

syncopy.datatype.continuous_data.ContinuousData([...])

Abstract class for uniformly sampled data

syncopy.datatype.discrete_data.DiscreteData([...])

Abstract class for non-uniformly sampled data where only time-stamps are recorded.

syncopy.misc#

syncopy.tests.misc.generate_artificial_data([...])

Create AnalogData object with synthetic harmonic signal(s)

syncopy.shared#

syncopy.shared.computational_routine.ComputationalRoutine(...)

Abstract class for encapsulating sequential/parallel algorithms

syncopy.shared.errors.SPYError

Base class for SynCoPy errors

syncopy.shared.errors.SPYTypeError(var[, ...])

SynCoPy-specific version of a TypeError

syncopy.shared.errors.SPYValueError(legal[, ...])

SynCoPy-specific version of a ValueError

syncopy.shared.errors.SPYIOError(fs_loc[, ...])

SynCoPy-specific version of an IO/OSError

syncopy.shared.errors.SPYWarning(msg[, caller])

Log a standardized Syncopy warning message.

syncopy.shared.kwarg_decorators.unwrap_cfg(func)

Decorator that unwraps cfg "structure" in metafunction call

syncopy.shared.kwarg_decorators.unwrap_select(func)

Decorator for handling in-place data selections via select keyword

syncopy.shared.kwarg_decorators.process_io(func)

Decorator for handling parallel execution of a computeFunction()

syncopy.shared.kwarg_decorators.detect_parallel_client(func)

Decorator for handling parallelization via parallel keyword/client detection

syncopy.shared.kwarg_decorators._append_docstring(...)

Local helper to automate text insertions in docstrings

syncopy.shared.kwarg_decorators._append_signature(...)

Local helper to automate keyword argument insertions in function signatures

syncopy.shared.tools.best_match(source, ...)

Find matching elements in a given 1d-array/list

syncopy.specest#

syncopy.specest.mtmfft.mtmfft(data_arr, ...)

(Multi-)tapered fast Fourier transform.

syncopy.specest.compRoutines.MultiTaperFFT(...)

Compute class that calculates (multi-)tapered Fourier transfrom of AnalogData objects

syncopy.specest.compRoutines.mtmfft_cF(trl_dat)

Compute (multi-)tapered Fourier transform of multi-channel time series data

syncopy.specest.mtmconvol.mtmconvol(...[, ...])

(Multi-)tapered short time fast Fourier transform.

syncopy.specest.compRoutines.MultiTaperFFTConvol(...)

Compute class that performs time-frequency analysis of AnalogData objects

syncopy.specest.compRoutines.mtmconvol_cF(...)

Perform time-frequency analysis on multi-channel time series data using a sliding window FFT

syncopy.specest.compRoutines._make_trialdef(...)

Local helper to construct trialdefinition arrays for time-frequency SpectralData objects

syncopy.specest.wavelet.wavelet(data_arr, ...)

Perform time-frequency analysis on multi-channel time series data using a wavelet transform

syncopy.specest.compRoutines.WaveletTransform(...)

Compute class that performs time-frequency analysis of AnalogData objects

syncopy.specest.compRoutines.wavelet_cF(...)

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

syncopy.specest.compRoutines.SuperletTransform(...)

Compute class that performs time-frequency analysis of AnalogData objects

syncopy.specest.compRoutines.superlet_cF(...)

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

syncopy.specest.compRoutines._make_trialdef(...)

Local helper to construct trialdefinition arrays for time-frequency SpectralData objects

syncopy.specest.superlet.superlet(data_arr, ...)

Performs Superlet Transform (SLT) according to Moca et al. [1]_ Both multiplicative SLT and fractional adaptive SLT are available.

syncopy.specest.wavelet.get_optimal_wavelet_scales(...)

Local helper to compute an "optimally spaced" set of scales for wavelet analysis

syncopy.specest.compRoutines.FooofSpy(*argv, ...)

Compute class that checks parameters and adds metadata to output spectral data.

syncopy.connectivity#

syncopy.connectivity.AV_compRoutines.GrangerCausality(...)

Compute class that computes pairwise Granger causalities of CrossSpectralData objects.

syncopy.plotting#

syncopy.plotting.spy_plotting.singlepanelplot(...)

Plot Syncopy data in a single panel

syncopy.plotting.spy_plotting.multipanelplot(...)

Plot Syncopy data in multiple panels