API

Release:

0.12

Date:

February 03, 2026, 08:40 PDT

• algorithms.autoregressive
  • Module: algorithms.autoregressive
  • Functions
    • AR_est_LD()
    • AR_est_YW()
    • AR_psd()
    • MAR_est_LWR()
    • coherence_from_spectral()
    • granger_causality_xy()
    • interdependence_xy()
    • lwr_recursion()
    • spectral_matrix_xy()
    • transfer_function_xy()
• algorithms.cohere
  • Module: algorithms.cohere
  • Functions
    • cache_fft()
    • cache_to_coherency()
    • cache_to_phase()
    • cache_to_psd()
    • cache_to_relative_phase()
    • coherence()
    • coherence_bavg()
    • coherence_partial()
    • coherence_partial_spec()
    • coherence_regularized()
    • coherence_spec()
    • coherency()
    • coherency_bavg()
    • coherency_phase_delay()
    • coherency_phase_spectrum()
    • coherency_regularized()
    • coherency_spec()
    • correlation_spectrum()
• algorithms.correlation
  • Module: algorithms.correlation
    • seed_corrcoef()
• algorithms.entropy
  • Module: algorithms.entropy
  • Functions
    • conditional_entropy()
    • entropy()
    • entropy_cc()
    • mutual_information()
    • transfer_entropy()
• algorithms.event_related
  • Module: algorithms.event_related
  • Functions
    • fir()
    • freq_domain_xcorr()
    • freq_domain_xcorr_zscored()
• algorithms.filter
  • Module: algorithms.filter
    • boxcar_filter()
• algorithms.spectral
  • Module: algorithms.spectral
  • Functions
    • freq_response()
    • get_spectra()
    • get_spectra_bi()
    • mtm_cross_spectrum()
    • multi_taper_csd()
    • multi_taper_psd()
    • periodogram()
    • periodogram_csd()
• algorithms.wavelet
  • Module: algorithms.wavelet
  • Functions
    • wfmorlet_fft()
    • wlogmorlet()
    • wlogmorlet_fft()
    • wmorlet()
• analysis.base
  • Module: analysis.base
  • BaseAnalyzer
    • BaseAnalyzer
      • BaseAnalyzer.__init__()
      • BaseAnalyzer.parameterlist()
      • BaseAnalyzer.parameters
      • BaseAnalyzer.set_input()
• analysis.coherence
  • Module: analysis.coherence
  • Classes
    • CoherenceAnalyzer
      • CoherenceAnalyzer
        • CoherenceAnalyzer.__init__()
        • CoherenceAnalyzer.coherence()
        • CoherenceAnalyzer.coherence_partial()
        • CoherenceAnalyzer.coherency()
        • CoherenceAnalyzer.delay()
        • CoherenceAnalyzer.frequencies()
        • CoherenceAnalyzer.phase()
        • CoherenceAnalyzer.spectrum()
    • MTCoherenceAnalyzer
      • MTCoherenceAnalyzer
        • MTCoherenceAnalyzer.__init__()
        • MTCoherenceAnalyzer.coherence()
        • MTCoherenceAnalyzer.confidence_interval()
        • MTCoherenceAnalyzer.df()
        • MTCoherenceAnalyzer.eigs()
        • MTCoherenceAnalyzer.frequencies()
        • MTCoherenceAnalyzer.spectra()
        • MTCoherenceAnalyzer.tapers()
        • MTCoherenceAnalyzer.weights()
    • SeedCoherenceAnalyzer
      • SeedCoherenceAnalyzer
        • SeedCoherenceAnalyzer.__init__()
        • SeedCoherenceAnalyzer.coherence()
        • SeedCoherenceAnalyzer.coherency()
        • SeedCoherenceAnalyzer.delay()
        • SeedCoherenceAnalyzer.frequencies()
        • SeedCoherenceAnalyzer.relative_phases()
        • SeedCoherenceAnalyzer.target_cache()
    • SparseCoherenceAnalyzer
      • SparseCoherenceAnalyzer
        • SparseCoherenceAnalyzer.__init__()
        • SparseCoherenceAnalyzer.cache()
        • SparseCoherenceAnalyzer.coherence()
        • SparseCoherenceAnalyzer.coherency()
        • SparseCoherenceAnalyzer.delay()
        • SparseCoherenceAnalyzer.frequencies()
        • SparseCoherenceAnalyzer.phases()
        • SparseCoherenceAnalyzer.relative_phases()
        • SparseCoherenceAnalyzer.spectrum()
