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

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

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::concepts::CColorMap< CMap >

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

Description 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 semantics

Name	Expression	Type requirements	Return type	Precondition	Semantics	Post condition	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 93 of file CColorMap.h.

Member Typedef Documentation

◆ Value

template<typename CMap >

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

Definition at line 98 of file CColorMap.h.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT()

template<typename CMap >

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

◆ BOOST_CONCEPT_USAGE()

template<typename CMap >

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

inline

Definition at line 102 of file CColorMap.h.

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