osl_dynamics.config_api.wrappers.multitaper_spectra#

osl_dynamics.config_api.wrappers.multitaper_spectra(data, output_dir, kwargs, nnmf_components=None)#

Calculate multitaper spectra.

This function expects a model has already been trained and the following directories exist:

  • <output_dir>/model, which contains the trained model.

  • <output_dir>/inf_params, which contains the inferred parameters.

This function will create the following directory:

  • <output_dir>/spectra, which contains the post-hoc spectra.

Parameters:
dataosl_dynamics.data.Data

Data object.

output_dirstr

Path to output directory.

kwargsdict

Keyword arguments to pass to osl_dynamics.analysis.spectral.multitaper_spectra(). Defaults to:

{'sampling_frequency': data.sampling_frequency,
 'keepdims': True}
nnmf_componentsint, optional

Number of non-negative matrix factorization (NNMF) components to fit to the stacked session-specific coherence spectra.