API Documentation¶

Phase amplitude coupling (PAC)¶

`Comodulogram`	An object to compute the comodulogram for phase-amplitude coupling.
`DelayEstimator`	Estimate the optimal delay between the two components in PAC
`PeakLocking`	An object to compute time average and time-frequency averaged with peak-locking, to analyze phase-amplitude coupling.
`MaskIterator`	Iterator that creates the masks one at a time.
`raw_to_mask`	A function to transform MNE data into pactools input signals.
`simulate_pac`	Simulate a 1D signal with artificial phase amplitude coupling (PAC).

`DARSklearn`	Different interface to DAR models, to use in scikit-learn’s GridSearchCV
`ExtractDriver`	Returns bandpass filtered and a highpass filtered signals
`AddDriverDelay`	Transformer which adds a time delay in the driver of a DAR model
`MultipleArray`	Store a list of arrays into a single object and handle indexing for them

`DAR`	A driven auto-regressive (DAR) model, as described in [1].
`StableDAR`	A stable driven auto-regressive (DAR) model, as described in [1].
`extract_driver`	Extract the driver with filtering and fill the rest of the signal.

`fir.BandPassFilter`	Band-pass FIR filter
`fir.LowPassFilter`	Low-pass FIR filter
`spectrum.Spectrum`	Spectral estimator following Welch’s method
`spectrum.Coherence`	Coherence estimator
`spectrum.Bicoherence`	Bicoherence estimator
`peak_finder.peak_finder`	Noise tolerant fast peak finding algorithm