ddt  0.1
Public Member Functions | Protected Attributes | List of all members
ddt::ImageColor Class Reference

#include <imageColor.hpp>

Public Member Functions

 ImageColor ()
 
virtual ~ImageColor ()
 
void set_logger (ddt::DdtLogger *const in_logger)
 
void LoadColorMaps (const std::string color_map_folder)
 
std::list< std::string > get_ColorMapsList () const
 
ddt::colorMap_tget_ColorMap (const std::string color_map_name)
 
ddt::colorMapARGB_tget_ColorMapARGB (const std::string color_map_name)
 
ddt::colorMap_tget_GrayScaleColorMap ()
 
ddt::colorMapARGB_tget_GrayScaleColorMapARGB ()
 
ddt::scalingLut_tget_LinearScalingLut (const double cut_level_min, const double cut_level_max)
 
ddt::scalingLut_tget_LogarithmicScalingLut (const double cut_level_min, const double cut_level_max)
 
ddt::scalingLut_tget_SqrtScalingLut (const double cut_level_min, const double cut_level_max)
 

Protected Attributes

ddt::DdtLoggerlogger
 

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

◆ 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_namethe 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_namethe 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_minthe minimum cut level to be applied for the LUT creation
cut_level_maxthe 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_minthe minimum cut level to be applied for the LUT creation
cut_level_maxthe 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_minthe minimum cut level to be applied for the LUT creation
cut_level_maxthe 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_folderfolder containing color map files

◆ set_logger()

void ImageColor::set_logger ( ddt::DdtLogger *const  in_logger)

Set logger

Parameters
loggerThe logger object

Member Data Documentation

◆ logger

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

The logger object


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