Definition of one raw data buffer within a FIFF file. More...

#include <mne_raw_buf_def.h>

Public Types
typedef QSharedPointer< MNERawBufDef >	SPtr
typedef QSharedPointer< const MNERawBufDef >	ConstSPtr
using	RowMajorMatrixXf = Eigen::Matrix<float, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>

Public Member Functions
	MNERawBufDef ()
	Default constructor.
	~MNERawBufDef ()
	Destructor.

Static Public Member Functions
static void	free_bufs (MNERawBufDef *bufs, int nbuf)
	Free an array of raw data buffer definitions.

Public Attributes
FIFFLIB::FiffDirEntry::SPtr	ent
int	firsts
int	lasts
int	ntaper
int	ns
int	nchan
int	is_skip
RowMajorMatrixXf	vals
int	valid
Eigen::VectorXi	ch_filtered
int	comp_status

Detailed Description

Definition of one raw data buffer within a FIFF file.

Each MNERawBufDef describes a contiguous chunk of samples, either loaded from the FIFF file or produced by the overlap-add filter pipeline. Sample values are stored in a row-major matrix (nchan x ns) that is managed by an external ring buffer; an empty (0x0) matrix indicates that the data are not currently resident in memory.

Definition at line 82 of file mne_raw_buf_def.h.

Member Typedef Documentation

◆ ConstSPtr

typedef QSharedPointer<const MNERawBufDef> MNELIB::MNERawBufDef::ConstSPtr

Const shared pointer type for MNERawBufDef.

Definition at line 86 of file mne_raw_buf_def.h.

◆ RowMajorMatrixXf

using MNELIB::MNERawBufDef::RowMajorMatrixXf = Eigen::Matrix<float, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>

Row-major float matrix matching the legacy float** memory layout.

Definition at line 89 of file mne_raw_buf_def.h.

◆ SPtr

typedef QSharedPointer<MNERawBufDef> MNELIB::MNERawBufDef::SPtr

Shared pointer type for MNERawBufDef.

Definition at line 85 of file mne_raw_buf_def.h.

Constructor & Destructor Documentation

◆ MNERawBufDef()

MNERawBufDef::MNERawBufDef ( )

Default constructor.

Definition at line 59 of file mne_raw_buf_def.cpp.

◆ ~MNERawBufDef()

MNERawBufDef::~MNERawBufDef ( )

Destructor.

Definition at line 65 of file mne_raw_buf_def.cpp.

Member Function Documentation

◆ free_bufs()

void MNERawBufDef::free_bufs	(	MNERawBufDef *	bufs,
		int	nbuf )

static

Free an array of raw data buffer definitions.

The vals and ch_filtered members are Eigen types that clean up automatically. This function frees the C-allocated buffer array itself.

Parameters

[in]	bufs	Pointer to the array of MNERawBufDef structures to free.
[in]	nbuf	Number of buffer definitions in the array.

Definition at line 71 of file mne_raw_buf_def.cpp.

Member Data Documentation

◆ ch_filtered

Eigen::VectorXi MNELIB::MNERawBufDef::ch_filtered

Per-channel flag: has this channel been filtered already (filtered buffers only).

Definition at line 123 of file mne_raw_buf_def.h.

◆ comp_status

int MNELIB::MNERawBufDef::comp_status

Compensation status for raw buffers.

Definition at line 124 of file mne_raw_buf_def.h.

◆ ent

FIFFLIB::FiffDirEntry::SPtr MNELIB::MNERawBufDef::ent

Directory entry locating this buffer in the FIFF file (file buffers only).

Definition at line 115 of file mne_raw_buf_def.h.

◆ firsts

int MNELIB::MNERawBufDef::firsts

Definition at line 116 of file mne_raw_buf_def.h.

◆ is_skip

int MNELIB::MNERawBufDef::is_skip

Non-zero if this buffer represents a data skip.

Definition at line 120 of file mne_raw_buf_def.h.

◆ lasts

int MNELIB::MNERawBufDef::lasts

First and last sample indices.

Definition at line 116 of file mne_raw_buf_def.h.

◆ nchan

int MNELIB::MNERawBufDef::nchan

Number of channels.

Definition at line 119 of file mne_raw_buf_def.h.

◆ ns

int MNELIB::MNERawBufDef::ns

Number of samples (lasts - firsts + 1).

Definition at line 118 of file mne_raw_buf_def.h.

◆ ntaper

int MNELIB::MNERawBufDef::ntaper

Taper length for filtered buffers.

Definition at line 117 of file mne_raw_buf_def.h.

◆ valid

int MNELIB::MNERawBufDef::valid

Non-zero if the data in this buffer are meaningful.

Definition at line 122 of file mne_raw_buf_def.h.

◆ vals

RowMajorMatrixXf MNELIB::MNERawBufDef::vals

Sample values matrix [nchan x ns], row-major (empty if not loaded into memory).

Definition at line 121 of file mne_raw_buf_def.h.

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

src/libraries/mne/mne_raw_buf_def.h
src/libraries/mne/mne_raw_buf_def.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes