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

#include <ColourMapper.h>

Public Types
enum	ColourMap { Green, Sunset, WhiteOnBlack, BlackOnWhite, Cherry, Wasp, Ice, FruitSalad, Banded, Highlight, Printer, HighGain, BlueOnBlack, Cividis, Magma }

Public Member Functions
	ColourMapper (int map, bool inverted, double minValue, double maxValue)

	~ColourMapper ()

	ColourMapper (const ColourMapper &)=default

ColourMapper &	operator= (const ColourMapper &)=default

int	getMap () const

bool	isInverted () const

double	getMinValue () const

double	getMaxValue () const

QColor	map (double value) const
	Map the given value to a colour. More...

QColor	getContrastingColour () const
	Return a colour that contrasts somewhat with the colours in the map, so as to be used for cursors etc. More...

bool	hasLightBackground () const
	Return true if the colour map is intended to be placed over a light background, false otherwise. More...

QPixmap	getExamplePixmap (QSize size) const
	Return a pixmap of the given size containing a preview swatch for the colour map. More...

Static Public Member Functions
static int	getColourMapCount ()
	Return the number of known colour maps. More...

static QString	getColourMapLabel (int n)
	Return a human-readable label for the colour map with the given index. More...

static QString	getColourMapId (int n)
	Return a machine-readable id string for the colour map with the given index. More...

static int	getColourMapById (QString id)
	Return the index for the colour map with the given machine-readable id string, or -1 if the id is not recognised. More...

static int	getBackwardCompatibilityColourMap (int n)
	Older versions of colour-handling code save and reload colour maps by numerical index and can't properly handle situations in which the index order changes between releases, or new indices are added. More...

Protected Attributes
int	m_map

bool	m_inverted

double	m_min

double	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

enum ColourMapper::ColourMap

Enumerator
Green
Sunset
WhiteOnBlack
BlackOnWhite
Cherry
Wasp
Ice
FruitSalad
Banded
Highlight
Printer
HighGain
BlueOnBlack
Cividis
Magma

Definition at line 39 of file ColourMapper.h.

Constructor & Destructor Documentation

ColourMapper::ColourMapper	(	int	map,
		bool	inverted,
		double	minValue,
		double	maxValue
	)

Definition at line 124 of file ColourMapper.cpp.

References m_max, and m_min.

ColourMapper::~ColourMapper ( )

Definition at line 137 of file ColourMapper.cpp.

ColourMapper::ColourMapper ( const ColourMapper & )

default

Member Function Documentation

ColourMapper& ColourMapper::operator= ( const ColourMapper & )

default

int ColourMapper::getMap ( ) const

inline

Definition at line 57 of file ColourMapper.h.

References m_map.

bool ColourMapper::isInverted ( ) const

inline

Definition at line 58 of file ColourMapper.h.

References m_inverted.

double ColourMapper::getMinValue ( ) const

inline

Definition at line 59 of file ColourMapper.h.

References m_min.

double ColourMapper::getMaxValue ( ) const

inline

Definition at line 60 of file ColourMapper.h.

References getBackwardCompatibilityColourMap(), getColourMapById(), getColourMapCount(), getColourMapId(), getColourMapLabel(), getContrastingColour(), getExamplePixmap(), hasLightBackground(), m_max, and map().

int ColourMapper::getColourMapCount ( )

static

QString ColourMapper::getColourMapLabel ( int n )

static

Return a human-readable label for the colour map with the given index.

This may have been subject to translation.

Definition at line 148 of file ColourMapper.cpp.

References Banded, BlackOnWhite, BlueOnBlack, Cherry, Cividis, FruitSalad, getColourMapCount(), Green, HighGain, Highlight, Ice, Magma, map(), Printer, Sunset, Wasp, and WhiteOnBlack.

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

QString ColourMapper::getColourMapId ( int n )

static

Return a machine-readable id string for the colour map with the given index.

This is not translated and is intended for use in file I/O.

Definition at line 177 of file ColourMapper.cpp.

References Banded, BlackOnWhite, BlueOnBlack, Cherry, Cividis, FruitSalad, getColourMapCount(), Green, HighGain, Highlight, Ice, Magma, map(), Printer, Sunset, Wasp, and WhiteOnBlack.

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

int ColourMapper::getColourMapById ( QString id )

static

Return the index for the colour map with the given machine-readable id string, or -1 if the id is not recognised.

Definition at line 204 of file ColourMapper.cpp.

References Banded, BlackOnWhite, BlueOnBlack, Cherry, Cividis, FruitSalad, getColourMapCount(), Green, HighGain, Highlight, Ice, Magma, map(), Printer, Sunset, Wasp, and WhiteOnBlack.

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

int ColourMapper::getBackwardCompatibilityColourMap ( int n )

static

Older versions of colour-handling code save and reload colour maps by numerical index and can't properly handle situations in which the index order changes between releases, or new indices are added.

So when we save a colour map by id, we should also save a compatibility value that can be re-read by such code. This value is an index into the series of colours used by pre-3.2 SV code, namely (Default/Green, Sunset, WhiteOnBlack, BlackOnWhite, RedOnBlue, YellowOnBlack, BlueOnBlack, FruitSalad, Banded, Highlight, Printer, HighGain). It should represent the closest equivalent to the current colour scheme available in that set. This function returns that index.

Definition at line 232 of file ColourMapper.cpp.

References Banded, BlackOnWhite, BlueOnBlack, Cherry, Cividis, FruitSalad, getColourMapCount(), Green, HighGain, Highlight, Ice, Magma, map(), Printer, Sunset, Wasp, and WhiteOnBlack.