FIFF file I/O and data structures (raw, epochs, evoked, covariance, forward). More...

Classes
class	Fiff
	The Fiff class provides static wrapper functions to stay consistent with mne matlab toolbox Note: avoid using the wrappers, prefer the wrapped methods! More...
class	FiffChInfo
	Channel info descriptor. More...
class	FiffChPos
	Measurement channel position and coil type. More...
class	FiffCoordTrans
	Coordinate transformation description. More...
class	FiffCoordTransSet
	Coordinate transformation descriptor set. More...
class	FiffCov
	covariance data More...
class	FiffCtfComp
	CTF software compensation data. More...
class	FiffDataRef
	External data reference descriptor. More...
class	FiffDigPoint
	Digitization point description. More...
class	FiffDigPointSet
	Holds a set of digitizer points. More...
class	FiffDigitizerData
	Digitization points container and description. More...
class	FiffDirEntry
	Directory entry description. More...
class	FiffDirNode
	Directory node structure. More...
class	FiffEvents
	FIFF event container with reading, writing and detection. More...
class	FiffEvoked
	evoked data More...
struct	RejectionParams
struct	AverageCategory
struct	AverageDescription
class	FiffEvokedSet
	evoked data set More...
struct	_fiffExp
	FIFF tag explanation record mapping a FIFF tag kind to its human-readable description text. More...
class	FiffFileSharer
	Utility for sharing FIFF file data between processes or threads via memory-mapped I/O. More...
class	FiffId
	Universally unique identifier. More...
class	FiffInfo
	FIFF measurement file information. More...
class	FiffInfoBase
	light measurement info More...
class	FiffIO
	High-level reader/writer that loads and saves complete FIFF measurement files. More...
class	FiffNamedMatrix
	A named matrix. More...
class	FiffProj
	SSP projector data. More...
class	FiffRawData
	FIFF raw measurement data. More...
class	FiffRawDir
	Raw Directory entry. More...
class	FiffSparseMatrix
	FIFF sparse matrix storage. More...
class	FiffStream
	FIFF File I/O routines. More...
class	FiffTag
	FIFF data tag. More...
class	FiffTime
	Time stamp record storing seconds and microseconds since epoch. More...

Typedefs
typedef FiffDataRef	fiffDataRefRec
	Backward-compatible typedef for the old fiffDataRefRec struct.
typedef FiffDataRef *	fiffDataRef
	Backward-compatible pointer typedef for the old fiffDataRef pointer.
typedef Eigen::Matrix< qint16, Eigen::Dynamic, Eigen::Dynamic >	MatrixDau16
typedef Eigen::Matrix< short, Eigen::Dynamic, Eigen::Dynamic >	MatrixShort
typedef unsigned char	fiff_byte_t
typedef char	fiff_char_t
typedef qint16	fiff_short_t
typedef quint16	fiff_ushort_t
typedef qint32	fiff_int_t
typedef quint32	fiff_uint_t
typedef qint64	fiff_long_t
typedef quint64	fiff_ulong_t
typedef float	fiff_float_t
typedef double	fiff_double_t
typedef quint16	fiff_dau_pack13_t
typedef quint16	fiff_dau_pack14_t
typedef qint16	fiff_dau_pack16_t
typedef qint32	fiff_julian_t
typedef char	fiff_data_t
typedef FiffId	fiffIdRec
	Backward-compatible typedef for the old fiffIdRec struct.
typedef FiffId	fiff_id_t
	Backward-compatible typedef for the old fiff_id_t.
typedef FiffId *	fiffId
	Backward-compatible pointer typedef for the old fiffId pointer.
typedef FiffDirEntry	fiffDirEntryRec
	Backward-compatible typedef for the old fiffDirEntryRec struct.
typedef FiffDirEntry	fiff_dir_entry_t
	Backward-compatible typedef for the old fiff_dir_entry_t.
typedef FiffDirEntry *	fiffDirEntry
	Backward-compatible pointer typedef for the old fiffDirEntry pointer.
