MNE-CPP  0.1.9
A Framework for Electrophysiology
Public Types | Public Member Functions | Static Public Member Functions | List of all members
FIFFLIB::FiffStream Class Reference

FIFF File I/O routines. More...

#include <fiff_stream.h>

Public Types

typedef QSharedPointer< FiffStreamSPtr
 
typedef QSharedPointer< const FiffStreamConstSPtr
 

Public Member Functions

 FiffStream (QIODevice *p_pIODevice)
 
 FiffStream (QByteArray *a, QIODevice::OpenMode mode)
 
QString streamName ()
 
FiffId id () const
 
QList< FiffDirEntry::SPtr > & dir ()
 
const QList< FiffDirEntry::SPtr > & dir () const
 
int nent () const
 
const FiffDirNode::SPtrdirtree () const
 
fiff_long_t end_block (fiff_int_t kind, fiff_int_t next=FIFFV_NEXT_SEQ)
 
void end_file ()
 
void finish_writing_raw ()
 
bool get_evoked_entries (const QList< FiffDirNode::SPtr > &evoked_node, QStringList &comments, QList< fiff_int_t > &aspect_kinds, QString &t)
 
bool open (QIODevice::OpenModeFlag mode=QIODevice::ReadOnly)
 
bool close ()
 
FiffDirNode::SPtr make_subtree (QList< FiffDirEntry::SPtr > &dentry)
 
QStringList read_bad_channels (const FiffDirNode::SPtr &p_Node)
 
bool read_cov (const FiffDirNode::SPtr &p_Node, fiff_int_t cov_kind, FiffCov &p_covData)
 
QList< FiffCtfCompread_ctf_comp (const FiffDirNode::SPtr &p_Node, const QList< FiffChInfo > &p_Chs)
 
bool read_digitizer_data (const FiffDirNode::SPtr &p_Node, FiffDigitizerData &p_digData)
 
bool read_meas_info (const FiffDirNode::SPtr &p_Node, FiffInfo &p_Info, FiffDirNode::SPtr &p_NodeInfo)
 
bool read_meas_info_base (const FiffDirNode::SPtr &p_Node, FiffInfoBase &p_InfoForward)
 
bool read_named_matrix (const FiffDirNode::SPtr &p_Node, fiff_int_t matkind, FiffNamedMatrix &mat)
 
QList< FiffProjread_proj (const FiffDirNode::SPtr &p_Node)
 
bool read_tag_data (QSharedPointer< FiffTag > &p_pTag, fiff_long_t pos=-1)
 
fiff_long_t read_tag_info (QSharedPointer< FiffTag > &p_pTag, bool p_bDoSkip=true)
 
bool read_rt_tag (QSharedPointer< FiffTag > &p_pTag)
 
bool read_tag (QSharedPointer< FiffTag > &p_pTag, fiff_long_t pos=-1)
 
fiff_long_t start_block (fiff_int_t kind)
 
fiff_long_t write_tag (const QSharedPointer< FiffTag > &p_pTag, fiff_long_t pos=-1)
 
fiff_long_t write_ch_info (const FiffChInfo &ch)
 
fiff_long_t write_ch_pos (const FiffChPos &chpos)
 
fiff_long_t write_coord_trans (const FiffCoordTrans &trans)
 
fiff_long_t write_cov (const FiffCov &p_FiffCov)
 
fiff_long_t write_ctf_comp (const QList< FiffCtfComp > &comps)
 
fiff_long_t write_dig_point (const FiffDigPoint &dig)
 
fiff_long_t write_dir_pointer (fiff_int_t dirpos, fiff_long_t pos=-1, fiff_int_t next=FIFFV_NEXT_SEQ)
 
fiff_long_t write_dir_entries (const QList< FiffDirEntry::SPtr > &dir, fiff_long_t pos=-1)
 
fiff_long_t write_double (fiff_int_t kind, const double *data, fiff_int_t nel=1)
 
fiff_long_t write_id (fiff_int_t kind, const FiffId &id=FiffId::getDefault())
 
