RangeManager< D > Class Template Reference

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

#include <OpenMS/KERNEL/RangeManager.h>

Public Types
enum	{ DIMENSION = D }
	Dimension of the position range. More...
typedef DRange< D >	PositionRangeType
	Position range type. More...
typedef DPosition< D >	PositionType
	Position Type. More...
typedef DRange< 1 >	IntensityRangeType
	Intensity range type. More...

Public Member Functions
	RangeManager ()
	Default constructor. More...
	RangeManager (const RangeManager &rhs)
	Copy constructor. More...
virtual	~RangeManager ()
	Destructor. More...
RangeManager &	operator= (const RangeManager &rhs)
	Assignment operator. More...
bool	operator== (const RangeManager &rhs) const
	Equality operator. More...
bool	operator!= (const RangeManager &rhs) const
	Equality operator. More...
Range methods
Note The range values are not updated automatically. Call updateRanges() to update the values!
const PositionType &	getMin () const
	Returns the minimum position. More...
const PositionType &	getMax () const
	Returns the maximum position. More...
double	getMinInt () const
	Returns the minimum intensity. More...
double	getMaxInt () const
	Returns the maximum intensity. More...
virtual void	updateRanges ()=0
	Updates minimum and maximum position/intensity. More...
void	clearRanges ()
	Resets the ranges. More...

Protected Member Functions
template<class PeakIteratorType >
void	updateRanges_ (const PeakIteratorType &begin, const PeakIteratorType &end)
	Updates the range using data points in the iterator range. More...

Protected Attributes
IntensityRangeType	int_range_
	Intensity range (1-dimensional) More...
PositionRangeType	pos_range_
	Position range (D-dimensional) More...

Detailed Description

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

Handles the management 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 ( )

inlinevirtual

Destructor.

Member Function Documentation

void clearRanges ( )

inline

Resets the ranges.

const PositionType& getMax ( ) const

inline

Returns the maximum position.

double getMaxInt ( ) const

inline

Returns the maximum intensity.

const PositionType& getMin ( ) const

inline

Returns the minimum position.

double 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.

Referenced by MSChromatogram< ChromatogramPeakType >::operator=(), and MSSpectrum< RichPeak1D >::operator=().

bool operator== ( const RangeManager< D > &  rhs ) const

inline

Equality operator.

Referenced by RangeManager< 2 >::operator!=(), MSChromatogram< ChromatogramPeakType >::operator==(), and MSSpectrum< RichPeak1D >::operator==().

virtual void updateRanges ( )

pure virtual

Updates minimum and maximum position/intensity.

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

Implemented in MSExperiment< PeakT, ChromatogramPeakT >, MSExperiment< OpenMS::Peak1D >, MSExperiment< Peak1D >, MSExperiment<>, MSExperiment< SimPointType >, MSSpectrum< PeakT >, MSSpectrum< PeakType >, MSSpectrum< OpenMS::Peak2D >, MSSpectrum< Peak1D >, MSSpectrum< RichPeak1D >, ConsensusMap, FeatureMap, MSChromatogram< PeakT >, and MSChromatogram< ChromatogramPeakType >.

void updateRanges_ ( const PeakIteratorType &  begin, const PeakIteratorType &  end  )

inlineprotected

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=(), and RangeManager< 2 >::operator==().

PositionRangeType pos_range_

protected

Position range (D-dimensional)

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