OpenMS
RangeIntensity Struct Reference

#include <OpenMS/KERNEL/RangeManager.h>

Inheritance diagram for RangeIntensity:
[legend]
Collaboration diagram for RangeIntensity:
[legend]

Public Member Functions

void extendIntensity (const double value)
 extend the range such that it includes the given value More...
 
bool containsIntensity (const double value) const
 is value within [min, max]? More...
 
bool containsIntensity (const RangeBase &inner_range) const
 is the range inner_range within [min, max] of this range? More...
 
 RangeBase ()=default
 C'tor: initialize with empty range. More...
 
 RangeBase (const double single)
 Cutom C'tor which sets the range to a singular point. More...
 
 RangeBase (const double min, const double max)
 
 RangeBase (const RangeBase &rhs)=default
 Copy C'tor. More...
 
 RangeBase (RangeBase &&rhs) noexcept=default
 Move C'tor (seems useless, but is required for completeness in derived classes' move c'tor) More...
 
Accessors for min and max

We use accessors, to keep range consistent (i.e. ensure that min <= max)

void setMinIntensity (const double min)
 sets the minimum (and the maximum, if uninitialized) More...
 
void setMaxIntensity (const double max)
 sets the maximum (and the minimum, if uninitialized) More...
 
double getMinIntensity () const
 only useful if isEmpty() returns false More...
 
double getMaxIntensity () const
 only useful if isEmpty() returns false More...
 
- Public Member Functions inherited from RangeBase
 RangeBase ()=default
 C'tor: initialize with empty range. More...
 
 RangeBase (const double single)
 Cutom C'tor which sets the range to a singular point. More...
 
 RangeBase (const double min, const double max)
 
 RangeBase (const RangeBase &rhs)=default
 Copy C'tor. More...
 
 RangeBase (RangeBase &&rhs) noexcept=default
 Move C'tor (seems useless, but is required for completeness in derived classes' move c'tor) More...
 
RangeBaseoperator= (const RangeBase &rhs)=default
 Assignment operator. More...
 
RangeBaseoperator= (RangeBase &&rhs) noexcept=default
 Move assignment (seems useless, but is required for completeness in derived classes' move c'tor) More...
 
 ~RangeBase () noexcept=default
 D'tor. More...
 
 operator RangeRT () const
 
 operator RangeMZ () const
 
 operator RangeIntensity () const
 
 operator RangeMobility () const
 
void clear ()
 make the range empty, i.e. isEmpty() will be true More...
 
bool isEmpty () const
 is the range empty (i.e. min > max)? More...
 
bool contains (const double value) const
 is value within [min, max]? More...
 
bool contains (const RangeBase &inner_range) const
 is the range inner_range within [min, max]? More...
 
void extend (const RangeBase &other)
 ensure the range includes the range of other More...
 
void extend (const double value)
 extend the range such that it includes the given value More...
 
void extendLeftRight (const double by)
 
void minSpanIfSingular (const double min_span)
 If the current range is a single point, e.g. min==max, then extend the range by min_span / 2 on either side. More...
 
void clampTo (const RangeBase &other)
 
void pushInto (const RangeBase &sandbox)
 
void scaleBy (const double factor)
 Scale the range of the dimension by a factor. A factor > 1 increases the range; factor < 1 decreases it. More...
 
void shift (const double distance)
 
double center () const
 
double getSpan () const
 
bool operator== (const RangeBase &rhs) const
 
std::pair< double, double > getNonEmptyRange () const
 Return the current range, or (if empty) a full range (-1e308, 1e308). More...
 
void setMin (const double min)
 sets the minimum (and the maximum, if uninitialized) More...
 
void setMax (const double max)
 sets the maximum (and the minimum, if uninitialized) More...
 
double getMin () const
 only useful if isEmpty() returns false More...
 
double getMax () const
 only useful if isEmpty() returns false More...
 

Static Public Attributes

static const MSDim DIM = MSDim::INT
 

Additional Inherited Members

- Protected Attributes inherited from RangeBase
double min_ = std::numeric_limits<double>::max()
 
double max_ = std::numeric_limits<double>::lowest()
 

Member Function Documentation

◆ containsIntensity() [1/2]

bool containsIntensity ( const double  value) const
inline

is value within [min, max]?

References RangeBase::contains().

◆ containsIntensity() [2/2]

bool containsIntensity ( const RangeBase inner_range) const
inline

is the range inner_range within [min, max] of this range?

References RangeBase::contains().

◆ extendIntensity()

void extendIntensity ( const double  value)
inline

extend the range such that it includes the given value

◆ getMaxIntensity()

double getMaxIntensity ( ) const
inline

only useful if isEmpty() returns false

◆ getMinIntensity()

double getMinIntensity ( ) const
inline

only useful if isEmpty() returns false

◆ RangeBase() [1/5]

RangeBase
default

C'tor: initialize with empty range.

◆ RangeBase() [2/5]

RangeBase
inline

Custom C'tor to set min and max

Exceptions
Exception::InvalidRangeif min > max

◆ RangeBase() [3/5]

RangeBase
inline

Cutom C'tor which sets the range to a singular point.

◆ RangeBase() [4/5]

RangeBase
default

Copy C'tor.

◆ RangeBase() [5/5]

RangeBase
defaultnoexcept

Move C'tor (seems useless, but is required for completeness in derived classes' move c'tor)

◆ setMaxIntensity()

void setMaxIntensity ( const double  max)
inline

sets the maximum (and the minimum, if uninitialized)

◆ setMinIntensity()

void setMinIntensity ( const double  min)
inline

sets the minimum (and the maximum, if uninitialized)

Member Data Documentation

◆ DIM

const MSDim DIM = MSDim::INT
static