fiff_long_t write_info_base (const FiffInfoBase &p_FiffInfoBase)
 
fiff_long_t write_int (fiff_int_t kind, const fiff_int_t *data, fiff_int_t nel=1, fiff_int_t next=FIFFV_NEXT_SEQ)
 
fiff_long_t write_int_matrix (fiff_int_t kind, const Eigen::MatrixXi &mat)
 
fiff_long_t write_float (fiff_int_t kind, const float *data, fiff_int_t nel=1)
 
fiff_long_t write_float_matrix (fiff_int_t kind, const Eigen::MatrixXf &mat)
 
fiff_long_t write_float_sparse_ccs (fiff_int_t kind, const Eigen::SparseMatrix< float > &mat)
 
fiff_long_t write_float_sparse_rcs (fiff_int_t kind, const Eigen::SparseMatrix< float > &mat)
 
fiff_long_t write_name_list (fiff_int_t kind, const QStringList &data)
 
fiff_long_t write_named_matrix (fiff_int_t kind, const FiffNamedMatrix &mat)
 
fiff_long_t write_proj (const QList< FiffProj > &projs)
 
bool write_raw_buffer (const Eigen::MatrixXd &buf, const Eigen::RowVectorXd &cals)
 
bool write_raw_buffer (const Eigen::MatrixXd &buf, const Eigen::SparseMatrix< double > &mult)
 
bool write_raw_buffer (const Eigen::MatrixXd &buf)
 
fiff_long_t write_string (fiff_int_t kind, const QString &data)
 
void write_rt_command (fiff_int_t command, const QString &data)
 

Static Public Member Functions

static bool setup_read_raw (QIODevice &p_IODevice, FiffRawData &data, bool allow_maxshield=true, bool is_littleEndian=false)
 
static QStringList split_name_list (QString p_sNameList)
 
static FiffStream::SPtr start_file (QIODevice &p_IODevice)
 
static FiffStream::SPtr open_update (QIODevice &p_IODevice)
 
static FiffStream::SPtr start_writing_raw (QIODevice &p_IODevice, const FiffInfo &info, Eigen::RowVectorXd &cals, Eigen::MatrixXi sel=defaultMatrixXi, bool bResetRange=true)
 

Detailed Description

FIFF File I/O routines.

FiffStream provides an interface for reading from and writing to fiff files Comparable to: fiffFile (struct *fiffFile,fiffFileRec)

Definition at line 104 of file fiff_stream.h.

Inheritance diagram for FIFFLIB::FiffStream:
Inheritance graph

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for FiffStream.

Definition at line 108 of file fiff_stream.h.

◆ SPtr

typedef QSharedPointer<FiffStream> FIFFLIB::FiffStream::SPtr

Shared pointer type for FiffStream.

Definition at line 107 of file fiff_stream.h.

Constructor & Destructor Documentation

◆ FiffStream() [1/2]

FiffStream::FiffStream ( QIODevice *  p_pIODevice)
explicit

Constructs a fiff stream that uses the I/O device p_pIODevice.

Parameters
[in]p_pIODeviceA fiff IO device like a fiff QFile or QTCPSocket.

Definition at line 100 of file fiff_stream.cpp.

◆ FiffStream() [2/2]

FiffStream::FiffStream ( QByteArray *  a,
QIODevice::OpenMode  mode 
)
explicit

Constructs a fiff stream that operates on a byte array, a. The mode describes how the device is to be used.

Parameters
[in]aThe byte array.
[in]modeThe open mode.

Definition at line 110 of file fiff_stream.cpp.

Member Function Documentation

◆ close()

bool FiffStream::close ( )

Close stream

Refactored: fiff_close (fiff_open.c)

  • Returns
    true if succeeded, false otherwise.

Definition at line 343 of file fiff_stream.cpp.

◆ dir() [1/2]

QList< FiffDirEntry::SPtr > & FiffStream::dir ( )

Returns the directory compiled into a tree dir is set when open() was called.

Returns
the directory.

Definition at line 142 of file fiff_stream.cpp.

◆ dir() [2/2]

