#include <CColorMap.h>

Collaboration diagram for DGtal::CColorMap< CMap >:

Public Types
typedef CMap::Value	Value

Public Member Functions
	BOOST_CONCEPT_ASSERT ((CLabel< Value >))
	BOOST_CONCEPT_USAGE (CColorMap)

Private Attributes
Color	myColor
Value	myMin
Value	myMax
Value	myValue

Detailed Description

template<typename CMap>
struct DGtal::CColorMap< CMap >

Aim: Defines the concept describing a color map. A color map converts a value within a given range into an RGB triple.

DescriptionDescription of concept 'CColorMap'

Refinement of

Associated types :

Notation

X : A type that is a model of CColorMap
x, y : Object of type X

Definitions

Valid expressions and

Name	Expression	Type requirements	Return type	Precondition	Semantics	Postcondition	Complexity
Construction	CMap<Value> cmap(min,max);	min and max are of the same Value
Obtain a color	color=cmap(value)	value is a Value	DGtal::Color	min value max	Returns a color computed after the position of value within the range [min,max]

Invariants###

Models### GradientColorMap HueShadeColorMap ColorBrightnessColorMap GrayScaleColorMap RandomColorMap

Notes###

Definition at line 100 of file CColorMap.h.

Member Typedef Documentation

template<typename CMap >

typedef CMap::Value DGtal::CColorMap< CMap >::Value

Definition at line 105 of file CColorMap.h.

Member Function Documentation

template<typename CMap >

DGtal::CColorMap< CMap >::BOOST_CONCEPT_ASSERT ( (CLabel< Value >) )

template<typename CMap >

DGtal::CColorMap< CMap >::BOOST_CONCEPT_USAGE ( CColorMap< CMap > )

inline

Definition at line 109 of file CColorMap.h.

References DGtal::CColorMap< CMap >::myColor, DGtal::CColorMap< CMap >::myMax, DGtal::CColorMap< CMap >::myMin, DGtal::CColorMap< CMap >::myValue, and DGtal::ConceptUtils::sameType().

    {
      CMap myCMap( myMin, myMax );
      // operator() exists, takes a Value, and returns a LibBoard::Color.
      ConceptUtils::sameType( myColor, myCMap.operator()( myValue ) );
    }