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

Classes
struct	frameNameRec
class	FiffCoordTransOld
	Coordinate transformation descriptor. More...
class	FiffCoordTransSet
	Coordinate transformation descriptor. More...
class	FiffDigitizerData
	Digitization points container and description. More...
class	FiffSparseMatrix
	Data associated with MNE computations for each mneMeasDataSet. More...
struct	_fiffTagRec
	Outdated STUFF!!!!!!!!!!!!!!!!!!!!! ToDo Remove. More...
struct	_fiffTimeRec
struct	_fiffDigStringRec
struct	_fiff_event_bits
struct	_fiffIdRec
	ToDo Old implementation use new fiff_id.h instead. More...
struct	_fiffChPosRec
struct	_fiffDirEntryRec
	ToDo Old implementation use new fiff_dir_entry.h instead. More...
struct	_fiffDigPointRec
	ToDo Old implementation. More...
struct	_fiffCoordTransRec
struct	_fiff_sparse_matrix
struct	_fiff_hpi_coil
struct	_fiff_hpi_subsys
struct	_fiff_data_ref
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	FiffCov
	covariance data More...
class	FiffCtfComp
	CTF software compensation data. More...
class	FiffDigPoint
	Digitization point description. More...
class	FiffDigPointSet
	Holds a set of digitizer points. More...
class	FiffDirEntry
	Directory entry description. More...
class	FiffDirNode
	Directory Node structure. More...
class	FiffEvoked
	evoked data More...
class	FiffEvokedSet
	evoked data set More...
struct	_fiffExp
class	FiffId
	Universially unique identifier. More...
class	FiffInfo
	FIFF measurement file information. More...
class	FiffInfoBase
	light measurement info More...
class	FiffIO
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	FiffStream
	FIFF File I/O routines. More...
class	FiffTag
	FIFF data tag. More...
class	FiffFileSharer

Typedefs
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 qint64	fiff_julian_t
typedef char	fiff_data_t
typedef struct FIFFLIB::_fiffTagRec *	fiffTag
	Outdated STUFF!!!!!!!!!!!!!!!!!!!!! ToDo Remove.
typedef struct FIFFLIB::_fiffTagRec	fiffTagRec
typedef struct FIFFLIB::_fiffTimeRec *	fiffTime
typedef struct FIFFLIB::_fiffTimeRec	fiffTimeRec
typedef struct FIFFLIB::_fiffDigStringRec	fiffDigStringRec
typedef struct FIFFLIB::_fiffDigStringRec *	fiffDigString
typedef fiffDigStringRec	fiff_dig_string_t
typedef struct FIFFLIB::_fiff_event_bits *	fiffEventBits
typedef struct FIFFLIB::_fiff_event_bits	fiffEventBitsRec
typedef struct FIFFLIB::_fiffIdRec *	fiffId
	ToDo Old implementation use new fiff_id.h instead.
typedef struct FIFFLIB::_fiffIdRec	fiffIdRec
typedef fiffIdRec	fiff_id_t
typedef struct FIFFLIB::_fiffChPosRec	fiffChPosRec
typedef struct FIFFLIB::_fiffChPosRec *	fiffChPos
typedef fiffChPosRec	fiff_ch_pos_t
typedef struct FIFFLIB::_fiffDirEntryRec	fiffDirEntryRec
	ToDo Old implementation use new fiff_dir_entry.h instead.
typedef struct FIFFLIB::_fiffDirEntryRec *	fiffDirEntry
typedef fiffDirEntryRec	fiff_dir_entry_t
typedef struct FIFFLIB::_fiffDigPointRec *	fiffDigPoint
	ToDo Old implementation.
