ColourMapper Class Reference

A class for mapping intensity values onto various colour maps. More...

#include <ColourMapper.h>

Inheritance diagram for ColourMapper:

Collaboration diagram for ColourMapper:

Public Types
enum	StandardMap {   DefaultColours, Sunset, WhiteOnBlack, BlackOnWhite,   RedOnBlue, YellowOnBlack, BlueOnBlack, FruitSalad,   Banded, Highlight, Printer, HighGain }

Public Member Functions
	ColourMapper (int map, float minValue, float maxValue)
virtual	~ColourMapper ()
int	getMap () const
float	getMinValue () const
float	getMaxValue () const
QColor	map (float value) const
QColor	getContrastingColour () const
bool	hasLightBackground () const

Static Public Member Functions
static int	getColourMapCount ()
static QString	getColourMapName (int n)

Protected Attributes
int	m_map
float	m_min
float	m_max

Detailed Description

A class for mapping intensity values onto various colour maps.

Definition at line 27 of file ColourMapper.h.

Member Enumeration Documentation

StandardMap

enum ColourMapper::StandardMap

Enumerator
DefaultColours
Sunset
WhiteOnBlack
BlackOnWhite
RedOnBlue
YellowOnBlack
BlueOnBlack
FruitSalad
Banded
Highlight
Printer
HighGain

Definition at line 35 of file ColourMapper.h.

Constructor & Destructor Documentation

ColourMapper()

ColourMapper::ColourMapper	(	int	map,
		float	minValue,
		float	maxValue
	)

Definition at line 24 of file ColourMapper.cpp.

References m_max, and m_min.

~ColourMapper()

ColourMapper::~ColourMapper ( )

virtual

Definition at line 37 of file ColourMapper.cpp.

Member Function Documentation

getMap()

int ColourMapper::getMap ( ) const

inline

Definition at line 50 of file ColourMapper.h.

References m_map.

getMinValue()

float ColourMapper::getMinValue ( ) const

inline

Definition at line 51 of file ColourMapper.h.

References m_min.

getMaxValue()

float ColourMapper::getMaxValue ( ) const

inline

Definition at line 52 of file ColourMapper.h.

References m_max.

getColourMapCount()

int ColourMapper::getColourMapCount ( )

static

Definition at line 42 of file ColourMapper.cpp.

Referenced by getColourMapName(), getContrastingColour(), SliceLayer::getPropertyRangeAndValue(), Colour3DPlotLayer::getPropertyRangeAndValue(), TimeValueLayer::getPropertyRangeAndValue(), RegionLayer::getPropertyRangeAndValue(), SpectrogramLayer::getPropertyRangeAndValue(), hasLightBackground(), and map().

getColourMapName()

QString ColourMapper::getColourMapName ( int  n )

static

Definition at line 48 of file ColourMapper.cpp.

References Banded, BlackOnWhite, BlueOnBlack, DefaultColours, FruitSalad, getColourMapCount(), HighGain, Highlight, map(), Printer, RedOnBlue, Sunset, WhiteOnBlack, and YellowOnBlack.

Referenced by SliceLayer::getPropertyValueLabel(), Colour3DPlotLayer::getPropertyValueLabel(), TimeValueLayer::getPropertyValueLabel(), RegionLayer::getPropertyValueLabel(), and SpectrogramLayer::getPropertyValueLabel().

map()

QColor ColourMapper::map

(

float

value

)

const

Definition at line 72 of file ColourMapper.cpp.

References Banded, BlackOnWhite, BlueOnBlack, DefaultColours, FruitSalad, getColourMapCount(), HighGain, Highlight, m_map, m_max, m_min, Printer, RedOnBlue, Sunset, WhiteOnBlack, and YellowOnBlack.

Referenced by Colour3DPlotLayer::fillCache(), RegionLayer::getColourForValue(), TimeValueLayer::getColourForValue(), getColourMapName(), getContrastingColour(), hasLightBackground(), SpectrogramLayer::initialisePalette(), SliceLayer::paint(), and SpectrumLayer::paint().

getContrastingColour()

QColor ColourMapper::getContrastingColour

(

)

const

Definition at line 221 of file ColourMapper.cpp.

References Banded, BlackOnWhite, BlueOnBlack, DefaultColours, FruitSalad, getColourMapCount(), HighGain, Highlight, m_map, map(), Printer, RedOnBlue, Sunset, WhiteOnBlack, and YellowOnBlack.

Referenced by SpectrogramLayer::initialisePalette(), and SpectrumLayer::paintCrosshairs().

hasLightBackground()

bool ColourMapper::hasLightBackground

(

)

const

Definition at line 269 of file ColourMapper.cpp.

References Banded, BlackOnWhite, BlueOnBlack, DefaultColours, FruitSalad, getColourMapCount(), HighGain, Highlight, m_map, map(), Printer, RedOnBlue, Sunset, WhiteOnBlack, and YellowOnBlack.

Referenced by SpectrogramLayer::hasLightBackground().

Member Data Documentation

m_map

int ColourMapper::m_map

protected

Definition at line 63 of file ColourMapper.h.

Referenced by getContrastingColour(), getMap(), hasLightBackground(), and map().

m_min

float ColourMapper::m_min

protected

Definition at line 64 of file ColourMapper.h.

Referenced by ColourMapper(), getMinValue(), and map().

m_max

float ColourMapper::m_max

protected

Definition at line 65 of file ColourMapper.h.

Referenced by ColourMapper(), getMaxValue(), and map().

---

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

• ColourMapper.h
• ColourMapper.cpp