Public Types | Public Member Functions | Private Attributes

DGtal::CColorMap< CMap > Struct Template Reference
[DGtal concepts]

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

#include <CColorMap.h>

Collaboration diagram for DGtal::CColorMap< CMap >:
Collaboration graph
[legend]

Public Types

typedef CMap::ValueType ValueType

Public Member Functions

 BOOST_CONCEPT_ASSERT ((CValueType< ValueType >))
 BOOST_CONCEPT_USAGE (CColorMap)

Private Attributes

LibBoard::Color myColor
ValueType myMin
ValueType myMax
ValueType 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.

Description of concept 'CColorMap'

Refinement of

Associated types :

Notation

Definitions

Valid expressions and semantics

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

Invariants

Models

Notes


Member Typedef Documentation

template<typename CMap >
typedef CMap::ValueType DGtal::CColorMap< CMap >::ValueType

Member Function Documentation

template<typename CMap >
DGtal::CColorMap< CMap >::BOOST_CONCEPT_ASSERT ( (CValueType< ValueType >)   ) 
template<typename CMap >
DGtal::CColorMap< CMap >::BOOST_CONCEPT_USAGE ( CColorMap< CMap >   )  [inline]

Field Documentation

template<typename CMap >
LibBoard::Color DGtal::CColorMap< CMap >::myColor [private]
template<typename CMap >
ValueType DGtal::CColorMap< CMap >::myMax [private]
template<typename CMap >
ValueType DGtal::CColorMap< CMap >::myMin [private]
template<typename CMap >
ValueType DGtal::CColorMap< CMap >::myValue [private]

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