typedef struct FIFFLIB::_fiffDigPointRec	fiffDigPointRec
typedef fiffDigPointRec	fiff_dig_point_t
typedef struct FIFFLIB::_fiffCoordTransRec *	fiffCoordTrans
typedef struct FIFFLIB::_fiffCoordTransRec	fiffCoordTransRec
typedef fiffCoordTransRec	fiff_coord_trans_t
typedef struct FIFFLIB::_fiff_sparse_matrix *	fiffSparseMatrix
typedef struct FIFFLIB::_fiff_sparse_matrix	fiffSparseMatrixRec
typedef fiffSparseMatrixRec	fiff_sparse_matrix_t
typedef struct FIFFLIB::_fiff_hpi_coil *	fiffHpiCoil
typedef struct FIFFLIB::_fiff_hpi_coil	fiffHpiCoilRec
typedef struct FIFFLIB::_fiff_hpi_subsys *	fiffHpiSubsys
typedef struct FIFFLIB::_fiff_hpi_subsys	fiffHpiSubsysRec
typedef struct FIFFLIB::_fiff_data_ref *	fiffDataRef
typedef struct FIFFLIB::_fiff_data_ref	fiffDataRefRec
typedef Eigen::Matrix< qint16, Eigen::Dynamic, Eigen::Dynamic >	MatrixDau16
typedef Eigen::Matrix< short, Eigen::Dynamic, Eigen::Dynamic >	MatrixShort

Functions
bool	operator== (const FiffCoordTransOld &a, const FiffCoordTransOld &b)
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)

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 123 of file fiff_types_mne-c.h.

◆ fiff_ch_pos_t

typedef fiffChPosRec FIFFLIB::fiff_ch_pos_t

Definition at line 263 of file fiff_types_mne-c.h.

◆ fiff_char_t

typedef char FIFFLIB::fiff_char_t

Definition at line 124 of file fiff_types_mne-c.h.

◆ fiff_coord_trans_t

typedef fiffCoordTransRec FIFFLIB::fiff_coord_trans_t

Definition at line 445 of file fiff_types_mne-c.h.

◆ fiff_data_t

typedef char FIFFLIB::fiff_data_t

Definition at line 137 of file fiff_types_mne-c.h.

◆ fiff_dau_pack13_t

typedef quint16 FIFFLIB::fiff_dau_pack13_t

Definition at line 133 of file fiff_types_mne-c.h.

◆ fiff_dau_pack14_t

typedef quint16 FIFFLIB::fiff_dau_pack14_t

Definition at line 134 of file fiff_types_mne-c.h.

◆ fiff_dau_pack16_t

typedef qint16 FIFFLIB::fiff_dau_pack16_t

Definition at line 135 of file fiff_types_mne-c.h.

◆ fiff_dig_point_t

typedef fiffDigPointRec FIFFLIB::fiff_dig_point_t

Structure representing digitized strings.

Definition at line 414 of file fiff_types_mne-c.h.

◆ fiff_dig_string_t

typedef fiffDigStringRec FIFFLIB::fiff_dig_string_t

Definition at line 196 of file fiff_types_mne-c.h.

◆ fiff_dir_entry_t

typedef fiffDirEntryRec FIFFLIB::fiff_dir_entry_t

Alias for fiffDirEntryRec

Definition at line 400 of file fiff_types_mne-c.h.

◆ fiff_double_t

typedef double FIFFLIB::fiff_double_t

Definition at line 132 of file fiff_types_mne-c.h.

◆ fiff_float_t

typedef float FIFFLIB::fiff_float_t

Definition at line 131 of file fiff_types_mne-c.h.

◆ fiff_id_t

typedef fiffIdRec FIFFLIB::fiff_id_t

Definition at line 220 of file fiff_types_mne-c.h.

◆ fiff_int_t

typedef qint32 FIFFLIB::fiff_int_t

Definition at line 127 of file fiff_types_mne-c.h.

◆ fiff_julian_t

typedef qint32 FIFFLIB::fiff_julian_t

Definition at line 136 of file fiff_types_mne-c.h.

◆ fiff_long_t

typedef qint64 FIFFLIB::fiff_long_t