const QList< FiffDirEntry::SPtr > & FiffStream::dir ( ) const

Returns the directory compiled into a tree dir is set when open() was called.

Returns
the directory.

Definition at line 149 of file fiff_stream.cpp.

◆ dirtree()

const FiffDirNode::SPtr & FiffStream::dirtree ( ) const

Returns the directory compiled into a tree tree is set when open() was called.

Returns
the compiled directory.

Definition at line 163 of file fiff_stream.cpp.

◆ end_block()

fiff_long_t FiffStream::end_block ( fiff_int_t  kind,
fiff_int_t  next = FIFFV_NEXT_SEQ 
)

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

Writes a FIFF_BLOCK_END tag

Parameters
[in]kindThe block kind to end.
[in]nextPosition of the next tag (default = FIFFV_NEXT_SEQ).
Returns
the position where the end block struct was written to.

Definition at line 170 of file fiff_stream.cpp.

◆ end_file()

void FiffStream::end_file ( )

Writes the closing tags to a fif file and closes the file Refactored: fiff_end_file (MNE-C); fiff_end_file (MNE-MATLAB)

Definition at line 177 of file fiff_stream.cpp.

◆ finish_writing_raw()

void FiffStream::finish_writing_raw ( )

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

Finishes a raw file by writing all necessary end tags.

Definition at line 189 of file fiff_stream.cpp.

◆ get_evoked_entries()

bool FiffStream::get_evoked_entries ( const QList< FiffDirNode::SPtr > &  evoked_node,
QStringList &  comments,
QList< fiff_int_t > &  aspect_kinds,
QString &  t 
)

Helper to get all evoked entries

Parameters
[in]evoked_nodeevoked tree nodes.
[out]commentsfound comments.
[out]aspect_kindsfound aspect_kinds.
[out]ttext formatted found information.
Returns
true if information is available, fasle otherwise.

Definition at line 199 of file fiff_stream.cpp.

◆ id()

FiffId FiffStream::id ( ) const

Returns the file identifier

Returns
The file identifier.

Definition at line 135 of file fiff_stream.cpp.

◆ make_subtree()

FiffDirNode::SPtr FiffStream::make_subtree ( QList< FiffDirEntry::SPtr > &  dentry)

Create the directory tree structure Refactored: make_subtree (fiff_dir_tree.c), fiff_make_dir_tree (MATLAB)

Parameters
[in]dentryThe dir entries of which the tree should be constructed.
Returns
The created dir tree.

Definition at line 353 of file fiff_stream.cpp.

◆ nent()

int FiffStream::nent ( ) const

How many entries?

Returns
The number of directory entries.

Definition at line 156 of file fiff_stream.cpp.

◆ open()

bool FiffStream::open ( QIODevice::OpenModeFlag  mode = QIODevice::ReadOnly)

QFile::open

unmask base class open function Opens a fif file and provides the directory of tags Refactored: open_file (fiff_open.c)

Parameters
[in]modeThe open mode (Default = ReadOnly).
Returns
true if succeeded, false otherwise.

Definition at line 256 of file fiff_stream.cpp.

◆ open_update()

FiffStream::SPtr FiffStream::open_update ( QIODevice &  p_IODevice)
static

Open fiff file for update Refactored: fiff_open_update (MNE-C)

Parameters
[in]p_IODeviceThe IODevice (like QFile or QTCPSocket) to open. It is recommended that the name ends with .fif.
Returns
The opened file stream.

Definition at line 1955 of file fiff_stream.cpp.

◆ read_bad_channels()

QStringList FiffStream::read_bad_channels ( const FiffDirNode::SPtr p_Node)

fiff_read_bad_channels

MNE toolbox root function

Reads the bad channel list from a node if it exists Note: In difference to mne-matlab this is not a static function. This is a method of the FiffDirNode class, that's why a tree object doesn't need to be handed to the function.

Parameters
[in]p_NodeThe node of interest.
Returns
the bad channel list.

Definition at line 421 of file fiff_stream.cpp.

◆ read_cov()

