Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

DTA2DFile Class Reference
[File IO]

#include <OpenMS/FORMAT/DTA2DFile.h>

Inheritance diagram for DTA2DFile:

ProgressLogger

List of all members.


Detailed Description

DTA2D File adapter.

File adapter for files with three tab/space-separated columns.

The default format is: retention time (seconds) , m/z , intensity.

If the first line starts with '#', a different order is defined by the the order of the keywords 'MIN' (retention time in minutes) or 'SEC' (retention time in seconds), 'MZ', and 'INT'.

Example: '#MZ MIN INT'

The peaks of one retention time have to be in subsequent lines.

Public Member Functions

PeakFileOptionsgetOptions ()
 Mutable access to the options for loading/storing.
const PeakFileOptionsgetOptions () const
 Non-mutable access to the options for loading/storing.
template<typename MapType>
void load (const String &filename, MapType &map) throw (Exception::FileNotFound, Exception::ParseError)
 Loads a map from a DTA2D file.
template<typename MapType>
void store (const String &filename, const MapType &map) const throw (Exception::UnableToCreateFile)
 Stores a map in a DTA2D file.
Constructors and Destructor


 DTA2DFile ()
 Default constructor.
 ~DTA2DFile ()
 Destructor.

Private Attributes

PeakFileOptions options_


Constructor & Destructor Documentation

DTA2DFile (  ) 

Default constructor.

~DTA2DFile (  ) 

Destructor.


Member Function Documentation

PeakFileOptions& getOptions (  ) 

Mutable access to the options for loading/storing.

const PeakFileOptions& getOptions (  )  const

Non-mutable access to the options for loading/storing.

void load ( const String filename,
MapType &  map 
) throw (Exception::FileNotFound, Exception::ParseError) [inline]

Loads a map from a DTA2D file.

map has to be a MSExperiment or have the same interface.

void store ( const String filename,
const MapType &  map 
) const throw (Exception::UnableToCreateFile) [inline]

Stores a map in a DTA2D file.

map has to be a MSExperiment or have the same interface.


Member Data Documentation

PeakFileOptions options_ [private]


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:44 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1