Colour3DPlotExporter::Parameters Struct Reference

#include <Colour3DPlotExporter.h>

Public Member Functions

 Parameters ()
 

Public Attributes

BinDisplay binDisplay
 Selection of bins to include in the export. More...
 
double scaleFactor
 Initial scale factor (e.g. More...
 
double threshold
 Threshold below which every value is mapped to background pixel 0 in the display, matching the ColourScale object parameters. More...
 
double gain
 Gain that is applied before thresholding, in the display, matching the ColourScale object parameters. More...
 
ColumnNormalization normalization
 Type of column normalization. More...
 

Detailed Description

Definition at line 34 of file Colour3DPlotExporter.h.

Constructor & Destructor Documentation

Colour3DPlotExporter::Parameters::Parameters ( )
inline

Definition at line 35 of file Colour3DPlotExporter.h.

Member Data Documentation

BinDisplay Colour3DPlotExporter::Parameters::binDisplay

Selection of bins to include in the export.

If a LayerGeometryProvider is also included in Sources, then the set of bins will also be constrained to the vertical range of that.

Definition at line 46 of file Colour3DPlotExporter.h.

Referenced by SpectrogramLayer::getExportModel(), Colour3DPlotExporter::getStringExportHeaders(), and Colour3DPlotExporter::toStringExportRows().

double Colour3DPlotExporter::Parameters::scaleFactor

Initial scale factor (e.g.

for FFT scaling). This factor is actually applied to exported values, in contrast to the gain value below based on the ColourScale parameter.

Definition at line 51 of file Colour3DPlotExporter.h.

Referenced by SpectrogramLayer::getExportModel(), and Colour3DPlotExporter::toStringExportRows().

double Colour3DPlotExporter::Parameters::threshold

Threshold below which every value is mapped to background pixel 0 in the display, matching the ColourScale object parameters.

This is used for thresholding in peak-frequency output only.

Definition at line 57 of file Colour3DPlotExporter.h.

Referenced by SpectrogramLayer::getExportModel(), and Colour3DPlotExporter::toStringExportRows().

double Colour3DPlotExporter::Parameters::gain

Gain that is applied before thresholding, in the display, matching the ColourScale object parameters.

This is used only to determined the thresholding level. The exported values have the scaleFactor applied, but not this gain.

Definition at line 63 of file Colour3DPlotExporter.h.

Referenced by SpectrogramLayer::getExportModel(), and Colour3DPlotExporter::toStringExportRows().

ColumnNormalization Colour3DPlotExporter::Parameters::normalization

Type of column normalization.

Again, this is only used to calculate thresholding level. The exported values are un-normalized.

Definition at line 68 of file Colour3DPlotExporter.h.

Referenced by SpectrogramLayer::getExportModel(), and Colour3DPlotExporter::toStringExportRows().


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