FileIO Class Reference

#include <fileio.h>

Inherits FileIOTrace.

Public Types
typedef STD_map< Protocol, Data< float, 4 > >	ProtocolDataMap

Static Public Member Functions
static int	autoread (ProtocolDataMap &pdmap, const STD_string &filename, const FileReadOpts &opts, const Protocol &protocol_template, ProgressMeter *progmeter=0)
static int	autowrite (const ProtocolDataMap &pdmap, const STD_string &filename, const FileWriteOpts &opts)
static svector	autoformats ()
static STD_string	autoformats_str (const STD_string &indent="")

Detailed Description

Structure to accomodate autoread/autwrite functionality. Please refer to (Input/Output of medical image data (odindata library) ) for a detailed description of this module.

Definition at line 82 of file fileio.h.

Member Typedef Documentation

ProtocolDataMap

typedef STD_map<Protocol, Data<float,4> > FileIO::ProtocolDataMap

Type to associate protocols with tempo-spatial raw data via std::map

Definition at line 89 of file fileio.h.

Member Function Documentation

autoformats()

static svector FileIO::autoformats ( )

static

Returns possible file formats/extensions to autoread autowrite

autoformats_str()

static STD_string FileIO::autoformats_str ( const STD_string &  indent = "" )

static

Returns possible file formats as string with comment

autoread()

static int FileIO::autoread ( ProtocolDataMap &  pdmap, const STD_string &  filename, const FileReadOpts &  opts, const Protocol &  protocol_template, ProgressMeter *  progmeter = 0  )

static

Reads in file 'filename' and appends all data sets found to protocol-data map 'pdmap', autodetects file format according to file extension. Read options are given by 'opts' and 'protocol_template' contains defaults used by the decoder/encoder of the particular file format. The progress meter 'progmeter' can be optionally specified to monitor the progress of the operation. Returns number of slices, or -1 if it fails.

autowrite()

static int FileIO::autowrite ( const ProtocolDataMap &  pdmap, const STD_string &  filename, const FileWriteOpts &  opts  )

static

Writes out protocol-data map 'pdmap' to file(s) filename, autodetects file format according to file extension. Write options are given by 'opts'. Returns number of slices successfully written, or -1 if it fails.

---

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

• fileio.h