typedef FiffDigPoint	fiffDigPointRec
	Backward-compatible typedef for the old fiffDigPointRec struct.

Functions
bool	operator== (const FiffChInfo &a, const FiffChInfo &b)
bool	operator== (const FiffChPos &a, const FiffChPos &b)
bool	operator== (const FiffCoordTrans &a, const FiffCoordTrans &b)
std::ostream &	operator<< (std::ostream &out, const FIFFLIB::FiffCov &p_FiffCov)
const char *	buildDateTime ()
const char *	buildHash ()
const char *	buildHashLong ()
bool	operator== (const FiffId &a, const FiffId &b)
bool	operator== (const FiffInfoBase &a, const FiffInfoBase &b)
std::ostream &	operator<< (std::ostream &out, const FIFFLIB::FiffNamedMatrix &p_FiffNamedMatrix)
bool	operator== (const FiffNamedMatrix &a, const FiffNamedMatrix &b)
std::ostream &	operator<< (std::ostream &out, const FIFFLIB::FiffProj &p_FiffProj)
bool	operator== (const FiffTime &a, const FiffTime &b)
bool	operator!= (const FiffTime &a, const FiffTime &b)

Detailed Description

FIFF file I/O and data structures (raw, epochs, evoked, covariance, forward).

Typedef Documentation

◆ fiff_byte_t

typedef unsigned char FIFFLIB::fiff_byte_t

Definition at line 85 of file fiff_types.h.

◆ fiff_char_t

typedef char FIFFLIB::fiff_char_t

Definition at line 86 of file fiff_types.h.

◆ fiff_data_t

typedef char FIFFLIB::fiff_data_t

Definition at line 99 of file fiff_types.h.

◆ fiff_dau_pack13_t

typedef quint16 FIFFLIB::fiff_dau_pack13_t

Definition at line 95 of file fiff_types.h.

◆ fiff_dau_pack14_t

typedef quint16 FIFFLIB::fiff_dau_pack14_t

Definition at line 96 of file fiff_types.h.

◆ fiff_dau_pack16_t

typedef qint16 FIFFLIB::fiff_dau_pack16_t

Definition at line 97 of file fiff_types.h.

◆ fiff_dir_entry_t

typedef FiffDirEntry FIFFLIB::fiff_dir_entry_t

Backward-compatible typedef for the old fiff_dir_entry_t.

Definition at line 142 of file fiff_types.h.

◆ fiff_double_t

typedef double FIFFLIB::fiff_double_t

Definition at line 94 of file fiff_types.h.

◆ fiff_float_t

typedef float FIFFLIB::fiff_float_t

Definition at line 93 of file fiff_types.h.

◆ fiff_id_t

typedef FiffId FIFFLIB::fiff_id_t

Backward-compatible typedef for the old fiff_id_t.

Definition at line 128 of file fiff_types.h.

◆ fiff_int_t

typedef qint32 FIFFLIB::fiff_int_t

Definition at line 89 of file fiff_types.h.

◆ fiff_julian_t

typedef qint32 FIFFLIB::fiff_julian_t

Definition at line 98 of file fiff_types.h.

◆ fiff_long_t

typedef qint64 FIFFLIB::fiff_long_t

Definition at line 91 of file fiff_types.h.

◆ fiff_short_t

typedef qint16 FIFFLIB::fiff_short_t

Definition at line 87 of file fiff_types.h.

◆ fiff_uint_t

typedef quint32 FIFFLIB::fiff_uint_t

Definition at line 90 of file fiff_types.h.

◆ fiff_ulong_t

typedef quint64 FIFFLIB::fiff_ulong_t

Definition at line 92 of file fiff_types.h.

◆ fiff_ushort_t

typedef quint16 FIFFLIB::fiff_ushort_t

Definition at line 88 of file fiff_types.h.

◆ fiffDataRef

typedef FiffDataRef* FIFFLIB::fiffDataRef

