[ VIGRA Homepage | Function Index | Class Index | Namespaces | File List | Main Page ]

details HistogramOptions Class Reference VIGRA

Set histogram options. More...

#include <vigra/histogram.hxx>

Public Member Functions

HistogramOptionsglobalAutoInit ()
 
 HistogramOptions ()
 
HistogramOptionsregionAutoInit ()
 
HistogramOptionssetBinCount (int c)
 
HistogramOptionssetMinMax (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.
 

Detailed Description

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.

Constructor & Destructor Documentation

Initialize members with default values:

  • minimum, maximum = 0.0
  • binCount = 64
  • local_auto_init = false

Member Function Documentation

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.


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

© Ullrich Köthe (ullrich.koethe@iwr.uni-heidelberg.de)
Heidelberg Collaboratory for Image Processing, University of Heidelberg, Germany

html generated using doxygen and Python
vigra 1.11.1 (Fri May 19 2017)