[ VIGRA Homepage | Function Index | Class Index | Namespaces | File List | Main Page ]
HistogramOptions Class Reference |
Set histogram options. More...
#include <vigra/histogram.hxx>
Public Member Functions | |
HistogramOptions & | globalAutoInit () |
HistogramOptions () | |
HistogramOptions & | regionAutoInit () |
HistogramOptions & | setBinCount (int c) |
HistogramOptions & | setMinMax (double mi, double ma) |
bool | validMinMax () const |
Public Attributes | |
int | binCount |
Total number of bins in the histogram. | |
bool | local_auto_init |
If true, range mapping bounds are defined by minimum and maximum of the data. | |
double | maximum |
Upper bound for linear range mapping from values to indices. | |
double | minimum |
Lower bound for linear range mapping from values to indices. | |
Set histogram options.
HistogramOptions objects are used to pass histogram options to other objects. This example shows how it is is used to pass histogram options to an accumulator chain.
HistogramOptions | ( | ) |
Initialize members with default values:
HistogramOptions& setMinMax | ( | double | mi, |
double | ma | ||
) |
Set minimum = mi and maximum = ma. Requirement: mi < ma.
HistogramOptions& setBinCount | ( | int | c | ) |
Set binCount = c. Requirement: c > 0.
HistogramOptions& regionAutoInit | ( | ) |
Set local_auto_init = true. Requirement: setMinMax() must not have been called before.
HistogramOptions& globalAutoInit | ( | ) |
Set local_auto_init = false. Requirement: setMinMax() must not have been called before.
bool validMinMax | ( | ) | const |
Return minimum < maximum.
© Ullrich Köthe (ullrich.koethe@iwr.uni-heidelberg.de) |
html generated using doxygen and Python
|