FeatureFileOptions Class Reference

Options for loading files containing features. More...

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

Collaboration diagram for FeatureFileOptions:

Public Member Functions
	FeatureFileOptions ()
	Default constructor; see class brief for the default option values.
	~FeatureFileOptions ()
	Destructor.
Convex-hull option
Set whether to load each feature's convex hull (default true).
void	setLoadConvexHull (bool convex)
bool	getLoadConvexHull () const
	Whether to load each feature's convex hull.
Subordinate option
Set whether to load a feature's subordinates (default true).
void	setLoadSubordinates (bool sub)
bool	getLoadSubordinates () const
	Whether to load a feature's subordinates.
Metadata-only option
Set whether to skip the per-feature payload and load only metadata (default false).
void	setMetadataOnly (bool only)
bool	getMetadataOnly () const
	Whether only metadata is loaded.
Size-only option
Set whether to read just the feature count and skip the actual features (default false).
void	setSizeOnly (bool only)
bool	getSizeOnly () const
	Whether to read just the feature count.
RT-range option
Restrict loaded features to the given RT range. Also marks the range as set (hasRTRange returns true afterwards).
void	setRTRange (const DRange< 1 > &range)
bool	hasRTRange () const
	true if setRTRange has been called.
const DRange< 1 > &	getRTRange () const
	The configured RT range; only meaningful when hasRTRange is true.
m/z range option
Restrict loaded features to the given m/z range. Also marks the range as set (hasMZRange returns true afterwards).
void	setMZRange (const DRange< 1 > &range)
bool	hasMZRange () const
	true if setMZRange has been called.
const DRange< 1 > &	getMZRange () const
	The configured m/z range; only meaningful when hasMZRange is true.
Intensity-range option
Restrict loaded features to the given intensity range. Also marks the range as set (hasIntensityRange returns true afterwards).
void	setIntensityRange (const DRange< 1 > &range)
bool	hasIntensityRange () const
	true if setIntensityRange has been called.
const DRange< 1 > &	getIntensityRange () const
	The configured intensity range; only meaningful when hasIntensityRange is true.

Private Attributes
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_

Detailed Description

Options for loading files containing features.

A passive value object: each setter stores its value, each getter returns the stored value. The defaults loaded by the constructor are loadConvexHull == true, loadSubordinates == true, metadataOnly == false, sizeOnly == false, and no RT / m/z / intensity range set (i.e. the has*Range queries return false).

Reader implementations interpret these options. The has*Range flags indicate whether a range was ever supplied – getRTRange / getMZRange / getIntensityRange only return a meaningful range when the corresponding has*Range is true.

Constructor & Destructor Documentation

FeatureFileOptions()

FeatureFileOptions

(

)

Default constructor; see class brief for the default option values.

~FeatureFileOptions()

~FeatureFileOptions

(

)

Destructor.

Member Function Documentation

getIntensityRange()

const DRange< 1 > & getIntensityRange

(

)

const

The configured intensity range; only meaningful when hasIntensityRange is true.

getLoadConvexHull()

bool getLoadConvexHull

(

)

const

Whether to load each feature's convex hull.

getLoadSubordinates()

bool getLoadSubordinates

(

)

const

Whether to load a feature's subordinates.

getMetadataOnly()

bool getMetadataOnly

(

)

const

Whether only metadata is loaded.

getMZRange()

const DRange< 1 > & getMZRange

(

)

const

The configured m/z range; only meaningful when hasMZRange is true.

getRTRange()

const DRange< 1 > & getRTRange

(

)

const

The configured RT range; only meaningful when hasRTRange is true.

getSizeOnly()

bool getSizeOnly

(

)

const

Whether to read just the feature count.

hasIntensityRange()

bool hasIntensityRange

(

)

const

true if setIntensityRange has been called.

hasMZRange()

bool hasMZRange

(

)

const

true if setMZRange has been called.

hasRTRange()

bool hasRTRange

(

)

const

true if setRTRange has been called.

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