DGtal::functors::Rescaling< TInputType, TOutputType > Struct Template Reference

Aim: Functor allowing to rescale a value. Values of the initial scale [initMin,initMax] are rescaled to the new scale [newMin,newMax]. More...

#include <DGtal/base/BasicFunctors.h>

Public Member Functions
	Rescaling (const TInputType &initMin, const TInputType &initMax, const TOutputType &newMin, const TOutputType &newMax)
TOutputType	operator() (const TInputType &anInitVal) const

Data Fields
TInputType	myInitMin
TInputType	myInitMax
TInputType	myInitRange
TOutputType	myNewMin
TOutputType	myNewMax
TOutputType	myNewRange

Detailed Description

template<typename TInputType, typename TOutputType>
struct DGtal::functors::Rescaling< TInputType, TOutputType >

Aim: Functor allowing to rescale a value. Values of the initial scale [initMin,initMax] are rescaled to the new scale [newMin,newMax].

Description of template class 'Rescaling'

Template Parameters

TInputType	the type of values on the inital scale.
TOutputType	the type of values on the new scale.

Definition at line 905 of file BasicFunctors.h.

Constructor & Destructor Documentation

Rescaling()

template<typename TInputType , typename TOutputType >

DGtal::functors::Rescaling< TInputType, TOutputType >::Rescaling ( const TInputType &  initMin, const TInputType &  initMax, const TOutputType &  newMin, const TOutputType &  newMax  )

inline

Constructor.

Parameters

initMin	the minimum value of the initial scale. Lower values are set to this value.
initMax	the maximum value of the initial scale. Greater values are set to this value.
newMin	the minimum value of the new scale.
newMax	the maximum value of the new scale.

Definition at line 923 of file BasicFunctors.h.

                                                                                                                              :
                          myInitMin(initMin), myInitMax(initMax), myInitRange(initMax-initMin), myNewMin(newMin), myNewMax(newMax), myNewRange(newMax-newMin) {}

Member Function Documentation

operator()()

template<typename TInputType , typename TOutputType >

TOutputType DGtal::functors::Rescaling< TInputType, TOutputType >::operator() ( const TInputType &  anInitVal ) const

inline

Operator.

Parameters

anInitVal

value of the initial scale.

Returns

value of anInitVal, considered on the initial scale, on the new scale.

Definition at line 934 of file BasicFunctors.h.

      { return anInitVal<myInitMin ? myNewMin : anInitVal > myInitMax ? myNewMax : (anInitVal-myInitMin)*myNewRange/myInitRange + myNewMin; }

References DGtal::functors::Rescaling< TInputType, TOutputType >::myInitMax, DGtal::functors::Rescaling< TInputType, TOutputType >::myInitMin, DGtal::functors::Rescaling< TInputType, TOutputType >::myInitRange, DGtal::functors::Rescaling< TInputType, TOutputType >::myNewMax, DGtal::functors::Rescaling< TInputType, TOutputType >::myNewMin, and DGtal::functors::Rescaling< TInputType, TOutputType >::myNewRange.

Field Documentation

myInitMax

template<typename TInputType , typename TOutputType >

TInputType DGtal::functors::Rescaling< TInputType, TOutputType >::myInitMax

Definition at line 908 of file BasicFunctors.h.

Referenced by DGtal::functors::Rescaling< TInputType, TOutputType >::operator()().

myInitMin

template<typename TInputType , typename TOutputType >

TInputType DGtal::functors::Rescaling< TInputType, TOutputType >::myInitMin

Definition at line 907 of file BasicFunctors.h.

Referenced by DGtal::functors::Rescaling< TInputType, TOutputType >::operator()().

myInitRange

template<typename TInputType , typename TOutputType >

TInputType DGtal::functors::Rescaling< TInputType, TOutputType >::myInitRange

Definition at line 909 of file BasicFunctors.h.

Referenced by DGtal::functors::Rescaling< TInputType, TOutputType >::operator()().

myNewMax

template<typename TInputType , typename TOutputType >

TOutputType DGtal::functors::Rescaling< TInputType, TOutputType >::myNewMax

Definition at line 912 of file BasicFunctors.h.

Referenced by DGtal::functors::Rescaling< TInputType, TOutputType >::operator()().

myNewMin

template<typename TInputType , typename TOutputType >

TOutputType DGtal::functors::Rescaling< TInputType, TOutputType >::myNewMin

Definition at line 911 of file BasicFunctors.h.

Referenced by DGtal::functors::Rescaling< TInputType, TOutputType >::operator()().

myNewRange

template<typename TInputType , typename TOutputType >

TOutputType DGtal::functors::Rescaling< TInputType, TOutputType >::myNewRange

Definition at line 913 of file BasicFunctors.h.

Referenced by DGtal::functors::Rescaling< TInputType, TOutputType >::operator()().

---

The documentation for this struct was generated from the following file:

• BasicFunctors.h