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

Options for loading files containing peak data. More...

#include <OpenMS/FORMAT/OPTIONS/PeakFileOptions.h>

Public Member Functions

 PeakFileOptions ()
 Default constructor. More...
 
 PeakFileOptions (const PeakFileOptions &)
 Copy constructor. More...
 
 ~PeakFileOptions ()
 Destructor. More...
 
Meta data option
void setMetadataOnly (bool only)
 sets whether or not to load only meta data More...
 
bool getMetadataOnly () const
 returns whether or not to load only meta data More...
 
Supplemental data option
void setWriteSupplementalData (bool write)
 sets whether or not to write supplemental peak data in MzData files More...
 
bool getWriteSupplementalData () const
 returns whether or not to write supplemental peak data in MzData files More...
 
RT range option
void setRTRange (const DRange< 1 > &range)
 restricts the range of RT values for peaks to load More...
 
bool hasRTRange () const
 returns true if an RT range has been set More...
 
const DRange< 1 > & getRTRange () const
 returns the RT range More...
 
m/z range option
void setMZRange (const DRange< 1 > &range)
 restricts the range of MZ values for peaks to load More...
 
bool hasMZRange () const
 returns true if an MZ range has been set More...
 
const DRange< 1 > & getMZRange () const
 returns the MZ range More...
 
Intensity range option
void setIntensityRange (const DRange< 1 > &range)
 restricts the range of intensity values for peaks to load More...
 
bool hasIntensityRange () const
 returns true if an intensity range has been set More...
 
const DRange< 1 > & getIntensityRange () const
 returns the intensity range More...
 
MS levels option

With this option, MS level filters can be set.

Note
The original spectrum identifiers are stored as the nativeID of the spectrum.
void setMSLevels (const std::vector< Int > &levels)
 sets the desired MS levels for peaks to load More...
 
void addMSLevel (int level)
 adds a desired MS level for peaks to load More...
 
void clearMSLevels ()
 clears the MS levels More...
 
bool hasMSLevels () const
 returns true, if MS levels have been set More...
 
bool containsMSLevel (int level) const
 returns true, if MS level level has been set More...
 
const std::vector< Int > & getMSLevels () const
 returns the set MS levels More...
 
Compression options
Note
This option is ignored if the format does not support compression
void setCompression (bool compress)
 
bool getCompression () const
 
Precision options
Note
This option is ignored if the format does not support multiple precisions
void setMz32Bit (bool mz_32_bit)
 
bool getMz32Bit () const
 
void setIntensity32Bit (bool int_32_bit)
 
bool getIntensity32Bit () const
 

Private Attributes

bool metadata_only_
 
bool write_supplemental_data_
 
bool has_rt_range_
 
bool has_mz_range_
 
bool has_intensity_range_
 
bool mz_32_bit_
 
bool int_32_bit_
 
DRange< 1 > rt_range_
 
DRange< 1 > mz_range_
 
DRange< 1 > intensity_range_
 
std::vector< Intms_levels_
 
bool zlib_compression_
 

Detailed Description

Options for loading files containing peak data.

Constructor & Destructor Documentation

Default constructor.

Copy constructor.

Destructor.

Member Function Documentation

void addMSLevel ( int  level)

adds a desired MS level for peaks to load

void clearMSLevels ( )

clears the MS levels

bool containsMSLevel ( int  level) const

returns true, if MS level level has been set

bool getCompression ( ) const
bool getIntensity32Bit ( ) const
const DRange<1>& getIntensityRange ( ) const

returns the intensity range

Referenced by DBAdapter::loadSpectrum().

bool getMetadataOnly ( ) const

returns whether or not to load only meta data

Referenced by DBAdapter::loadExperiment().

const std::vector<Int>& getMSLevels ( ) const

returns the set MS levels

Referenced by DBAdapter::loadExperiment().

bool getMz32Bit ( ) const
const DRange<1>& getMZRange ( ) const

returns the MZ range

Referenced by DBAdapter::loadSpectrum().

const DRange<1>& getRTRange ( ) const

returns the RT range

Referenced by DBAdapter::loadExperiment().

bool getWriteSupplementalData ( ) const

returns whether or not to write supplemental peak data in MzData files

bool hasIntensityRange ( ) const

returns true if an intensity range has been set

Referenced by DBAdapter::loadSpectrum().

bool hasMSLevels ( ) const

returns true, if MS levels have been set

Referenced by DBAdapter::loadExperiment().

bool hasMZRange ( ) const

returns true if an MZ range has been set

Referenced by DBAdapter::loadSpectrum().

bool hasRTRange ( ) const

returns true if an RT range has been set

Referenced by DBAdapter::loadExperiment().

void setCompression ( bool  compress)
void setIntensity32Bit ( bool  int_32_bit)
void setIntensityRange ( const DRange< 1 > &  range)

restricts the range of intensity values for peaks to load

void setMetadataOnly ( bool  only)

sets whether or not to load only meta data

Referenced by TOPPViewBase::metadataDatabaseDialog(), and TOPPViewBase::metadataFileDialog().

void setMSLevels ( const std::vector< Int > &  levels)

sets the desired MS levels for peaks to load

void setMz32Bit ( bool  mz_32_bit)
void setMZRange ( const DRange< 1 > &  range)

restricts the range of MZ values for peaks to load

void setRTRange ( const DRange< 1 > &  range)

restricts the range of RT values for peaks to load

void setWriteSupplementalData ( bool  write)

sets whether or not to write supplemental peak data in MzData files

Member Data Documentation

bool has_intensity_range_
private
bool has_mz_range_
private
bool has_rt_range_
private
bool int_32_bit_
private
DRange<1> intensity_range_
private
bool metadata_only_
private
std::vector<Int> ms_levels_
private
bool mz_32_bit_
private
DRange<1> mz_range_
private
DRange<1> rt_range_
private
bool write_supplemental_data_
private
bool zlib_compression_
private

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