bool FiffStream::read_cov ( const FiffDirNode::SPtr p_Node,
fiff_int_t  cov_kind,
FiffCov p_covData 
)

mne_read_cov - also for mne_read_noise_cov

MNE toolbox root function

Reads a covariance matrix from a fiff file

Parameters
[in]p_Nodelook for the matrix in here.
[in]cov_kindwhat kind of a covariance matrix do we want?.
[in,out]p_covDatathe read covariance matrix.
Returns
true if succeeded, false otherwise.

Definition at line 437 of file fiff_stream.cpp.

◆ read_ctf_comp()

QList< FiffCtfComp > FiffStream::read_ctf_comp ( const FiffDirNode::SPtr p_Node,
const QList< FiffChInfo > &  p_Chs 
)

fiff_read_ctf_comp

MNE toolbox root function

Read the CTF software compensation data from the given node

Parameters
[in]p_NodeThe node of interest.
[in]p_Chschannels with the calibration info.
Returns
the CTF software compensation data.

Definition at line 656 of file fiff_stream.cpp.

◆ read_digitizer_data()

bool FiffStream::read_digitizer_data ( const FiffDirNode::SPtr p_Node,
FiffDigitizerData p_digData 
)

Reimplemntation of load_digitizer_data (digitizer.c)

MNE-C root function

Read the digitizer data from the given node.

Parameters
[in]p_NodeThe node of interest.
[out]p_digDataThe read digitizer data.
Returns
rue if succeeded, false otherwise.

Definition at line 812 of file fiff_stream.cpp.

◆ read_meas_info()

bool FiffStream::read_meas_info ( const FiffDirNode::SPtr p_Node,
FiffInfo p_Info,
FiffDirNode::SPtr p_NodeInfo 
)

fiff_read_meas_info

MNE toolbox root function

Read the measurement info Source is assumed to be an open fiff file.

Parameters
[in]p_NodeThe node of interest.
[out]p_InfoThe read measurement info.
[out]p_NodeInfoThe to measurement corresponding fiff_dir_node.
Returns
true if successful.

Definition at line 947 of file fiff_stream.cpp.

◆ read_meas_info_base()

bool FiffStream::read_meas_info_base ( const FiffDirNode::SPtr p_Node,
FiffInfoBase p_InfoForward 
)

python read_forward_meas_info

Read light measurement info from forward operator -> ToDo base class of FiffInfo

Parameters
[in]p_NodeThe node of interest.
[out]p_InfoForwardThe read light measurement info.
Returns
true when successful.

Definition at line 878 of file fiff_stream.cpp.

◆ read_named_matrix()

bool FiffStream::read_named_matrix ( const FiffDirNode::SPtr p_Node,
fiff_int_t  matkind,
FiffNamedMatrix mat 
)

fiff_read_named_matrix

MNE toolbox root function

Reads a named matrix.

Parameters
[in]p_NodeThe node of interest.
[in]matkindThe matrix kind to look for.
[out]matThe named matrix.
Returns
true if succeeded, false otherwise.

Definition at line 1315 of file fiff_stream.cpp.

◆ read_proj()

QList< FiffProj > FiffStream::read_proj ( const FiffDirNode::SPtr p_Node)

Read the SSP data under a given directory node Refactored: fiff_read_proj (MNE-MATLAB)

Parameters
[in]p_NodeThe node of interest.
Returns
a list of SSP projectors.

Definition at line 1417 of file fiff_stream.cpp.

◆ read_rt_tag()

bool FiffStream::read_rt_tag ( QSharedPointer< FiffTag > &  p_pTag)

Read one tag from a fif real-time stream. difference to the other read tag functions is: that this function has blocking behaviour (waitForReadyRead)

Parameters
[out]p_pTagthe read tag.
Returns
true if succeeded, false otherwise.

Definition at line 1643 of file fiff_stream.cpp.

◆ read_tag()

bool FiffStream::read_tag ( QSharedPointer< FiffTag > &  p_pTag,
fiff_long_t  pos = -1 
)

Read one tag from a fif file. if pos is not provided, reading starts from the current file position Refactored: fiff_read_tag (MNE-MATLAB)