• analysis.correlation
  • Module: analysis.correlation
  • Classes
    • CorrelationAnalyzer
      • CorrelationAnalyzer
        • CorrelationAnalyzer.__init__()
        • CorrelationAnalyzer.corrcoef()
        • CorrelationAnalyzer.xcorr()
        • CorrelationAnalyzer.xcorr_norm()
    • SeedCorrelationAnalyzer
      • SeedCorrelationAnalyzer
        • SeedCorrelationAnalyzer.__init__()
        • SeedCorrelationAnalyzer.corrcoef()
• analysis.event_related
  • Module: analysis.event_related
  • EventRelatedAnalyzer
    • EventRelatedAnalyzer
      • EventRelatedAnalyzer.__init__()
      • EventRelatedAnalyzer.FIR()
      • EventRelatedAnalyzer.FIR_estimate()
      • EventRelatedAnalyzer.et_data()
      • EventRelatedAnalyzer.eta()
      • EventRelatedAnalyzer.ets()
      • EventRelatedAnalyzer.xcorr_eta()
• analysis.granger
  • Module: analysis.granger
  • GrangerAnalyzer
    • GrangerAnalyzer
      • GrangerAnalyzer.__init__()
      • GrangerAnalyzer.autocov()
      • GrangerAnalyzer.causality_xy()
      • GrangerAnalyzer.causality_yx()
      • GrangerAnalyzer.error_cov()
      • GrangerAnalyzer.frequencies()
      • GrangerAnalyzer.model_coef()
      • GrangerAnalyzer.order()
      • GrangerAnalyzer.simultaneous_causality()
      • GrangerAnalyzer.spectral_matrix()
    • fit_model()
• analysis.normalization
  • Module: analysis.normalization
  • NormalizationAnalyzer
    • NormalizationAnalyzer
      • NormalizationAnalyzer.__init__()
      • NormalizationAnalyzer.percent_change()
      • NormalizationAnalyzer.z_score()
• analysis.snr
  • Module: analysis.snr
  • SNRAnalyzer
    • SNRAnalyzer
      • SNRAnalyzer.__init__()
      • SNRAnalyzer.correlation()
      • SNRAnalyzer.mt_coherence()
      • SNRAnalyzer.mt_frequencies()
      • SNRAnalyzer.mt_information()
      • SNRAnalyzer.mt_noise_psd()
      • SNRAnalyzer.mt_signal_psd()
      • SNRAnalyzer.mt_snr()
    • signal_noise()
• analysis.spectral
  • Module: analysis.spectral
  • Classes
    • FilterAnalyzer
      • FilterAnalyzer
        • FilterAnalyzer.__init__()
        • FilterAnalyzer.filtered_boxcar()
        • FilterAnalyzer.filtered_fourier()
        • FilterAnalyzer.filtfilt()
        • FilterAnalyzer.fir()
        • FilterAnalyzer.iir()
    • HilbertAnalyzer
      • HilbertAnalyzer
        • HilbertAnalyzer.__init__()
        • HilbertAnalyzer.amplitude()
        • HilbertAnalyzer.analytic()
        • HilbertAnalyzer.imag()
        • HilbertAnalyzer.phase()
        • HilbertAnalyzer.real()
    • MorletWaveletAnalyzer
      • MorletWaveletAnalyzer
        • MorletWaveletAnalyzer.__init__()
        • MorletWaveletAnalyzer.amplitude()
        • MorletWaveletAnalyzer.analytic()
        • MorletWaveletAnalyzer.imag()
        • MorletWaveletAnalyzer.phase()
        • MorletWaveletAnalyzer.real()
    • SpectralAnalyzer
      • SpectralAnalyzer
        • SpectralAnalyzer.__init__()
        • SpectralAnalyzer.cpsd()
        • SpectralAnalyzer.periodogram()
        • SpectralAnalyzer.psd()
        • SpectralAnalyzer.spectrum_fourier()
        • SpectralAnalyzer.spectrum_multi_taper()
• conftest
  • Module: conftest
    • legacy_printoptions()
• descriptors
  • Module: descriptors
    • References
  • Classes
    • OneTimeProperty
      • OneTimeProperty
        • OneTimeProperty.__init__()
    • ResetMixin
      • ResetMixin
        • ResetMixin.__init__()
        • ResetMixin.reset()
  • Function
    • auto_attr()
• fmri.hrf
  • Module: fmri.hrf
  • Functions
    • gamma_hrf()
    • polonsky_hrf()
