Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | Private Attributes

DTA2DFile Class Reference
[File IO]

DTA2D File adapter. More...

#include <OpenMS/FORMAT/DTA2DFile.h>

Inheritance diagram for DTA2DFile:
ProgressLogger

List of all members.

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)
 Loads a map from a DTA2D file.
template<typename MapType >
void store (const String &filename, const MapType &map) const
 Stores a map in a DTA2D file.
template<typename MapType >
void storeTIC (const String &filename, const MapType &map) const
 Stores the TIC of a map in a DTA2D file.
Constructors and Destructor

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

Private Attributes

PeakFileOptions options_

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.


Constructor & Destructor Documentation

DTA2DFile (  ) 

Default constructor.

~DTA2DFile (  ) 

Destructor.


Member Function Documentation

PeakFileOptions& getOptions (  ) 

Mutable access to the options for loading/storing.

Referenced by FileHandler::loadExperiment(), and FileHandler::storeExperiment().

const PeakFileOptions& getOptions (  )  const

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

void load ( const String filename,
MapType &  map 
) [inline]

Loads a map from a DTA2D file.

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

Exceptions:
Exception::FileNotFound is thrown if the file could not be opened
Exception::ParseError is thrown if an error occurs during parsing

References String::has(), String::hasPrefix(), String::split(), String::substr(), and String::trim().

Referenced by FileHandler::loadExperiment().

void store ( const String filename,
const MapType &  map 
) const [inline]

Stores a map in a DTA2D file.

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

Exceptions:
Exception::UnableToCreateFile is thrown if the file could not be created

References OpenMS::precisionWrapper().

Referenced by FileHandler::storeExperiment().

void storeTIC ( const String filename,
const MapType &  map 
) const [inline]

Stores the TIC of a map in a DTA2D file.

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

Exceptions:
Exception::UnableToCreateFile is thrown if the file could not be created

References OpenMS::precisionWrapper().


Member Data Documentation


OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:53 using doxygen 1.7.1