Colour3DPlotRenderer::Parameters Struct Reference

#include <Colour3DPlotRenderer.h>

Collaboration diagram for Colour3DPlotRenderer::Parameters:
Collaboration graph

Public Member Functions

 Parameters ()
 

Public Attributes

ColourScale colourScale
 A complete ColourScale object by value, used for colour map conversion. More...
 
ColumnNormalization normalization
 Type of column normalization. More...
 
BinDisplay binDisplay
 Selection of bins to display. More...
 
BinScale binScale
 Scale for vertical bin spacing (linear or logarithmic). More...
 
bool alwaysOpaque
 Whether cells should always be opaque. More...
 
bool interpolate
 Whether to apply smoothing when rendering cells at more than one pixel per cell. More...
 
bool invertVertical
 Whether to render the whole caboodle upside-down. More...
 
bool showDerivative
 Whether to show the frame-to-frame difference instead of the actual value. More...
 
double scaleFactor
 Initial scale factor (e.g. More...
 
int colourRotation
 Colourmap rotation, in the range 0-255. More...
 

Detailed Description

Definition at line 62 of file Colour3DPlotRenderer.h.

Constructor & Destructor Documentation

Colour3DPlotRenderer::Parameters::Parameters ( )
inline

Definition at line 63 of file Colour3DPlotRenderer.h.

Member Data Documentation

ColourScale Colour3DPlotRenderer::Parameters::colourScale

A complete ColourScale object by value, used for colour map conversion.

Note that the final display gain setting is also encapsulated here.

Definition at line 78 of file Colour3DPlotRenderer.h.

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

ColumnNormalization Colour3DPlotRenderer::Parameters::normalization

Type of column normalization.

Definition at line 81 of file Colour3DPlotRenderer.h.

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

BinDisplay Colour3DPlotRenderer::Parameters::binDisplay

Selection of bins to display.

Definition at line 84 of file Colour3DPlotRenderer.h.

Referenced by SpectrogramLayer::getRenderer().

BinScale Colour3DPlotRenderer::Parameters::binScale

Scale for vertical bin spacing (linear or logarithmic).

Definition at line 87 of file Colour3DPlotRenderer.h.

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

bool Colour3DPlotRenderer::Parameters::alwaysOpaque

Whether cells should always be opaque.

If false, then large cells (when zoomed in a long way) will be rendered translucent in order not to obscure anything in a layer beneath.

Definition at line 93 of file Colour3DPlotRenderer.h.

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

bool Colour3DPlotRenderer::Parameters::interpolate

Whether to apply smoothing when rendering cells at more than one pixel per cell.

!!! todo: decide about separating out x-interpolate and y-interpolate as the spectrogram actually does (or used to)

Definition at line 100 of file Colour3DPlotRenderer.h.

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

bool Colour3DPlotRenderer::Parameters::invertVertical

Whether to render the whole caboodle upside-down.

Definition at line 103 of file Colour3DPlotRenderer.h.

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

bool Colour3DPlotRenderer::Parameters::showDerivative

Whether to show the frame-to-frame difference instead of the actual value.

Definition at line 107 of file Colour3DPlotRenderer.h.

double Colour3DPlotRenderer::Parameters::scaleFactor

Initial scale factor (e.g.

for FFT scaling). This factor is applied to all values read from the underlying model before magnitude ranges are calculated, in contrast to the display gain found in the ColourScale parameter.

Definition at line 113 of file Colour3DPlotRenderer.h.

Referenced by SpectrogramLayer::getRenderer().

int Colour3DPlotRenderer::Parameters::colourRotation

Colourmap rotation, in the range 0-255.

Definition at line 116 of file Colour3DPlotRenderer.h.

Referenced by SpectrogramLayer::getRenderer().


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