Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | Private Attributes | List of all members
DTA2DFile Class Reference

DTA2D File adapter. More...

#include <OpenMS/FORMAT/DTA2DFile.h>

Inheritance diagram for DTA2DFile:
ProgressLogger

Public Member Functions

PeakFileOptionsgetOptions ()
 Mutable access to the options for loading/storing. More...
 
const PeakFileOptionsgetOptions () const
 Non-mutable access to the options for loading/storing. More...
 
template<typename MapType >
void load (const String &filename, MapType &map)
 Loads a map from a DTA2D file. More...
 
template<typename MapType >
void store (const String &filename, const MapType &map) const
 Stores a map in a DTA2D file. More...
 
template<typename MapType >
void storeTIC (const String &filename, const MapType &map) const
 Stores the TIC of a map in a DTA2D file. More...
 
Constructors and Destructor
 DTA2DFile ()
 Default constructor. More...
 
 ~DTA2DFile ()
 Destructor. More...
 
- Public Member Functions inherited from ProgressLogger
 ProgressLogger ()
 Constructor. More...
 
 ~ProgressLogger ()
 Destructor. More...
 
void setLogType (LogType type) const
 Sets the progress log that should be used. The default type is NONE! More...
 
LogType getLogType () const
 Returns the type of progress log being used. More...
 
void startProgress (SignedSize begin, SignedSize end, const String &label) const
 Initializes the progress display. More...
 
void setProgress (SignedSize value) const
 Sets the current progress. More...
 
void endProgress () const
 Ends the progress display. More...
 

Private Attributes

PeakFileOptions options_
 

Additional Inherited Members

- Public Types inherited from ProgressLogger
enum  LogType { CMD, GUI, NONE }
 Possible log types. More...
 
- Protected Attributes inherited from ProgressLogger
LogType type_
 
SignedSize begin_
 
SignedSize end_
 
SignedSize value_
 
QProgressDialog * dlg_
 
StopWatch stop_watch_
 
time_t last_invoke_
 
- Static Protected Attributes inherited from ProgressLogger
static int recursion_depth_
 

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::FileNotFoundis thrown if the file could not be opened
Exception::ParseErroris 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::UnableToCreateFileis 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::UnableToCreateFileis thrown if the file could not be created

References OpenMS::precisionWrapper().

Member Data Documentation

PeakFileOptions options_
private

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:30 using doxygen 1.8.5