OpenMS  2.5.0
Public Member Functions | List of all members
FeatureFileOptions Class Reference

Options for loading files containing features. More...

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

Public Member Functions

 FeatureFileOptions ()
 Default constructor. More...
 
 ~FeatureFileOptions ()
 Destructor. More...
 
convex hull option

sets whether or not to load convex hull

void setLoadConvexHull (bool convex)
 
bool getLoadConvexHull () const
 returns whether or not to load convex hull More...
 
subordinate option

sets whether or not load subordinates

void setLoadSubordinates (bool sub)
 
bool getLoadSubordinates () const
 returns whether or not to load subordinates More...
 
metadata option

sets whether or not to load only meta data

void setMetadataOnly (bool only)
 
bool getMetadataOnly () const
 returns whether or not to load only meta data More...
 
lazyload option

sets whether or not to load only feature count

void setSizeOnly (bool only)
 
bool getSizeOnly () const
 returns whether or not to load only meta data More...
 
RT range option

restricts the range of RT values for peaks to load

void setRTRange (const DRange< 1 > &range)
 
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

restricts the range of MZ values for peaks to load

void setMZRange (const DRange< 1 > &range)
 
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

restricts the range of intensity values for peaks to load

bool loadConvexhull_
 
bool loadSubordinates_
 
bool metadata_only_
 
bool has_rt_range_
 
bool has_mz_range_
 
bool has_intensity_range_
 
bool size_only_
 
DRange< 1 > rt_range_
 
DRange< 1 > mz_range_
 
DRange< 1 > intensity_range_
 
void setIntensityRange (const DRange< 1 > &range)
 
bool hasIntensityRange () const
 returns true if an intensity range has been set More...
 
const DRange< 1 > & getIntensityRange () const
 returns the intensity range More...
 

Detailed Description

Options for loading files containing features.

Constructor & Destructor Documentation

◆ FeatureFileOptions()

Default constructor.

◆ ~FeatureFileOptions()

Destructor.

Member Function Documentation

◆ getIntensityRange()

const DRange<1>& getIntensityRange ( ) const

returns the intensity range

◆ getLoadConvexHull()

bool getLoadConvexHull ( ) const

returns whether or not to load convex hull

◆ getLoadSubordinates()

bool getLoadSubordinates ( ) const

returns whether or not to load subordinates

◆ getMetadataOnly()

bool getMetadataOnly ( ) const

returns whether or not to load only meta data

◆ getMZRange()

const DRange<1>& getMZRange ( ) const

returns the MZ range

◆ getRTRange()

const DRange<1>& getRTRange ( ) const

returns the RT range

◆ getSizeOnly()

bool getSizeOnly ( ) const

returns whether or not to load only meta data

◆ hasIntensityRange()

bool hasIntensityRange ( ) const

returns true if an intensity range has been set

◆ hasMZRange()

bool hasMZRange ( ) const

returns true if an MZ range has been set

◆ hasRTRange()

bool hasRTRange ( ) const

returns true if an RT range has been set

◆ setIntensityRange()

void setIntensityRange ( const DRange< 1 > &  range)

◆ setLoadConvexHull()

void setLoadConvexHull ( bool  convex)

◆ setLoadSubordinates()

void setLoadSubordinates ( bool  sub)

◆ setMetadataOnly()

void setMetadataOnly ( bool  only)

◆ setMZRange()

void setMZRange ( const DRange< 1 > &  range)

◆ setRTRange()

void setRTRange ( const DRange< 1 > &  range)

◆ setSizeOnly()

void setSizeOnly ( bool  only)

Member Data Documentation

◆ has_intensity_range_

bool has_intensity_range_
private

◆ has_mz_range_

bool has_mz_range_
private

◆ has_rt_range_

bool has_rt_range_
private

◆ intensity_range_

DRange<1> intensity_range_
private

◆ loadConvexhull_

bool loadConvexhull_
private

◆ loadSubordinates_

bool loadSubordinates_
private

◆ metadata_only_

bool metadata_only_
private

◆ mz_range_

DRange<1> mz_range_
private

◆ rt_range_

DRange<1> rt_range_
private

◆ size_only_

bool size_only_
private