ColourScale::Parameters Struct Reference

#include <ColourScale.h>

Public Member Functions
	Parameters ()

Public Attributes
int	colourMap
	A colour map index as used by ColourMapper. More...
ColourScaleType	scaleType
	Distribution for the scale. More...
double	minValue
	Minimum value in source range. More...
double	maxValue
	Maximum value in source range. More...
bool	inverted
	Whether the colour scale should be mapped inverted. More...
double	threshold
	Threshold below which every value is mapped to background pixel 0. More...
double	gain
	Gain to apply before thresholding, mapping, and clamping. More...
double	multiple
	Multiple to apply after thresholding and mapping. More...

Detailed Description

Definition at line 37 of file ColourScale.h.

Constructor & Destructor Documentation

ColourScale::Parameters::Parameters ( )

inline

Definition at line 38 of file ColourScale.h.

Member Data Documentation

int ColourScale::Parameters::colourMap

A colour map index as used by ColourMapper.

Definition at line 43 of file ColourScale.h.

Referenced by Colour3DPlotLayer::getRenderer(), and SpectrogramLayer::getRenderer().

ColourScaleType ColourScale::Parameters::scaleType

Distribution for the scale.

Definition at line 46 of file ColourScale.h.

Referenced by ColourScale::ColourScale(), ColourScale::getPixel(), Colour3DPlotLayer::getRenderer(), SpectrogramLayer::getRenderer(), and ColourScale::getScale().

double ColourScale::Parameters::minValue

Minimum value in source range.

Definition at line 49 of file ColourScale.h.

Referenced by ColourScale::ColourScale(), Colour3DPlotLayer::getRenderer(), and SpectrogramLayer::getRenderer().

double ColourScale::Parameters::maxValue

Maximum value in source range.

Must be > minValue

Definition at line 52 of file ColourScale.h.

Referenced by ColourScale::ColourScale(), Colour3DPlotLayer::getRenderer(), and SpectrogramLayer::getRenderer().

bool ColourScale::Parameters::inverted

Whether the colour scale should be mapped inverted.

Definition at line 55 of file ColourScale.h.

Referenced by Colour3DPlotLayer::getRenderer().

double ColourScale::Parameters::threshold

Threshold below which every value is mapped to background pixel 0.

Definition at line 59 of file ColourScale.h.

Referenced by ColourScale::ColourScale(), ColourScale::getPixel(), Colour3DPlotLayer::getRenderer(), and SpectrogramLayer::getRenderer().

double ColourScale::Parameters::gain

Gain to apply before thresholding, mapping, and clamping.

Definition at line 62 of file ColourScale.h.

Referenced by ColourScale::getPixel(), Colour3DPlotLayer::getRenderer(), and SpectrogramLayer::getRenderer().

double ColourScale::Parameters::multiple

Multiple to apply after thresholding and mapping.

In most cases the gain parameter is the one you want instead of this, but this can be used for example with Log scale to produce the log of some power of the original value, e.g. multiple = 2 gives log(x^2).

Definition at line 69 of file ColourScale.h.

Referenced by ColourScale::getPixel(), and SpectrogramLayer::getRenderer().

---

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

• ColourScale.h