Parameters
[out]p_pTagthe read tag.
[in]posposition of the tag inside the fif file.
Returns
true if succeeded, false otherwise.

Definition at line 1663 of file fiff_stream.cpp.

◆ read_tag_data()

bool FiffStream::read_tag_data ( QSharedPointer< FiffTag > &  p_pTag,
fiff_long_t  pos = -1 
)

Read tag data from a fif file. if pos is not provided, reading starts from the current file position Refactored: fiff_read_tag (MNE-MATLAB)

Parameters
[out]p_pTagthe read tag.
[in]posposition of the tag inside the fif file.
Returns
true if succeeded, false otherwise.

Definition at line 1563 of file fiff_stream.cpp.

◆ read_tag_info()

fiff_long_t FiffStream::read_tag_info ( QSharedPointer< FiffTag > &  p_pTag,
bool  p_bDoSkip = true 
)

Read tag information of one tag from a fif file. if pos is not provided, reading starts from the current file position Refactored: fiff_read_tag_info (MNE-MATLAB)

Parameters
[out]p_pTagthe read tag info.
[in]p_bDoSkipif true it skips the data of the tag (optional, default = true).
Returns
the position where the tag info was read from.

Definition at line 1590 of file fiff_stream.cpp.

◆ setup_read_raw()

bool FiffStream::setup_read_raw ( QIODevice &  p_IODevice,
FiffRawData data,
bool  allow_maxshield = true,
bool  is_littleEndian = false 
)
static

fiff_setup_read_raw

MNE toolbox root function

Read information about raw data file

Parameters
[in]p_IODeviceAn fiff IO device like a fiff QFile or QTCPSocket.
[out]dataThe raw data information - contains the opened fiff file.
[in]allow_maxshieldAccept unprocessed MaxShield data.
Returns
true if succeeded, false otherwise.

Definition at line 1711 of file fiff_stream.cpp.

◆ split_name_list()

QStringList FiffStream::split_name_list ( QString  p_sNameList)
static

fiff_split_name_list

MNE toolbox root function

Splits a string by looking for seperator ":"

Parameters
[in]p_sNameListstring to split.
Returns
the splitted string list.

Definition at line 1914 of file fiff_stream.cpp.

◆ start_block()

fiff_long_t FiffStream::start_block ( fiff_int_t  kind)

Writes a FIFF_BLOCK_START tag Refactored: fiff_start_block (MNE-C); fiff_start_block (MNE-MATLAB)

Parameters
[in]kindThe block kind to start.
Returns
the position where the start block struct was written to.

Definition at line 1921 of file fiff_stream.cpp.

◆ start_file()

FiffStream::SPtr FiffStream::start_file ( QIODevice &  p_IODevice)
static

Opens a fiff file for writing and writes the compulsory header tags Refactored: fiff_start_files (MNE-C); fiff_start_file (MNE-MATLAB)

Parameters
[in]p_IODeviceThe IODevice (like QFile or QTCPSocket) to open. It is recommended that the name ends with .fif.
Returns
The opened file.

Definition at line 1928 of file fiff_stream.cpp.

◆ start_writing_raw()

FiffStream::SPtr FiffStream::start_writing_raw ( QIODevice &  p_IODevice,
const FiffInfo info,
Eigen::RowVectorXd &  cals,
Eigen::MatrixXi  sel = defaultMatrixXi,
bool  bResetRange = true 
)
static

fiff_start_writing_raw

MNE toolbox root function

function [fid,cals] = fiff_start_writing_raw(name,info,sel)

Parameters
[in]p_IODeviceA fiff IO device like a fiff QFile or QTCPSocket.
[in]infoThe measurement info block of the source file.
[out]calsA copy of the calibration values.
[in]selWhich channels will be included in the output file (optional).
[in]bResetRangeFlag whether to reset the channel range to 1.0. Default is true.
Returns
the started fiff file.

Definition at line 2021 of file fiff_stream.cpp.

◆ streamName()

QString FiffStream::streamName ( )

Get the stream name

Returns
the name of the current stream.