Backward-compatible pointer typedef for the old fiffDataRef pointer.

Definition at line 104 of file fiff_data_ref.h.

◆ fiffDataRefRec

typedef FiffDataRef FIFFLIB::fiffDataRefRec

Backward-compatible typedef for the old fiffDataRefRec struct.

Definition at line 102 of file fiff_data_ref.h.

◆ fiffDigPointRec

typedef FiffDigPoint FIFFLIB::fiffDigPointRec

Backward-compatible typedef for the old fiffDigPointRec struct.

Definition at line 154 of file fiff_types.h.

◆ fiffDirEntry

typedef FiffDirEntry* FIFFLIB::fiffDirEntry

Backward-compatible pointer typedef for the old fiffDirEntry pointer.

Definition at line 144 of file fiff_types.h.

◆ fiffDirEntryRec

typedef FiffDirEntry FIFFLIB::fiffDirEntryRec

Backward-compatible typedef for the old fiffDirEntryRec struct.

Definition at line 140 of file fiff_types.h.

◆ fiffId

typedef FiffId* FIFFLIB::fiffId

Backward-compatible pointer typedef for the old fiffId pointer.

Definition at line 130 of file fiff_types.h.

◆ fiffIdRec

typedef FiffId FIFFLIB::fiffIdRec

Backward-compatible typedef for the old fiffIdRec struct.

Definition at line 126 of file fiff_types.h.

◆ MatrixDau16

typedef Eigen::Matrix<qint16, Eigen::Dynamic, Eigen::Dynamic> FIFFLIB::MatrixDau16

Definition at line 78 of file fiff_types.h.

◆ MatrixShort

typedef Eigen::Matrix<short, Eigen::Dynamic, Eigen::Dynamic> FIFFLIB::MatrixShort

Definition at line 79 of file fiff_types.h.

Function Documentation

◆ buildDateTime()

const char * FIFFLIB::buildDateTime ( )

Returns build date and time.

Definition at line 46 of file fiff_global.cpp.

◆ buildHash()

const char * FIFFLIB::buildHash ( )

Returns abbreviated build git hash.

Definition at line 50 of file fiff_global.cpp.

◆ buildHashLong()

const char * FIFFLIB::buildHashLong ( )

Returns full build git hash.

Definition at line 54 of file fiff_global.cpp.

◆ operator!=()

bool FIFFLIB::operator!=	(	const FiffTime &	a,
		const FiffTime &	b )

inline

Compares two FiffTime instances for inequality.

Parameters

[in]	a	First time value.
[in]	b	Second time value.

Returns: true if secs or usecs differ.

Definition at line 139 of file fiff_time.h.

◆ operator<<() [1/3]

std::ostream & FIFFLIB::operator<<	(	std::ostream &	out,
		const FIFFLIB::FiffCov &	p_FiffCov )

inline

overloading the stream out operator<<

Parameters

[in]	out	The stream to which the fiff covariance should be assigned to.
[in]	p_FiffCov	FiffCov which should be assigned to the stream.

Returns: the stream with the attached fiff covariance matrix.

Definition at line 271 of file fiff_cov.h.

◆ operator<<() [2/3]

std::ostream & FIFFLIB::operator<<	(	std::ostream &	out,
		const FIFFLIB::FiffNamedMatrix &	p_FiffNamedMatrix )

inline

Assignment Operator

Returns: rhs named matrix which hould be assigned. overloading the stream out operator<<

Parameters

[in]	out	The stream to which the fiff projector should be assigned to.
[in]	p_FiffNamedMatrix	Fiff named matrix which should be assigned to the stream.

Returns: the stream with the attached fiff named matrix.

< Matrix data.

Definition at line 203 of file fiff_named_matrix.h.

◆ operator<<() [3/3]

std::ostream & FIFFLIB::operator<<	(	std::ostream &	out,
		const FIFFLIB::FiffProj &	p_FiffProj )

inline

