FIFF raw measurement data. More...

#include <fiff_raw_data.h>

Public Types
typedef QSharedPointer< FiffRawData >	SPtr
typedef QSharedPointer< const FiffRawData >	ConstSPtr

Public Member Functions
	FiffRawData ()
	FiffRawData (const FiffRawData &p_FiffRawData)
	FiffRawData (QIODevice &p_IODevice)
	FiffRawData (QIODevice &p_IODevice, bool b_littleEndian)
	~FiffRawData ()
void	clear ()
bool	isEmpty () const
bool	read_raw_segment (Eigen::MatrixXd &data, Eigen::MatrixXd &times, fiff_int_t from=-1, fiff_int_t to=-1, const Eigen::RowVectorXi &sel=defaultRowVectorXi, bool do_debug=false) const
bool	read_raw_segment (Eigen::MatrixXd &data, Eigen::MatrixXd &times, Eigen::SparseMatrix< double > &multSegment, fiff_int_t from=-1, fiff_int_t to=-1, const Eigen::RowVectorXi &sel=defaultRowVectorXi, bool do_debug=false) const
bool	read_raw_segment_times (Eigen::MatrixXd &data, Eigen::MatrixXd &times, float from, float to, const Eigen::RowVectorXi &sel=defaultRowVectorXi) const
bool	save (QIODevice &p_IODevice, const Eigen::RowVectorXi &picks=Eigen::RowVectorXi(), int decim=1, int from=-1, int to=-1) const

Public Attributes
FiffStream::SPtr	file
FiffInfo	info
fiff_int_t	first_samp
fiff_int_t	last_samp
Eigen::RowVectorXd	cals
QList< FiffRawDir >	rawdir
Eigen::MatrixXd	proj
FiffCtfComp	comp

Detailed Description

FIFF raw measurement data.

Provides fiff raw measurement data, including I/O routines.

Definition at line 79 of file fiff_raw_data.h.

Member Typedef Documentation

◆ ConstSPtr

typedef QSharedPointer<const FiffRawData> FIFFLIB::FiffRawData::ConstSPtr

Const shared pointer type for FiffRawData.

Definition at line 83 of file fiff_raw_data.h.

◆ SPtr

typedef QSharedPointer<FiffRawData> FIFFLIB::FiffRawData::SPtr

Shared pointer type for FiffRawData.

Definition at line 82 of file fiff_raw_data.h.

Constructor & Destructor Documentation

◆ FiffRawData() [1/4]

FiffRawData::FiffRawData ( )

Default constructor.

Definition at line 58 of file fiff_raw_data.cpp.

◆ FiffRawData() [2/4]

FiffRawData::FiffRawData ( const FiffRawData & p_FiffRawData )

Copy constructor.

Parameters

[in] p_FiffRawData FIFF raw measurement which should be copied.

Definition at line 96 of file fiff_raw_data.cpp.

◆ FiffRawData() [3/4]

FiffRawData::FiffRawData ( QIODevice & p_IODevice )

Constructs fiff raw data, by reading from a IO device.

Parameters

[in] p_IODevice IO device to read the raw data from .

Definition at line 66 of file fiff_raw_data.cpp.

◆ FiffRawData() [4/4]

FiffRawData::FiffRawData	(	QIODevice &	p_IODevice,
		bool	b_littleEndian )

Constructs fiff raw data, by reading from a IO device with specified endianness.

Parameters

[in]	p_IODevice	IO device to read the raw data from.
[in]	b_littleEndian	If true, read data as little-endian.

Definition at line 81 of file fiff_raw_data.cpp.

◆ ~FiffRawData()

FiffRawData::~FiffRawData ( )

Destroys the FiffInfo.

Definition at line 110 of file fiff_raw_data.cpp.

Member Function Documentation

◆ clear()

void FiffRawData::clear ( )

Initializes the fiff raw measurement data.

Definition at line 116 of file fiff_raw_data.cpp.

◆ isEmpty()

bool FIFFLIB::FiffRawData::isEmpty ( ) const

inline

True if fiff raw data are empty.

Returns: true if fiff raw data are empty.

Definition at line 134 of file fiff_raw_data.h.

◆ read_raw_segment() [1/2]

bool FIFFLIB::FiffRawData::read_raw_segment	(	Eigen::MatrixXd &	data,
		Eigen::MatrixXd &	times,
		Eigen::SparseMatrix< double > &	multSegment,
		fiff_int_t	from = -1,
		fiff_int_t	to = -1,
		const Eigen::RowVectorXi &	sel = defaultRowVectorXi,
		bool	do_debug = false ) const

Read a specific raw data segment

Parameters