Definition at line 121 of file fiff_stream.cpp.

◆ write_ch_info()

fiff_long_t FiffStream::write_ch_info ( const FiffChInfo ch)

Writes a channel information record to a fif file The type, cal, unit, and pos members are explained in Table 9.5 of the MNE manual Refactored: fiff_write_ch_info (MNE-C); fiff_write_ch_info (MNE-MATLAB)

Parameters
[in]chThe channel information structure to write.
Returns
the position where the channel info struct was written to.

Definition at line 2236 of file fiff_stream.cpp.

◆ write_ch_pos()

fiff_long_t FiffStream::write_ch_pos ( const FiffChPos chpos)

Writes a channel position to a fif file

Parameters
[in]chposChannel position structure to write.
Returns
the position where the channel position struct was written to.

Definition at line 2312 of file fiff_stream.cpp.

◆ write_coord_trans()

fiff_long_t FiffStream::write_coord_trans ( const FiffCoordTrans trans)

Writes a coordinate transformation structure Refactored: fiff_write_coord_trans (MNE-C); fiff_write_coord_trans (MNE-MATLAB)

Parameters
[in]transThe coordinate transfomation structure.
Returns
the position where the coordinate transformation struct was written to.

Definition at line 2340 of file fiff_stream.cpp.

◆ write_cov()

fiff_long_t FiffStream::write_cov ( const FiffCov p_FiffCov)

Write a noise covariance matrix

MNE toolbox root function

Parameters
[in]p_FiffCovThe noise covariance matrix to write.
Returns
the position where the covaraince was written to.

Definition at line 2389 of file fiff_stream.cpp.

◆ write_ctf_comp()

fiff_long_t FiffStream::write_ctf_comp ( const QList< FiffCtfComp > &  comps)

fiff_write_ctf_comp

MNE toolbox root function

Writes the CTF compensation data into a fif file

Parameters
[in]compsThe compensation data to write.
Returns
the position where the ctf compensators struct was written to.

Definition at line 2462 of file fiff_stream.cpp.

◆ write_dig_point()

fiff_long_t FiffStream::write_dig_point ( const FiffDigPoint dig)

fiff_write_dig_point

MNE toolbox root function

Writes a digitizer data point into a fif file

Parameters
[in]digThe point to write.
Returns
the position where the digitizer points struct was written to.

Definition at line 2500 of file fiff_stream.cpp.

◆ write_dir_entries()

fiff_long_t FiffStream::write_dir_entries ( const QList< FiffDirEntry::SPtr > &  dir,
fiff_long_t  pos = -1 
)

Writes a list of dir entries to a fif file, as a FIFFT_DIR_ENTRY_STRUCT Returns the postion where the structure was written to.

Parameters
[in]dirThe dir entries to write.
[in]posthe position where the entires should be written to (default -1, i.e. end of the file).
Returns
the position where the directory entries struct was written to.