overloading the stream out operator<<

Parameters

[in]	out	The stream to which the fiff projector should be assigned to.
[in]	p_FiffProj	Fiff projector which should be assigned to the stream.

Returns: the stream with the attached fiff projector.

Definition at line 199 of file fiff_proj.h.

◆ operator==() [1/7]

bool FIFFLIB::operator==	(	const FiffChInfo &	a,
		const FiffChInfo &	b )

inline

Overloaded == operator to compare an object to this instance.

Parameters

[in] object The object which should be compared to.

Returns: true if equal, false otherwise.

Definition at line 150 of file fiff_ch_info.h.

◆ operator==() [2/7]

bool FIFFLIB::operator==	(	const FiffChPos &	a,
		const FiffChPos &	b )

inline

Overloaded == operator to compare an object to this instance.

Parameters

[in] object The object which should be compared to.

Returns: true if equal, false otherwise.

Definition at line 132 of file fiff_ch_pos.h.

◆ operator==() [3/7]

bool FIFFLIB::operator==	(	const FiffCoordTrans &	a,
		const FiffCoordTrans &	b )

inline

Overloaded == operator to compare an object to this instance.

Parameters

[in] object The object which should be compared to.

Returns: true if equal, false otherwise.

Definition at line 493 of file fiff_coord_trans.h.

◆ operator==() [4/7]

bool FIFFLIB::operator==	(	const FiffId &	a,
		const FiffId &	b )

inline

Compares two FiffId instances for equality.

Parameters

[in]	f1	First FiffId.
[in]	f2	Second FiffId.

Returns: true if both IDs are equal, false otherwise.

Definition at line 190 of file fiff_id.h.

◆ operator==() [5/7]

bool FIFFLIB::operator==	(	const FiffInfoBase &	a,
		const FiffInfoBase &	b )

inline

Overloaded == operator to compare an object to this instance.

Parameters

[in] object The object which should be compared to.

Returns: true if equal, false otherwise.

Definition at line 232 of file fiff_info_base.h.

◆ operator==() [6/7]

bool FIFFLIB::operator==	(	const FiffNamedMatrix &	a,
		const FiffNamedMatrix &	b )

inline

Overloaded == operator to compare an object to this instance.

Parameters

[in] object The object which should be compared to.

Returns: true if equal, false otherwise.

Definition at line 283 of file fiff_named_matrix.h.

◆ operator==() [7/7]

bool FIFFLIB::operator==	(	const FiffTime &	a,
		const FiffTime &	b )

inline

Compares two FiffTime instances for equality.

Parameters

[in]	a	First time value.
[in]	b	Second time value.

Returns: true if both secs and usecs are equal.

Definition at line 124 of file fiff_time.h.

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ fiff_byte_t

◆ fiff_char_t

◆ fiff_data_t

◆ fiff_dau_pack13_t

◆ fiff_dau_pack14_t

◆ fiff_dau_pack16_t

◆ fiff_dir_entry_t

◆ fiff_double_t

◆ fiff_float_t

◆ fiff_id_t

◆ fiff_int_t

◆ fiff_julian_t

◆ fiff_long_t

◆ fiff_short_t

◆ fiff_uint_t

◆ fiff_ulong_t

◆ fiff_ushort_t

◆ fiffDataRef

◆ fiffDataRefRec

◆ fiffDigPointRec

◆ fiffDirEntry

◆ fiffDirEntryRec

◆ fiffId

◆ fiffIdRec

◆ MatrixDau16

◆ MatrixShort

Function Documentation

◆ buildDateTime()

◆ buildHash()

◆ buildHashLong()

◆ operator!=()

◆ operator<<() [1/3]

◆ operator<<() [2/3]

◆ operator<<() [3/3]

◆ operator==() [1/7]

◆ operator==() [2/7]

◆ operator==() [3/7]

◆ operator==() [4/7]

◆ operator==() [5/7]

◆ operator==() [6/7]

◆ operator==() [7/7]