msqms.qc.freq_domain_metrics module

msqms.qc.freq_domain_metrics module#

Frequency Domain Metric for MEG Data.

Summary#

Classes:#

FreqDomainMetric

Class to calculate frequency domain metrics for MEG data.

Reference#

class msqms.qc.freq_domain_metrics.FreqDomainMetric(raw, data_type, origin_raw, n_jobs=1, verbose=False)[source]#

Bases: Metrics

Class to calculate frequency domain metrics for MEG data.

This class processes MEG data and computes frequency domain features for all MEG channels, with support for both sequential and parallel computation.

Parameters:

  • raw (mne.io.Raw) – The raw MEG data.

  • data_type (str) – The type of MEG data (e.g., ‘opm’ or ‘squid’).

  • origin_raw (mne.io.Raw) – The original raw MEG data for comparison.

  • n_jobs (int, optional) – Number of parallel jobs to use for computation. Default is 1 (no parallelization).

  • verbose (bool, optional) – If True, enables verbose output. Default is False.

compute_metrics(meg_type)[source]#

Compute frequency domain metrics for MEG data.

Return type:

DataFrame

Parameters:

meg_type (MEG_TYPE) – Type of MEG channels to process (e.g., ‘mag’, ‘grad’).

Returns:

freq_feat_df – DataFrame containing frequency domain metrics for all channels, including their average and standard deviation.

Return type:

pd.DataFrame