ddt::ImageColor Class Reference

#include <imageColor.hpp>

Protected Attributes
ddt::DdtLogger *	logger
	ImageColor ()
virtual	~ImageColor ()
void	set_logger (ddt::DdtLogger *const in_logger)
void	LoadColorMaps (const std::string color_map_folder)
void	AddCustomColorMaps (const std::string color_map_name, ddt::colorMap_t const &colourmap, ddt::colorMap_t const &colourmap_inverted, ddt::colorMapARGB_t const &colourmap_argb, ddt::colorMapARGB_t const &colourmap_argb_inverted)
std::list< std::string >	get_ColorMapsList () const
ddt::colorMap_t *	get_ColorMap (const std::string color_map_name)
ddt::colorMapARGB_t *	get_ColorMapARGB (const std::string color_map_name)
ddt::colorMap_t *	get_GrayScaleColorMap ()
ddt::colorMapARGB_t *	get_GrayScaleColorMapARGB ()
ddt::scalingLut_t *	get_LinearScalingLut (const double cut_level_min, const double cut_level_max)
ddt::scalingLut_t *	get_LogarithmicScalingLut (const double cut_level_min, const double cut_level_max)
ddt::scalingLut_t *	get_SqrtScalingLut (const double cut_level_min, const double cut_level_max)
void	set_InvertColourmap (const bool invert)

Detailed Description

This class is part of the DDT Image Handling Library and provides functions for color map purposes.

It offers functions to create colormaps from colormap files.

Constructor & Destructor Documentation

ImageColor()

ImageColor::ImageColor

(

)

Constructor

This class is part of the DDT Image Handling Library and provides functions for coordinate conversion purposes.

It offers functions to to create colormaps from colormap files.

~ImageColor()

ImageColor::~ImageColor ( )

virtualdefault

Destructor

Member Function Documentation

AddCustomColorMaps()

void ImageColor::AddCustomColorMaps	(	const std::string	color_map_name,
		ddt::colorMap_t const &	colourmap,
		ddt::colorMap_t const &	colourmap_inverted,
		ddt::colorMapARGB_t const &	colourmap_argb,
		ddt::colorMapARGB_t const &	colourmap_argb_inverted )

Adds customized colour maps.

Parameters

color_map_name	The name of the colour map
colourmap	The colourmap
colourmap_inverted	The inverted colourmap
colourmap_argb	The colourmap with alpha channel
colourmap_argb_inverted	The inverted colourmap with alpha channel

get_ColorMap()

ddt::colorMap_t * ImageColor::get_ColorMap

(

const std::string

color_map_name

)

Get a color map array, identified by the color map name

Parameters

color_map_name

the name of the color map (taken from the color map file name)

Returns

a colorMap object (an array of 256 RGB triples (array of 3 float values, representing the red, green and blue part, all expressed as a value between 0.0 and 1.0)

get_ColorMapARGB()

ddt::colorMapARGB_t * ImageColor::get_ColorMapARGB

(

const std::string

color_map_name

)

Get a color map array, identified by the color map name

Parameters

color_map_name

the name of the color map (taken from the color map file name)

Returns

a colorMapARGB object (an array of 256 unsigned int values, each value representing an alpha channel and the red, green and blue parts, all expressed as a values between 0 and 255)

get_ColorMapsList()

std::list< std::string > ImageColor::get_ColorMapsList

(

)

const

Returns a list of all loaded colormaps

Returns

list containing the names of all loaded colormaps

get_GrayScaleColorMap()

ddt::colorMap_t * ImageColor::get_GrayScaleColorMap

(

)

Get a default gray scale color map array

Returns

a colorMap object (an array of 256 RGB triples (array of 3 float values, representing the red, green and blue part, all expressed as a value between 0.0 and 1.0)

get_GrayScaleColorMapARGB()

ddt::colorMapARGB_t * ImageColor::get_GrayScaleColorMapARGB

(

)

Get a default gray scale color map array

Returns

a colorMapARGB object (an array of 256 unsigned int values, each value representing an alpha channel and the red, green and blue parts, all expressed as a values between 0 and 255)

get_LinearScalingLut()

ddt::scalingLut_t * ImageColor::get_LinearScalingLut	(	const double	cut_level_min,
		const double	cut_level_max )

Get the LUT for linear color scaling

Parameters

cut_level_min	the minimum cut level to be applied for the LUT creation
cut_level_max	the minimum cut level to be applied for the LUT creation

Returns

a scalingLut object (an array of 64K uint values)

get_LogarithmicScalingLut()

ddt::scalingLut_t * ImageColor::get_LogarithmicScalingLut	(	const double	cut_level_min,
		const double	cut_level_max )

Get the LUT for logarithmic color scaling

Parameters

cut_level_min	the minimum cut level to be applied for the LUT creation
cut_level_max	the minimum cut level to be applied for the LUT creation

Returns

a scalingLut object (an array of 64K uint values)

get_SqrtScalingLut()

ddt::scalingLut_t * ImageColor::get_SqrtScalingLut	(	const double	cut_level_min,
		const double	cut_level_max )

Get the LUT for square root color scaling

Parameters

cut_level_min	the minimum cut level to be applied for the LUT creation
cut_level_max	the minimum cut level to be applied for the LUT creation

Returns

a scalingLut object (an array of 64K uint values)

LoadColorMaps()

void ImageColor::LoadColorMaps

(

const std::string

color_map_folder

)

Load the colormaps.

Parameters

color_map_folder

folder containing color map files

set_InvertColourmap()

void ImageColor::set_InvertColourmap

(

const bool

invert

)

Set if colourmap should get inverted

Parameters

invert

sets if colormap should get inverted

set_logger()

void ImageColor::set_logger

(

ddt::DdtLogger *const

in_logger

)

Set logger

Parameters

in_logger

A DDT logger object (no transfer of ownership).

Member Data Documentation

logger

ddt::DdtLogger* ddt::ImageColor::logger

protected

The logger object

---

The documentation for this class was generated from the following files:

• imagehandling/imagelibs/src/include/ddt/imageColor.hpp
• imagehandling/imagelibs/src/imageColor.cpp