FIFFLIB::FiffRawData Class Reference

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

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 78 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 82 of file fiff_raw_data.h.

SPtr

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

Shared pointer type for FiffRawData.

Definition at line 81 of file fiff_raw_data.h.

Constructor & Destructor Documentation

FiffRawData() [1/3]

FiffRawData::FiffRawData

(

)

Default constructor.

Definition at line 57 of file fiff_raw_data.cpp.

FiffRawData() [2/3]

FiffRawData::FiffRawData

(

const FiffRawData &

p_FiffRawData

)

Copy constructor.

Parameters

[in]

p_FiffRawData

FIFF raw measurement which should be copied.

Definition at line 95 of file fiff_raw_data.cpp.

FiffRawData() [3/3]

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 65 of file fiff_raw_data.cpp.

~FiffRawData()

FiffRawData::~FiffRawData

(

)

Destroys the FiffInfo.

Definition at line 109 of file fiff_raw_data.cpp.

Member Function Documentation

clear()

void FiffRawData::clear

(

)

Initializes the fiff raw measurement data.

Definition at line 115 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 126 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

MNE toolbox root function ###: Definition of the fiff_read_raw_segment function

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

MNE toolbox root function ###: Definition of the fiff_read_raw_segment function

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

MNE toolbox root function ###: Definition of the fiff_read_raw_segment function

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 801 of file fiff_raw_data.cpp.

Member Data Documentation

cals

Eigen::RowVectorXd FIFFLIB::FiffRawData::cals

Calibration values. ToDo: Check if RowVectorXd is enough.

Definition at line 200 of file fiff_raw_data.h.

comp

FiffCtfComp FIFFLIB::FiffRawData::comp

Compensator.

Definition at line 203 of file fiff_raw_data.h.

file

FiffStream::SPtr FIFFLIB::FiffRawData::file

replaces fid.

Definition at line 196 of file fiff_raw_data.h.

first_samp

fiff_int_t FIFFLIB::FiffRawData::first_samp

Do we have a skip ToDo...

Definition at line 198 of file fiff_raw_data.h.

info

FiffInfo FIFFLIB::FiffRawData::info

Fiff measurement information.

Definition at line 197 of file fiff_raw_data.h.

last_samp

fiff_int_t FIFFLIB::FiffRawData::last_samp

Do we have a skip ToDo...

Definition at line 199 of file fiff_raw_data.h.

proj

Eigen::MatrixXd FIFFLIB::FiffRawData::proj

SSP operator to apply to the data.

Definition at line 202 of file fiff_raw_data.h.

rawdir

QList<FiffRawDir> FIFFLIB::FiffRawData::rawdir

Special fiff diretory entry for raw data.

Definition at line 201 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