#include <DGtal/io/colormaps/SimpleDistanceColorMap.h>

Public Types
typedef TValue	Value

Public Member Functions
	SimpleDistanceColorMap (const SimpleDistanceColorMap &other)

SimpleDistanceColorMap &	operator= (const SimpleDistanceColorMap &anOther)

	SimpleDistanceColorMap (const Value &amin, const Value &amax, const bool withTick=true)

Color	operator() (const Value &aValue) const

void	selfDisplay (std::ostream &out) const

bool	isValid () const

const Value &	min () const

const Value &	max () const

Protected Member Functions
	SimpleDistanceColorMap ()

Protected Attributes
Value	myMin

Value	myMax

bool	myTick

Detailed Description

template<typename TValue>
class DGtal::SimpleDistanceColorMap< TValue >

Aim: simple blue to red colormap for distance information for instance.

Description of class 'SimpleDistanceColorMap'

Color formula from a fragment shader in https://github.com/dgpdec/course.

Template Parameters

TValue the value type

Definition at line 64 of file SimpleDistanceColorMap.h.

Member Typedef Documentation

template<typename TValue>

typedef TValue DGtal::SimpleDistanceColorMap< TValue >::Value

Value type.

Definition at line 70 of file SimpleDistanceColorMap.h.

Constructor & Destructor Documentation

template<typename TValue>

DGtal::SimpleDistanceColorMap< TValue >::SimpleDistanceColorMap ( const SimpleDistanceColorMap< TValue > & other )

Copy constructor.

Parameters

[in] other the object to clone. Forbidden by default.

template<typename TValue>

DGtal::SimpleDistanceColorMap< TValue >::SimpleDistanceColorMap	(	const Value &	amin,
		const Value &	amax,
		const bool	withTick = `true`
	)

inline

Constructor from two min and max values.

Parameters

[in]	amin	the minimum value of the range.
[in]	amax	the maximum value of the range.
[in]	withTick	if true, white ticks are displayed (default true).

Definition at line 95 of file SimpleDistanceColorMap.h.

                                                     :
     myMin(amin), myMax(amax), myTick(withTick)
     {}

template<typename TValue>

DGtal::SimpleDistanceColorMap< TValue >::SimpleDistanceColorMap ( )

protected

Constructor. Forbidden by default (protected to avoid g++ warnings).

Member Function Documentation

template<typename TValue>

bool DGtal::SimpleDistanceColorMap< TValue >::isValid ( ) const

inline

Checks the validity/consistency of the object.

Returns: 'true' if the object is valid, 'false' otherwise.

Definition at line 151 of file SimpleDistanceColorMap.h.

151 { return true;}

template<typename TValue>

const Value& DGtal::SimpleDistanceColorMap< TValue >::max ( ) const

inline

Returns the upper bound of the value range.

Returns: The upper bound of the value range.

Definition at line 168 of file SimpleDistanceColorMap.h.

References DGtal::SimpleDistanceColorMap< TValue >::myMax.

     {
       return myMax;
     }

template<typename TValue>

const Value& DGtal::SimpleDistanceColorMap< TValue >::min ( ) const

inline

Returns the lower bound of the value range.

Returns: The lower bound of the value range.

Definition at line 158 of file SimpleDistanceColorMap.h.

References DGtal::SimpleDistanceColorMap< TValue >::myMin.

     {
       return myMin;
     }

template<typename TValue>

Color DGtal::SimpleDistanceColorMap< TValue >::operator() ( const Value & aValue ) const

inline

Computes the color associated with a value.

Parameters

[in] aValue A value within the value range.

Returns: A color.

Definition at line 109 of file SimpleDistanceColorMap.h.

References DGtal::NumberTraits< T >::castToDouble(), DGtal::SimpleDistanceColorMap< TValue >::myMax, DGtal::SimpleDistanceColorMap< TValue >::myMin, and DGtal::SimpleDistanceColorMap< TValue >::myTick.

     {
       const double val = (NumberTraits<Value>::castToDouble(aValue) - NumberTraits<Value>::castToDouble(myMin))/
       (NumberTraits<Value>::castToDouble(myMax) - NumberTraits<Value>::castToDouble(myMin));
       const double d = 1. - val;
       double r = (1. - d*d) * .8;
       double g = (1. - (2. * (d - .5)) * (2. * (d - .5))) * .7;
       double b = (1. - (1. - d) * (1. - d));
       
       // lines
       if (myTick)
       {
         double h = val;
         h = h * 30.;
         h = h - floor( h );
         h = (1. / (1. + exp(-100.*(h - .55)))) + (1. / (1. + exp(-100.*(-h + .45))));
         h = 1. - h;
         r = h + (1. -h)*r;
         g = h + (1. - h)*g;
         b = h + (1. - h)*b;
       }
       
       return Color(static_cast<unsigned char>(r*255),
                    static_cast<unsigned char>(g*255),
                    static_cast<unsigned char>(b*255));
     }