Home Page Toolkit Overview Using GML   User Input Services     Finger Tracker     Calibrator     Frame Grabber     Service protocol Obtaining GML   Installing GML   Licence Developer Documentation   Tcl/Tk API     The GML Canvas     Image processing   Tcl Scripts Library     List of Classes     List of Files   C/C++ API     List of Classes     List of Files

gml_Histogram.h // gml_Histogram.h -- // // Define the gml_THistogram class. // // Copyright (c) 2003 CLIPS-IMAG // // See the file "gml_LicenseTerms.txt" for information on usage and redistribution // of this file, and for a DISCLAIMER OF ALL WARRANTIES. // // Updated to GML on December 21, 2003 (JL). // Created on August 6, 1998 (FB). #ifndef __GML_HISTOGRAM__ #define __GML_HISTOGRAM__ // system includes #include <limits.h> #include <assert.h> #include <strings.h> #include <math.h> // project includes #include "gml/base/gml_Types.h" #include "gml/base/gml_Errors.h" #include "gml/math/gml_Math.h" #include "gml/base/gml_Array.h" /// gml_THistogram -- /// /// N-dimensional histogram objects. /// Most checks in this class are done using assertions; compile with @c -DNDEBUG /// to remove parameter checking. class gml_THistogram { public: #pragma mark - #pragma mark Constructors /// Init -- /// /// Allocate an histogram of dimension <dim>. /// The resolution in dimension <k> is specified by <resolution[k]>. /// /// If the resolutions aren't specified (NULL), they default to /// <sDefaultResolution> gml_TError Init (UInt8 dimensions, ///< histogram dimensions UInt32 *resolution ///< resolution for each dimension ); /// Dispose -- /// /// Release the ressources allocated by this object. void Dispose (); /// Setup -- /// /// Setup the scale of the histogram gml_TError Setup (UInt8 dimension, ///< index of the dimension to set up Float32 start, ///< lower bound of first interval Float32 stepWidth ///< width of each bucket ); #pragma mark - #pragma mark Accessors /// Dim -- /// /// Return the dimension of the histogram UInt8 Dim () const; /// Resolution -- /// /// Return the resolution for dimension <dim> UInt32 Resolution (UInt8 dim = 0) const; /// Start -- /// /// Return the lower bound for dimension <dim> Float32 Start (UInt8 dim = 0) const; /// Step -- /// /// Return the bucket width for dimension <dim> Float32 Step (UInt8 dim = 0) const; /// Samples -- /// /// Return the current number of samples UInt32 Samples () const; /// Get -- /// /// Return histogram value for the interval number <i>. /// Valid only for 1D histograms. UInt32 Get (UInt32 i) const; /// Get -- /// /// Returns histogram value for the interval indexed by <i>. UInt32 Get (UInt32 *i) const; /// Get -- /// /// Return histogram value for the interval corresponding to /// sample <sample>. /// Valid only for 1D histograms. UInt32 Get (Float32 sample) const; /// Get -- /// /// Return histogram value for the interval corresponding to /// sample <sample>. UInt32 Get (Float32 *sample) const; /// Next -- /// /// Walk to the index following <index> and update <sample> accordingly /// Return <true> iff overflowing (i.e. walking back to index zero) bool Next (UInt32 *index, Float32 *sample); #pragma mark - #pragma mark Mutators /// Reset -- /// /// Reset to a blank histogram. void Reset (); /// Increment -- /// /// Increment the number of samples by <samples> void Increment (UInt32 samples = 1); /// Push -- /// /// Increment the frequency for the interval corresponding to /// sample <sample> (one dimention). /// returns the new value of histogram in that interval. /// @warning Push() doesn't increment the number of samples. /// /// Valid only for 1D histograms. void Push (Float32 sample, UInt32 count = 1); /// Push -- /// /// Increment the frequency for the interval corresponding to /// sample <sample>. /// returns the new value of histogram in that interval. /// @warning Push() doesn't increment the number of samples. void Push (Float32 *sample, UInt32 count = 1); /// Push -- /// /// Increment the frequency for the interval number <i> (one dimention). /// returns the new value of histogram in that interval. /// @warning Push() doesn't increment the number of samples. /// /// Valid only for 1D histograms. void Push (UInt32 index, UInt32 count = 1); /// Push -- /// /// Increment the frequency for the interval number indexed by <i>. /// returns the new value of histogram in that interval. /// @warning Push() doesn't increment the number of samples. void Push (UInt32 *index, UInt32 count = 1); #pragma mark - #pragma mark Expensive Accessors /// SampleMin -- /// /// Return the samples minimum. /// All the samples used to build this histogram are greater than or equal /// to the returned value. /// Return NAN if the histogram is emtpy. Float32 SampleMin (); /// SampleMax -- /// /// Return the samples minimum. /// All the samples used to build this histogram are strictly lower /// than the returned value. /// Return NAN if the histogram is emtpy. Float32 SampleMax (); /// BucketMin -- /// /// Return the maximum sample count in a single bucket. UInt32 BucketMin (); /// BucketMax -- /// /// Return the minimal sample count in a single bucket. UInt32 BucketMax (); /// Mean -- /// /// Compute the mean histogram value, as statistical average (robust == false) /// or the median (robust == true). /// Valid only for 1D histograms. gml_TError Mean (Float32 *mean, gml_TBoolean robust); /// Moments -- /// /// Compute the order 1 and 2 moments of histogram, either as the statistical /// average and standard deviation, either as the median and median absolute /// deviation. /// Use Mean () eventually. /// Currently valid only for 1D histograms. gml_TError Moments (Float32 *mean, Float32 *deviation, gml_TBoolean robust); /// Entropy -- /// /// Compute the order 1 entropy of the histogram. /// Currently valid only for 1D histograms. gml_TError Entropy (Float32 *entropy); /// Desaturate -- /// /// Remove the samples in the extremal bucket. void Desaturate (); /// Quantiles -- gml_TError Quantiles (gml_TArray<Float32>& quantiles); #pragma mark - #pragma mark Expensive Mutators /// Scale -- /// /// Scale the histogram sample counts by a factor a/2^b gml_TError Scale (UInt8 a, UInt8 b); /// Shift -- /// /// Shift up all values in the histogram by a gml_TError Shift (UInt8 a); protected: #pragma mark - #pragma mark Internal utilities /// Flat index of a sample in fData, given its N-D index UInt32 Index (UInt32 *sample) const; /// Flat index of a sample in fData, given its 1-D floating-point value UInt32 Index (Float32 sample) const; /// Flat index of a sample in fData, given its N-D floating-point value UInt32 Index (Float32 *sample) const; // // Fields // UInt8 fDim; ///< number of dimensions of histogram array UInt32 *fData; ///< array of histogram values UInt32 fSize; ///< size of fData (product of resolutions) UInt32 fSamples; ///< sum of histogram values UInt32 *fOffset; ///< sub-dimension array sizes UInt32 *fIndex; ///< temporary n-dimensional index storage // arrays of dimension parameters (on set of parameter per dimension) UInt32 *fResolution; ///< number of intervals Float32 *fStart; ///< lower bound of first interval Float32 *fStep; ///< width of intervals Float32 *fStepR; ///< reciprocates of fStep #pragma mark - #pragma mark Static members protected: // setup static void ClassInit (); ///< class setup static bool sModuleInited; ///< was ClassInit() called ? public: // errors static gml_TError sErrorValidFor1DOnly; static gml_TError sErrorWrongDimension; static gml_TError sErrorWrongResolution; // defaults static const UInt32 sDefaultResolution = 256; // flags static const UInt8 sMomentsGaussian = 0 << 0; static const UInt8 sMomentsRobust = 1 << 0; }; #pragma mark - #pragma mark Inline functions inline UInt8 gml_THistogram::Dim () const { return fDim; } inline UInt32 gml_THistogram::Resolution (UInt8 dim) const { assert (dim < fDim); return fResolution[dim]; } inline Float32 gml_THistogram::Start (UInt8 dim) const { assert (dim < fDim); return fStart[dim]; } inline Float32 gml_THistogram::Step (UInt8 dim) const { assert (dim < fDim); return fStep[dim]; } inline UInt32 gml_THistogram::Samples () const { return fSamples; } inline UInt32 gml_THistogram::Get (UInt32 sample) const { assert (fDim == 1); assert (sample < fResolution[0]); return fData[sample]; } inline UInt32 gml_THistogram::Get (UInt32 *sample) const { return fData[Index (sample)]; } inline UInt32 gml_THistogram::Get (Float32 sample) const { return fData[Index (sample)]; } inline UInt32 gml_THistogram::Get (Float32 *sample) const { return fData[Index (sample)]; } #pragma mark- inline void gml_THistogram::Increment (UInt32 samples) { fSamples += samples; } inline void gml_THistogram::Push (Float32 sample, UInt32 count) { fData[Index (sample)] += count; } inline void gml_THistogram::Push (Float32 *sample, UInt32 count) { fData[Index (sample)] += count; } inline void gml_THistogram::Push (UInt32 sample, UInt32 count) { assert (fDim == 1); assert (sample < fResolution[0]); fData[sample] += count; } inline void gml_THistogram::Push (UInt32 *sample, UInt32 count) { fData[Index (sample)] += count; } #pragma mark- inline UInt32 gml_THistogram::Index (UInt32 *sample) const { switch (fDim) { case 1: { assert (*sample < *fResolution); return *sample; } case 2: { assert (sample[0] < fResolution[0]); assert (sample[1] < fResolution[1]); return sample[0] * fOffset[0] + sample[1] * fOffset[1]; } default: { UInt32 offset = 0; for (UInt8 j = 0; j < fDim; j++) { assert (sample[j] < fResolution[j]); offset += sample[j] * fOffset[j]; } return offset; } } } inline UInt32 gml_THistogram::Index (Float32 sample) const { assert (fDim == 1); return (UInt32) LFloor ((sample - fStart[0]) * fStepR[0]); } inline UInt32 gml_THistogram::Index (Float32 *sample) const { for (int j = 0; j < fDim; ++j) { assert (LFloor ((sample[j] - fStart[j]) * fStepR[j]) < fResolution[j]); fIndex[j] = LFloor ((sample[j] - fStart[j]) * fStepR[j]); } return Index (fIndex); } #endif /* __GML_HISTOGRAM__ */ Generated on Tue Jun 12 14:03:27 2007 for gml by Doxygen 1.5.2.

Contact: julien (dot) letessier (at) gmail (dot) com. Copyright (c) 2000-2007 CLIPS-IMAG Laboratory, Grenoble, France. All rights reserved. W3CXHTML 1.0 W3CCSS 2.0