Definition at line 129 of file fiff_types_mne-c.h.

◆ fiff_short_t

typedef qint16 FIFFLIB::fiff_short_t

Definition at line 125 of file fiff_types_mne-c.h.

◆ fiff_sparse_matrix_t

typedef fiffSparseMatrixRec FIFFLIB::fiff_sparse_matrix_t

Definition at line 548 of file fiff_types_mne-c.h.

◆ fiff_uint_t

typedef quint32 FIFFLIB::fiff_uint_t

Definition at line 128 of file fiff_types_mne-c.h.

◆ fiff_ulong_t

typedef quint64 FIFFLIB::fiff_ulong_t

Definition at line 130 of file fiff_types_mne-c.h.

◆ fiff_ushort_t

typedef quint16 FIFFLIB::fiff_ushort_t

Definition at line 126 of file fiff_types_mne-c.h.

◆ fiffChPos

typedef struct FIFFLIB::_fiffChPosRec* FIFFLIB::fiffChPos

Measurement channel position and coil type.

◆ fiffChPosRec

typedef struct FIFFLIB::_fiffChPosRec FIFFLIB::fiffChPosRec

Measurement channel position and coil type.

◆ fiffCoordTrans

typedef struct FIFFLIB::_fiffCoordTransRec * FIFFLIB::fiffCoordTrans

Coordinate transformation descriptor

◆ fiffCoordTransRec

typedef struct FIFFLIB::_fiffCoordTransRec FIFFLIB::fiffCoordTransRec

Coordinate transformation descriptor.

◆ fiffDataRef

typedef struct FIFFLIB::_fiff_data_ref * FIFFLIB::fiffDataRef

Structure representing digitized strings. Layer descriptor for a layered sphere model Structure for sparse matrices Structure for event bits Structure for hpi coil Structure for hpi subsystem Structure for external file references

◆ fiffDataRefRec

typedef struct FIFFLIB::_fiff_data_ref FIFFLIB::fiffDataRefRec

◆ fiffDigPoint

typedef struct FIFFLIB::_fiffDigPointRec * FIFFLIB::fiffDigPoint

ToDo Old implementation.

Digitization point description

◆ fiffDigPointRec

typedef struct FIFFLIB::_fiffDigPointRec FIFFLIB::fiffDigPointRec

Digitization point description.

◆ fiffDigString

typedef struct FIFFLIB::_fiffDigStringRec * FIFFLIB::fiffDigString

Structure representing digitized strings.

◆ fiffDigStringRec

typedef struct FIFFLIB::_fiffDigStringRec FIFFLIB::fiffDigStringRec

Structure representing digitized strings.

◆ fiffDirEntry

typedef struct FIFFLIB::_fiffDirEntryRec * FIFFLIB::fiffDirEntry

Directory is composed of these.

◆ fiffDirEntryRec

typedef struct FIFFLIB::_fiffDirEntryRec FIFFLIB::fiffDirEntryRec

ToDo Old implementation use new fiff_dir_entry.h instead.

Directories are composed of these structures.

◆ fiffEventBits

typedef struct FIFFLIB::_fiff_event_bits * FIFFLIB::fiffEventBits

Structure for event bits

◆ fiffEventBitsRec

typedef struct FIFFLIB::_fiff_event_bits FIFFLIB::fiffEventBitsRec

◆ fiffHpiCoil

typedef struct FIFFLIB::_fiff_hpi_coil * FIFFLIB::fiffHpiCoil

Structure for event bits Structure for hpi coil

◆ fiffHpiCoilRec

typedef struct FIFFLIB::_fiff_hpi_coil FIFFLIB::fiffHpiCoilRec

◆ fiffHpiSubsys

typedef struct FIFFLIB::_fiff_hpi_subsys * FIFFLIB::fiffHpiSubsys

Structure for hpi subsystem

◆ fiffHpiSubsysRec

