RangeManager< D > Class Template Reference

Handles the managment of a position and intensity range. More...

#include <OpenMS/KERNEL/RangeManager.h>

List of all members.

Public Types
enum	{ DIMENSION = D }
	Dimension of the position range. More...
typedef DRange< D >	PositionRangeType
	Position range type.
typedef DPosition< D >	PositionType
	Position Type.
typedef DRange< 1 >	IntensityRangeType
	Intensity range type.
Public Member Functions
	RangeManager ()
	Default constructor.
	RangeManager (const RangeManager &rhs)
	Copy constructor.
virtual	~RangeManager ()
	Destructor.
RangeManager &	operator= (const RangeManager &rhs)
	Assignment operator.
bool	operator== (const RangeManager &rhs) const
	Equality operator.
bool	operator!= (const RangeManager &rhs) const
	Equality operator.
Range methods
Note: The range values are not updated automatically. Call updateRanges() to update the values!
const PositionType &	getMin () const
	Returns the minimum position.
const PositionType &	getMax () const
	Returns the maximum position.
DoubleReal	getMinInt () const
	Returns the minimum intensity.
DoubleReal	getMaxInt () const
	Returns the maximum intensity.
virtual void	updateRanges ()=0
	Updates minimum and maximum position/intensity.
void	clearRanges ()
	Resets the ranges.
Protected Member Functions
template<class PeakIteratorType >
void	updateRanges_ (const PeakIteratorType &begin, const PeakIteratorType &end)
	Updates the range using data points in the iterator range.
Protected Attributes
IntensityRangeType	int_range_
	Intensity range (1-dimensional).
PositionRangeType	pos_range_
	Position range (D-dimensional).

---

Detailed Description

template<UInt D>
class OpenMS::RangeManager< D >

Handles the managment of a position and intensity range.

This is needed for all peak and feature container like Spectrum, MSExperiment and FeatureMap.

---

Member Typedef Documentation

typedef DRange<1> IntensityRangeType

Intensity range type.

typedef DRange<D> PositionRangeType

Position range type.

typedef DPosition<D> PositionType

Position Type.

---

Member Enumeration Documentation

anonymous enum

Dimension of the position range.

Enumerator:

DIMENSION

---

Constructor & Destructor Documentation

RangeManager

(

)

[inline]

Default constructor.

RangeManager

(

const RangeManager< D > &

rhs

)

[inline]

Copy constructor.

virtual ~RangeManager

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

void clearRanges

(

)

[inline]

Resets the ranges.

const PositionType& getMax

(

)

const [inline]

Returns the maximum position.

Referenced by FeatureFinderAlgorithmIsotopeWavelet< PeakType, FeatureType >::run().

DoubleReal getMaxInt

(

)

const [inline]

Returns the maximum intensity.

const PositionType& getMin

(

)

const [inline]

Returns the minimum position.

Referenced by FeatureFinderAlgorithmIsotopeWavelet< PeakType, FeatureType >::run().

DoubleReal getMinInt

(

)

const [inline]

Returns the minimum intensity.

bool operator!=

(

const RangeManager< D > &

rhs

)

const [inline]

Equality operator.

RangeManager& operator=

(

const RangeManager< D > &

rhs

)

[inline]

Assignment operator.

bool operator==

(

const RangeManager< D > &

rhs

)

const [inline]

Equality operator.

Referenced by RangeManager< 2 >::operator!=().

virtual void updateRanges

(

)

[pure virtual]

Updates minimum and maximum position/intensity.

This method is usually implemented by calling clearRanges() and updateRanges_().

void updateRanges_	(	const PeakIteratorType &	begin,
		const PeakIteratorType &	end
	)			[inline, protected]

Updates the range using data points in the iterator range.

---

Member Data Documentation

IntensityRangeType int_range_ [protected]

Intensity range (1-dimensional).

Referenced by RangeManager< 2 >::clearRanges(), RangeManager< 2 >::getMaxInt(), RangeManager< 2 >::getMinInt(), RangeManager< 2 >::operator=(), RangeManager< 2 >::operator==(), and RangeManager< 2 >::updateRanges_().

PositionRangeType pos_range_ [protected]

Position range (D-dimensional).

Referenced by RangeManager< 2 >::clearRanges(), RangeManager< 2 >::getMax(), RangeManager< 2 >::getMin(), RangeManager< 2 >::operator=(), RangeManager< 2 >::operator==(), and RangeManager< 2 >::updateRanges_().