Directories are composed of these structures. * typedef struct _fiffDirEntryRec { fiff_int_t kind; /**< Tag number * fiff_int_t type; /**< Data type * fiff_int_t size; /**< How many bytes * fiff_int_t pos; /**< Location in file Note: the data is located at pos + FIFFC_DATA_OFFSET * } fiffDirEntryRec,*fiffDirEntry;/**< Directory is composed of these *

/*
   Write entires to specified position

Definition at line 2560 of file fiff_stream.cpp.

◆ write_dir_pointer()

fiff_long_t FiffStream::write_dir_pointer ( fiff_int_t  dirpos,
fiff_long_t  pos = -1,
fiff_int_t  next = FIFFV_NEXT_SEQ 
)

Writes directory position pointer FIFF_DIR_POINTER Returns the postion where the structure was written to.

Parameters
[in]dirposThe directory position pointer.
[in]posthe position where the directory pointer should be written to (default -1, i.e. end of the file).
[in]nextPosition of the next tag (default = FIFFV_NEXT_SEQ).
Returns
the position where the directory position pointer was written to.

Definition at line 2531 of file fiff_stream.cpp.

◆ write_double()

fiff_long_t FiffStream::write_double ( fiff_int_t  kind,
const double *  data,
fiff_int_t  nel = 1 
)

Writes a double-precision floating point tag to a fif file Refactored: fiff_write_double (MNE-MATLAB)

Parameters
[in]kindTag kind.
[in]dataThe float data pointer.
[in]nelNumber of doubles to write (default = 1).
Returns
the position where the double struct was written to.

Definition at line 2609 of file fiff_stream.cpp.

◆ write_float()

fiff_long_t FiffStream::write_float ( fiff_int_t  kind,
const float *  data,
fiff_int_t  nel = 1 
)

Writes a single-precision floating point tag to a fif file Refactored: fiff_write_float_tag (MNE-C); fiff_write_float (MNE-MATLAB)

Parameters
[in]kindTag kind.
[in]dataThe float data pointer.
[in]nelNumber of floats to write (default = 1).
Returns
the position where the float struct was written to.

Definition at line 2628 of file fiff_stream.cpp.

◆ write_float_matrix()

fiff_long_t FiffStream::write_float_matrix ( fiff_int_t  kind,
const Eigen::MatrixXf &  mat 
)

Writes a single-precision floating-point matrix tag Refactored: fiff_write_float_matrix (MNE-C); fiff_write_float_matrix (MNE-MATLAB)

Parameters
[in]kindThe tag kind.
[in]matThe data matrix.
Returns
the position where the float matrix struct was written to.

Definition at line 2647 of file fiff_stream.cpp.

◆ write_float_sparse_ccs()

fiff_long_t FiffStream::write_float_sparse_ccs ( fiff_int_t  kind,
const Eigen::SparseMatrix< float > &  mat 
)

fiff_write_float_sparse_ccs

MNE toolbox root function

Writes a single-precision sparse (ccs) floating-point matrix tag

Parameters
[in]kindThe tag kind.
[in]matThe data matrix.
Returns
the position where the float sparse ccs matrix struct was written to.

Definition at line 2679 of file fiff_stream.cpp.

◆ write_float_sparse_rcs()

fiff_long_t FiffStream::write_float_sparse_rcs ( fiff_int_t  kind,
const Eigen::SparseMatrix< float > &  mat 
)

fiff_write_float_sparse_rcs

MNE toolbox root function

Writes a single-precision sparse (RCS) floating-point matrix tag

Parameters
[in]kindThe tag kind.
[in]matThe data matrix.
Returns
the position where the float sparse rcs matrix struct was written to.

Definition at line 2772 of file fiff_stream.cpp.

◆ write_id()

fiff_long_t FiffStream::write_id ( fiff_int_t  kind,
const FiffId id = FiffId::getDefault() 
)

Writes fiff id If the id argument is missing it will be generated here Refactored: fiff_write_this_id (MNE-C); fiff_write_id (MNE-MATLAB)

Parameters
[in]kindThe tag kind.
[in]idThe id to write.
Returns
the position where the file id struct was written to.

Definition at line 2871 of file fiff_stream.cpp.

◆ write_info_base()

fiff_long_t FiffStream::write_info_base ( const FiffInfoBase p_FiffInfoBase)

Write measurement info stored in forward solution

Parameters
[in]p_FiffInfoBaseThe measurement info.
Returns
the position where the info base struct was written to.

Definition at line 2910 of file fiff_stream.cpp.

◆ write_int()

fiff_long_t FiffStream::write_int ( fiff_int_t  kind,
const fiff_int_t *  data,
fiff_int_t  nel = 1,
fiff_int_t  next = FIFFV_NEXT_SEQ 
)

Writes a 32-bit integer tag to a fif file Refactored: fiff_write_int_tag (MNE-C); fiff_write_int (MNE-MATLAB)

Parameters
[in]kindTag kind.
[in]dataThe integer data pointer.
[in]nelNumber of integers to write (default = 1).
[in]nextPosition of the next tag (default = FIFFV_NEXT_SEQ).
Returns
the position where the int was written to.

Definition at line 2977 of file fiff_stream.cpp.

◆ write_int_matrix()

fiff_long_t FiffStream::write_int_matrix ( fiff_int_t  kind,
const Eigen::MatrixXi &  mat 
)

fiff_write_int_matrix

MNE toolbox root function

Writes a integer matrix tag

Parameters
[in]kindThe tag kind.
[in]matThe data matrix.
Returns
the position where the write_int_matrix was written to.

Definition at line 2996 of file fiff_stream.cpp.

◆ write_name_list()

fiff_long_t FiffStream::write_name_list ( fiff_int_t  kind,
const QStringList &  data 
)

fiff_write_name_list

MNE toolbox root function

Writes a colon-separated list of names

Parameters
[in]kindThe tag kind.
[in]dataAn array of names to create the list from.
Returns
the position where the name list struct was written to.

Definition at line 3031 of file fiff_stream.cpp.

◆ write_named_matrix()

fiff_long_t FiffStream::write_named_matrix ( fiff_int_t  kind,
const FiffNamedMatrix mat 
)

fiff_write_named_matrix

MNE toolbox root function

Writes a named single-precision floating-point matrix

Parameters
[in]kindThe tag kind to use for the data.
[in]matThe data matrix.
Returns
the position where the named matrix struct was written to.

Definition at line 3039 of file fiff_stream.cpp.

◆ write_proj()

fiff_long_t FiffStream::write_proj ( const QList< FiffProj > &  projs)

fiff_write_proj

MNE toolbox root function

Writes the projection data into a fif stream (file)

Parameters
[in]projsThe compensation data to write.
Returns
the position where the projector struct was written to.

Definition at line 3058 of file fiff_stream.cpp.

◆ write_raw_buffer() [1/3]

bool FIFFLIB::FiffStream::write_raw_buffer ( const Eigen::MatrixXd &  buf,
const Eigen::RowVectorXd &  cals 
)

fiff_write_raw_buffer

MNE toolbox root function

Writes a raw buffer.

Parameters
[in]bufthe buffer to write.
[in]calscalibration factors.
Returns
true if succeeded, false otherwise.

◆ write_raw_buffer() [2/3]

bool FIFFLIB::FiffStream::write_raw_buffer ( const Eigen::MatrixXd &  buf,
const Eigen::SparseMatrix< double > &  mult 
)

fiff_write_raw_buffer

MNE toolbox root function

Writes a raw buffer.

Parameters
[in]bufthe buffer to write.
[in]multthe used multiplication matrix consisting out of projection,calibration and compensation.
Returns
true if succeeded, false otherwise.

◆ write_raw_buffer() [3/3]

bool FIFFLIB::FiffStream::write_raw_buffer ( const Eigen::MatrixXd &  buf)

fiff_write_raw_buffer

Writes a raw buffer without calibrations.

Parameters
[in]bufthe buffer to write.
Returns
true if succeeded, false otherwise.

◆ write_rt_command()

void FiffStream::write_rt_command ( fiff_int_t  command,
const QString &  data 
)

Writes a real-time command

Parameters
[in]commandThe real time command.
[in]dataThe string data to write.

Definition at line 3165 of file fiff_stream.cpp.

◆ write_string()

fiff_long_t FiffStream::write_string ( fiff_int_t  kind,
const QString &  data 
)

Writes a string tag Refactored: fiff_write_string_tag (MNE-C); fiff_write_string (MNE-MATLAB)

Parameters
[in]kindThe tag kind.
[in]dataThe string data to write.
Returns
the position where the string struct was written to.

Definition at line 3147 of file fiff_stream.cpp.

◆ write_tag()

fiff_long_t FiffStream::write_tag ( const QSharedPointer< FiffTag > &  p_pTag,
fiff_long_t  pos = -1 
)

Write one tag to file including its data Data is not written if it is NULL Refactored: fiff_write_tag, fiff_write_this_tag (MNE-C)

Parameters
[in]p_pTagTag to write;.
[in]posthe position where the entires should be written to (default -1, i.e. end of the file).
Returns
the position where the tag struct was written to.

Definition at line 2199 of file fiff_stream.cpp.


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