Skip to main content

MNESssData

Namespace: MNELIB  ·  Library: MNE Library

#include <mne/mne_sss_data.h>

class MNELIB::MNESssData

Implements MNE SSS Data (Replaces *mneSssData,mneSssDataRec struct of MNE-C mne_types.h).

Container for Signal Space Separation (SSS/Maxwell filtering) expansion coefficients and metadata.

src/examples/ex_mne_api/main.cpp
auto sss = MNESssData::read(sssPath); // the SSS block written by mne.preprocessing.maxwell_filter

Public Methods​

MNESssData()​

Constructs the MNE SSS Data.

MNESssData(p_MneSssData)​

Copy constructor.

Refactored: mne_dup_sss_data (mne_sss_data.c)

Parameters:

  • p_MneSssData : const MNESssData & MNE SSS Data which should be copied.

~MNESssData()​

Destroys the MNE SSS Data description.

print(out)​

Output the SSS information for debugging purposes.

Refactored: mne_print_sss_data (mne_sss_data.c)

Parameters:

  • out : QTextStream & The text stream to write the SSS diagnostics to (e.g. a QTextStream wrapping stderr).

Static Methods​

read(name)​

Read SSS data from anywhere in a file Refactored: mne_read (mne_sss_data.c).

Parameters:

  • name : const QString & Name of the file to read the SSS data from.

Returns:

  • std::unique_ptr< MNESssData > — The read SSS data.

read_from_node(stream, start)​

Read the SSS data from the given node of an open fiff stream Refactored: mne_read_from_node (mne_sss_data.c).

Parameters:

  • stream : QSharedPointer<FiffStream> & The open fiff stream.

  • start : const QSharedPointer<FiffDirNode> & The node/tree to read the SSS data from.

Returns:

  • std::unique_ptr< MNESssData > — The read SSS data.

Example​

Used in examples​

ex_mne_api​

MNE library: BEM surfaces, surface projection, ICP, source spaces and epochs.

src/examples/ex_mne_api/main.cpp, line 438
auto sss = MNESssData::read(sssPath); // the SSS block written by mne.preprocessing.maxwell_filter
// maxwell_filter(origin=(0, 0, 0.04), int_order=8, ext_order=3): head frame, 306 channels, 70 of 80 internal and 15 external components
ok &= expect(sss && sss->job == FIFFV_SSS_JOB_FILTER && sss->coord_frame == FIFFV_COORD_HEAD && sss->nchan == 306 && sss->in_order == 8 && sss->out_order == 3 && sss->in_nuse == 70 && sss->out_nuse == 15 && std::fabs(sss->origin[2] - 0.04f) < 1e-7f,
             "MNESssData: Maxwell filter parameters like info['proc_history'] of the fixture");

Authors of this file​