typedef struct FIFFLIB::_fiff_hpi_subsys FIFFLIB::fiffHpiSubsysRec

◆ fiffId

typedef struct FIFFLIB::_fiffIdRec * FIFFLIB::fiffId

ToDo Old implementation use new fiff_id.h instead.

A file ID.

These universially unique identifiers are also used to identify blocks within fthe files.

◆ fiffIdRec

typedef struct FIFFLIB::_fiffIdRec FIFFLIB::fiffIdRec

This is the file identifier.

◆ fiffSparseMatrix

typedef struct FIFFLIB::_fiff_sparse_matrix * FIFFLIB::fiffSparseMatrix

Directory tree structure used by the fiff library routines. FIFF file handle returned by fiff_open(). Structure for sparse matrices

◆ fiffSparseMatrixRec

typedef struct FIFFLIB::_fiff_sparse_matrix FIFFLIB::fiffSparseMatrixRec

◆ fiffTag

typedef struct FIFFLIB::_fiffTagRec * FIFFLIB::fiffTag

Outdated STUFF!!!!!!!!!!!!!!!!!!!!! ToDo Remove.

FIFF data tag

Tags are used in front of data items to tell what they are.

ToDo Old implementation use new fiff_tag.h instead FIFF data tag

Tags are used in front of data items to tell what they are.

◆ fiffTagRec

typedef struct FIFFLIB::_fiffTagRec FIFFLIB::fiffTagRec

FIFF data tag.

◆ fiffTime

typedef struct FIFFLIB::_fiffTimeRec * FIFFLIB::fiffTime

Accurate time stamps used in FIFF files.

◆ fiffTimeRec

typedef struct FIFFLIB::_fiffTimeRec FIFFLIB::fiffTimeRec

Accurate time stamps used in FIFF files.

◆ MatrixDau16

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

Definition at line 76 of file fiff_types.h.

◆ MatrixShort

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

Definition at line 77 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<<() [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 237 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 213 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 165 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 162 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 141 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 325 of file fiff_coord_trans.h.

◆ operator==() [4/7]

bool FIFFLIB::operator==	(	const FiffCoordTransOld &	a,
		const FiffCoordTransOld &	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 217 of file fiff_coord_trans_old.h.

◆ operator==() [5/7]

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

inline

Definition at line 189 of file fiff_id.h.

◆ operator==() [6/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 240 of file fiff_info_base.h.

◆ operator==() [7/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 293 of file fiff_named_matrix.h.

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ fiff_byte_t

◆ fiff_ch_pos_t

◆ fiff_char_t

◆ fiff_coord_trans_t

◆ fiff_data_t

◆ fiff_dau_pack13_t

◆ fiff_dau_pack14_t

◆ fiff_dau_pack16_t

◆ fiff_dig_point_t

◆ fiff_dig_string_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_sparse_matrix_t

◆ fiff_uint_t

◆ fiff_ulong_t

◆ fiff_ushort_t

◆ fiffChPos

◆ fiffChPosRec

◆ fiffCoordTrans

◆ fiffCoordTransRec

◆ fiffDataRef

◆ fiffDataRefRec

◆ fiffDigPoint

◆ fiffDigPointRec

◆ fiffDigString

◆ fiffDigStringRec

◆ fiffDirEntry

◆ fiffDirEntryRec

◆ fiffEventBits

◆ fiffEventBitsRec

◆ fiffHpiCoil

◆ fiffHpiCoilRec

◆ fiffHpiSubsys

◆ fiffHpiSubsysRec

◆ fiffId

◆ fiffIdRec

◆ fiffSparseMatrix

◆ fiffSparseMatrixRec

◆ fiffTag

◆ fiffTagRec

◆ fiffTime

◆ fiffTimeRec

◆ MatrixDau16

◆ MatrixShort

Function Documentation

◆ buildDateTime()

◆ buildHash()

◆ buildHashLong()

◆ 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]