• fmri.io
  • Module: fmri.io
  • Functions
    • nifti_from_time_series()
    • time_series_from_file()
• index_utils
  • Module: index_utils
  • Functions
    • histogram2d()
    • mask_indices()
    • tri()
    • tril()
    • tril_indices()
    • tril_indices_from()
    • triu()
    • triu_indices()
    • triu_indices_from()
    • vander()
• lazy
  • Module: lazy
    • enabled()
• lazyimports
  • Module: lazyimports
  • LazyImport
    • LazyImport
      • LazyImport.__init__()
• timeseries
  • Module: timeseries
  • Classes
    • Epochs
      • Epochs
        • Epochs.__init__()
        • Epochs.duration()
        • Epochs.start
        • Epochs.stop
    • Events
      • Events
        • Events.__init__()
    • Frequency
      • Frequency
        • Frequency.__init__()
        • Frequency.to_period()
    • TimeArray
      • TimeArray
        • TimeArray.__init__()
        • TimeArray.at()
        • TimeArray.convert_unit()
        • TimeArray.during()
        • TimeArray.index_at()
        • TimeArray.max()
        • TimeArray.mean()
        • TimeArray.min()
        • TimeArray.prod()
        • TimeArray.ptp()
        • TimeArray.slice_during()
        • TimeArray.std()
        • TimeArray.sum()
        • TimeArray.var()
    • TimeInterface
      • TimeInterface
        • TimeInterface.__init__()
        • TimeInterface.time_unit
    • TimeSeries
      • TimeSeries
        • TimeSeries.__init__()
        • TimeSeries.at()
        • TimeSeries.copy()
        • TimeSeries.during()
        • TimeSeries.from_time_and_data()
        • TimeSeries.shape
        • TimeSeries.time()
    • TimeSeriesBase
      • TimeSeriesBase
        • TimeSeriesBase.__init__()
        • TimeSeriesBase.data
    • TimeSeriesInterface
      • TimeSeriesInterface
        • TimeSeriesInterface.__init__()
        • TimeSeriesInterface.data
        • TimeSeriesInterface.metadata
        • TimeSeriesInterface.time
    • UniformTime
      • UniformTime
        • UniformTime.__init__()
        • UniformTime.at()
        • UniformTime.during()
        • UniformTime.index_at()
        • UniformTime.max()
        • UniformTime.min()
        • UniformTime.slice_during()
  • Functions
    • concatenate_time_series()
    • get_time_unit()
    • str_tspec()
    • str_valid_tspecs()
• utils
  • Module: utils
  • Functions
    • adaptive_weights()
    • akaike_information_criterion()
    • antisymm_rand_arr()
    • ar_generator()
    • autocorr()
    • autocov()
    • autocov_vector()
    • bayesian_information_criterion()
    • circle_to_hz()
    • circularize()
    • crosscorr()
    • crosscov()
    • crosscov_vector()
    • dB()
    • detect_lines()
    • diag_indices()
    • diag_indices_from()
    • dpss_windows()
    • expected_jk_variance()
    • fftconvolve()
    • fill_diagonal()
    • fir_design_matrix()
    • generate_mar()
    • get_bounds()
    • get_freqs()
    • hanning_window_spectrum()
    • intersect_coords()
    • jackknifed_coh_variance()
    • jackknifed_sdf_variance()
    • mask_indices()
    • minmax_norm()
    • multi_intersect()
    • normal_coherence_to_unit()
    • normalize_coherence()
    • percent_change()
    • remove_bias()
    • rescale_arr()
    • square_window_spectrum()
    • structured_rand_arr()
    • symm_rand_arr()
    • tapered_spectra()
    • threshold_arr()
    • thresholded_arr()
    • tridi_inverse_iteration()
    • tril_indices()
    • tril_indices_from()
    • triu_indices()
    • triu_indices_from()
    • unwrap_phases()
    • zero_pad()
    • zscore()
• viz
  • Module: viz
  • Functions
    • draw_arrows()
    • draw_graph()
    • draw_matrix()
    • draw_networkx_nodes()
    • drawgraph_channels()
    • drawmatrix_channels()
    • lab2node()
    • matshow_tseries()
    • mkgraph()
    • plot_corr_diff()
    • plot_snr()
    • plot_snr_diff()
    • plot_spectral_estimate()
    • plot_tseries()
    • plot_xcorr()
    • rgb_to_dict()
    • subcolormap()
    • winspect()