FeatureFileOptions Class Reference

Options for loading files containing features. More...

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

List of all members.

Public Member Functions
	FeatureFileOptions ()
	Default constructor.
	~FeatureFileOptions ()
	Destructor.
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
subordinate option
sets whether or not load subordinates
void	setLoadSubordinates (bool sub)
bool	getLoadSubordinates () const
	returns whether or not to load subordinates
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
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
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
const DRange< 1 > &	getRTRange () const
	returns the RT range
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
const DRange< 1 > &	getMZRange () const
	returns the MZ range
Intensity range option
restricts the range of intensity values for peaks to load
void	setIntensityRange (const DRange< 1 > &range)
bool	hasIntensityRange () const
	returns true if an intensity range has been set
const DRange< 1 > &	getIntensityRange () const
	returns the intensity range
Compression options
Note: This option is ignored if the format does not support compression
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	setCompression (bool compress)
bool	getCompression () const

---

Detailed Description

Options for loading files containing features.

---

Constructor & Destructor Documentation

FeatureFileOptions

(

)

Default constructor.

~FeatureFileOptions

(

)

Destructor.

---

Member Function Documentation

bool getCompression

(

)

const

const DRange<1>& getIntensityRange

(

)

const

returns the intensity range

bool getLoadConvexHull

(

)

const

returns whether or not to load convex hull

bool getLoadSubordinates

(

)

const

returns whether or not to load subordinates

bool getMetadataOnly

(

)

const

returns whether or not to load only meta data

const DRange<1>& getMZRange

(

)

const

returns the MZ range

const DRange<1>& getRTRange

(

)

const

returns the RT range

bool getSizeOnly

(

)

const

returns whether or not to load only meta data

bool hasIntensityRange

(

)

const

returns true if an intensity range has been set

bool hasMZRange

(

)

const

returns true if an MZ range has been set

bool hasRTRange

(

)

const

returns true if an RT range has been set

void setCompression

(

bool

compress

)

void setIntensityRange

(

const DRange< 1 > &

range

)

void setLoadConvexHull

(

bool

convex

)

void setLoadSubordinates

(

bool

sub

)

void setMetadataOnly

(

bool

only

)

void setMZRange

(

const DRange< 1 > &

range

)

void setRTRange

(

const DRange< 1 > &

range

)

void setSizeOnly

(

bool

only

)

---

Member Data Documentation

bool has_intensity_range_ [private]

bool has_mz_range_ [private]

bool has_rt_range_ [private]

DRange<1> intensity_range_ [private]

bool loadConvexhull_ [private]

bool loadSubordinates_ [private]

bool metadata_only_ [private]

DRange<1> mz_range_ [private]

DRange<1> rt_range_ [private]

bool size_only_ [private]