v2.0.0
Loading...
Searching...
No Matches
UTILSLIB::SelectionIO Class Reference

Reader/writer for MNE .sel channel-selection files and Brainstorm .mon montage files. More...

#include <selectionio.h>

Public Member Functions

 SelectionIO ()

Static Public Member Functions

static bool readMNESelFile (QString path, QMultiMap< QString, QStringList > &selectionMap)
static bool readMNESelFile (const std::string &path, std::multimap< std::string, std::vector< std::string > > &selectionMap)
static bool readBrainstormMonFile (QString path, QMultiMap< QString, QStringList > &selectionMap)
static bool readBrainstormMonFile (const std::string &path, std::multimap< std::string, std::vector< std::string > > &selectionMap)
static bool writeMNESelFile (QString path, const QMultiMap< QString, QStringList > &selectionMap)
static bool writeMNESelFile (const std::string &path, const std::map< std::string, std::vector< std::string > > &selectionMap)
static bool writeBrainstormMonFiles (QString path, const QMultiMap< QString, QStringList > &selectionMap)
static bool writeBrainstormMonFiles (const std::string &path, const std::map< std::string, std::vector< std::string > > &selectionMap)

Detailed Description

Reader/writer for MNE .sel channel-selection files and Brainstorm .mon montage files.

Processes selection files (mne .sel) files which contain the channels for each selection group.

Definition at line 72 of file selectionio.h.

Constructor & Destructor Documentation

◆ SelectionIO()

SelectionIO::SelectionIO ( )

Constructs a Filter object.

Definition at line 54 of file selectionio.cpp.

Member Function Documentation

◆ readBrainstormMonFile() [1/2]

bool SelectionIO::readBrainstormMonFile ( const std::string & path,
std::multimap< std::string, std::vector< std::string > > & selectionMap )
static

Reads the specified Brainstorm montage file.

Parameters
[in]pathholds the file path of the .mon file which is to be read.
[in]selectionMapholds the map to which the read selection groups are stored.
Returns
True on success, false if the path lacks a .mon extension or the file cannot be opened.

Definition at line 192 of file selectionio.cpp.

◆ readBrainstormMonFile() [2/2]

bool SelectionIO::readBrainstormMonFile ( QString path,
QMultiMap< QString, QStringList > & selectionMap )
static

Reads the specified Brainstorm montage file.

Parameters
[in]pathholds the file path of the .mon file which is to be read.
[in]selectionMapholds the map to which the read selection groups are stored.
Returns
True on success, false if the path lacks a .mon extension or the file cannot be opened.

Definition at line 152 of file selectionio.cpp.

◆ readMNESelFile() [1/2]

bool SelectionIO::readMNESelFile ( const std::string & path,
std::multimap< std::string, std::vector< std::string > > & selectionMap )
static

Reads the specified MNE sel file.

Parameters
[in]pathholds the file path of the .sel file which is to be read.
[in]selectionMapholds the map to which the read selection groups are stored.
Returns
True on success, false if the path lacks a .sel extension or the file cannot be opened.

Definition at line 106 of file selectionio.cpp.

◆ readMNESelFile() [2/2]

bool SelectionIO::readMNESelFile ( QString path,
QMultiMap< QString, QStringList > & selectionMap )
static

Reads the specified MNE sel file.

Parameters
[in]pathholds the file path of the .sel file which is to be read.
[in]selectionMapholds the map to which the read selection groups are stored.
Returns
True on success, false if the path lacks a .sel extension or the file cannot be opened.

Definition at line 60 of file selectionio.cpp.

◆ writeBrainstormMonFiles() [1/2]

bool SelectionIO::writeBrainstormMonFiles ( const std::string & path,
const std::map< std::string, std::vector< std::string > > & selectionMap )
static

Writes the specified selection groups to different Brainstorm .mon files. The amount of written files depend on the number of selection groups in selectionMap

Parameters
[in]pathholds the file path of the .mon file which is to be read.
[in]selectionMapholds the map to which the read selection groups are stored.
Returns
True if all .mon files were written, false if any file could not be opened for writing.

Definition at line 319 of file selectionio.cpp.

◆ writeBrainstormMonFiles() [2/2]

bool SelectionIO::writeBrainstormMonFiles ( QString path,
const QMultiMap< QString, QStringList > & selectionMap )
static

Writes the specified selection groups to different Brainstorm .mon files. The amount of written files depend on the number of selection groups in selectionMap

Parameters
[in]pathholds the file path of the .mon file which is to be read.
[in]selectionMapholds the map to which the read selection groups are stored.
Returns
True if all .mon files were written, false if any file could not be opened for writing.

Definition at line 288 of file selectionio.cpp.

◆ writeMNESelFile() [1/2]

bool SelectionIO::writeMNESelFile ( const std::string & path,
const std::map< std::string, std::vector< std::string > > & selectionMap )
static

Writes the specified selection groups to a single MNE .sel file.

Parameters
[in]pathholds the file path of the .sel file which is to be read.
[in]selectionMapholds the map to which the read selection groups are stored.
Returns
True on success, false if the path lacks a .sel extension or the file cannot be opened for writing.

Definition at line 262 of file selectionio.cpp.

◆ writeMNESelFile() [2/2]

bool SelectionIO::writeMNESelFile ( QString path,
const QMultiMap< QString, QStringList > & selectionMap )
static

Writes the specified selection groups to a single MNE .sel file.

Parameters
[in]pathholds the file path of the .sel file which is to be read.
[in]selectionMapholds the map to which the read selection groups are stored.
Returns
True on success, false if the path lacks a .sel extension or the file cannot be opened for writing.

Definition at line 227 of file selectionio.cpp.


The documentation for this class was generated from the following files: