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.datatype.base_data.StructDict(*args, …)

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 trigonometric 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])

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.unwrap_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(trl_dat[, …])

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

syncopy.specest.mtmfft.MultiTaperFFT(*argv, …)

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

syncopy.specest.mtmconvol.mtmconvol(trl_dat, …)

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

syncopy.specest.mtmconvol.MultiTaperFFTConvol(…)

Compute class that performs time-frequency analysis of AnalogData objects

syncopy.specest.mtmconvol._make_trialdef(…)

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

syncopy.specest.wavelet.wavelet(trl_dat, …)

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

syncopy.specest.wavelet.WaveletTransform(…)

Compute class that performs time-frequency analysis of AnalogData objects

syncopy.specest.wavelet._get_optimal_wavelet_scales(…)

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

syncopy.plotting

syncopy.plotting.spy_plotting._layout_subplot_panels(npanels)

Create space-optimal subplot grid given required number of panels

syncopy.plotting.spy_plotting._prep_plots(…)

Helper performing most basal error checking for all plotting sub-routines

syncopy.plotting.spy_plotting._prep_toilim_avg(self)

Set up averaging data across trials given toilim selection

syncopy.plotting.spy_plotting._setup_figure(npanels)

Create and set up a Figure object for Syncopy visualizations

syncopy.plotting.spy_plotting._setup_colorbar(…)

Create and format a Colorbar object for Syncopy visualizations

syncopy.plotting._plot_spectral._compute_pltArr(…)

Local helper that extracts/averages data from SpectralData object

syncopy.plotting._plot_spectral._prep_spectral_plots(…)

Local helper that performs sanity checks and sets up data selection

syncopy.plotting._plot_analog._prep_analog_plots(…)

Local helper that performs sanity checks and sets up data selection