[out]	data	returns the data matrix (channels x samples).
[out]	times	returns the time values corresponding to the samples.
[out]	multSegment	used multiplication matrix (compensator,projection,calibration).
[in]	from	first sample to include. If omitted, defaults to the first sample in data (optional).
[in]	to	last sample to include. If omitted, defaults to the last sample in data (optional).
[in]	sel	channel selection vector (optional).

Returns: true if succeeded, false otherwise.

◆ read_raw_segment() [2/2]

bool FIFFLIB::FiffRawData::read_raw_segment	(	Eigen::MatrixXd &	data,
		Eigen::MatrixXd &	times,
		fiff_int_t	from = -1,
		fiff_int_t	to = -1,
		const Eigen::RowVectorXi &	sel = defaultRowVectorXi,
		bool	do_debug = false ) const

Read a specific raw data segment

Parameters

[out]	data	returns the data matrix (channels x samples).
[out]	times	returns the time values corresponding to the samples.
[in]	from	first sample to include. If omitted, defaults to the first sample in data (optional).
[in]	to	last sample to include. If omitted, defaults to the last sample in data (optional).
[in]	sel	channel selection vector (optional).

Returns: true if succeeded, false otherwise.

◆ read_raw_segment_times()

bool FiffRawData::read_raw_segment_times	(	Eigen::MatrixXd &	data,
		Eigen::MatrixXd &	times,
		float	from,
		float	to,
		const Eigen::RowVectorXi &	sel = defaultRowVectorXi ) const

Read a specific raw data segment

Parameters

[out]	data	returns the data matrix (channels x samples).
[out]	times	returns the time values corresponding to the samples.
[in]	from	starting time of the segment in seconds.
[in]	to	end time of the segment in seconds.
[in]	sel	optional channel selection vector.

Returns: true if succeeded, false otherwise.

Definition at line 802 of file fiff_raw_data.cpp.

◆ save()

bool FiffRawData::save	(	QIODevice &	p_IODevice,
		const Eigen::RowVectorXi &	picks = Eigen::RowVectorXi(),
		int	decim = 1,
		int	from = -1,
		int	to = -1 ) const

Save raw data to a FIFF file, optionally with decimation and channel picking. Ported from save.c (MNE-C).

Parameters

[in]	p_IODevice	Output device to write to.
[in]	picks	Channel indices to include (empty = all channels).
[in]	decim	Decimation factor (1 = no decimation).
[in]	from	First sample to save (-1 = from start of raw data).
[in]	to	Last sample to save (-1 = to end of raw data).

Returns: true on success.

Definition at line 821 of file fiff_raw_data.cpp.

Member Data Documentation

◆ cals

Eigen::RowVectorXd FIFFLIB::FiffRawData::cals

Calibration values.

Definition at line 221 of file fiff_raw_data.h.

◆ comp

FiffCtfComp FIFFLIB::FiffRawData::comp

Compensator.

Definition at line 224 of file fiff_raw_data.h.

◆ file

FiffStream::SPtr FIFFLIB::FiffRawData::file

replaces fid.

Definition at line 217 of file fiff_raw_data.h.

◆ first_samp

fiff_int_t FIFFLIB::FiffRawData::first_samp

First sample number.

Definition at line 219 of file fiff_raw_data.h.

◆ info

FiffInfo FIFFLIB::FiffRawData::info

Fiff measurement information.

Definition at line 218 of file fiff_raw_data.h.

◆ last_samp

fiff_int_t FIFFLIB::FiffRawData::last_samp

Last sample number.

Definition at line 220 of file fiff_raw_data.h.

◆ proj

Eigen::MatrixXd FIFFLIB::FiffRawData::proj

SSP operator to apply to the data.

Definition at line 223 of file fiff_raw_data.h.

◆ rawdir

QList<FiffRawDir> FIFFLIB::FiffRawData::rawdir

Special fiff directory entry for raw data.

Definition at line 222 of file fiff_raw_data.h.

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

src/libraries/fiff/fiff_raw_data.h
src/libraries/fiff/fiff_raw_data.cpp

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ ConstSPtr

◆ SPtr

Constructor & Destructor Documentation

◆ FiffRawData() [1/4]

◆ FiffRawData() [2/4]

◆ FiffRawData() [3/4]

◆ FiffRawData() [4/4]

◆ ~FiffRawData()

Member Function Documentation

◆ clear()

◆ isEmpty()

◆ read_raw_segment() [1/2]

◆ read_raw_segment() [2/2]

◆ read_raw_segment_times()

◆ save()

Member Data Documentation

◆ cals

◆ comp

◆ file

◆ first_samp

◆ info

◆ last_samp

◆ proj

◆ rawdir