| OpenMS 2.5.0

Public Member Functions | List of all members
KroenikFile Class Reference
Format » File IO

File adapter for Kroenik (HardKloer sibling) files. More...

`#include <OpenMS/FORMAT/KroenikFile.h>`

## Public Member Functions

| KroenikFile ()
| Default constructor. More...
virtual | ~KroenikFile ()
| Destructor. More...
void | load (const String &filename, FeatureMap &feature_map)
| Loads a Kroenik file into a featureXML. More...
template<typename SpectrumType >
void | store (const String &filename, const SpectrumType &spectrum) const
| Stores a featureXML as a Kroenik file. More...

## Detailed Description

File adapter for Kroenik (HardKloer sibling) files.

The first line is the header and contains the column names:
File, First Scan, Last Scan, Num of Scans, Charge, Monoisotopic Mass, Base Isotope Peak, Best Intensity, Summed Intensity, First RTime, Last RTime, Best RTime, Best Correlation, Modifications

Every subsequent line is a feature.

All properties in the file are converted to Feature properties, whereas "First Scan", "Last Scan", "Num of Scans" and "Modifications" are stored as metavalues with the following names "FirstScan", "LastScan", "NumOfScans" and "AveragineModifications".

The width in m/z of the overall convex hull of each feature is set to 3 Th in lack of a value provided by the Kroenik file.

Note
  Kroenik files are Tab (\t) separated files.

## Constructor & Destructor Documentation

## ◆ KroenikFile()

KroenikFile | ( |  | ) |

Default constructor.

## ◆ ~KroenikFile()

virtual ~KroenikFile | ( |  | ) |

virtual

Destructor.

## Member Function Documentation

## ◆ load()

void load | ( | const String & | filename,
|  | FeatureMap & | feature_map
| ) |  |

Loads a Kroenik file into a featureXML.

The content of the file is stored in `features`.

Exceptions

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

## ◆ store()

void store | ( | const String & | filename,
|  | const SpectrumType & | spectrum
| ) |  | const

inline

Stores a featureXML as a Kroenik file.

NOT IMPLEMENTED

Exceptions

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