FCam::Histogram Class Reference

A histogram returned by the histogram generator. More...

#include <Base.h>

Inheritance diagram for FCam::Histogram:

Inheritance graph
[legend]
Collaboration diagram for FCam::Histogram:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 Histogram ()
 The default constructor is an invalid histogram storing no data.
unsigned operator() (int x, int c)
 Sample the histogram at a particular bucket in a particular image channel.
unsigned operator() (int x)
 Sample the histogram at a particular bucket, summed over all channels.

Public Attributes

bool valid
 Is it safe to dereference data and/or call operator().
unsigned channels
 How many channels are there in this histogram?
unsigned * data
 Access to the raw histogram data.


Detailed Description

A histogram returned by the histogram generator.

Has all the properties of a HistogramConfig and also some actual histograms. Before you dereference the data, check if valid is true. Even if you requested a histogram, you're not guaranteed to get one back in all cases.

Definition at line 181 of file Base.h.


Constructor & Destructor Documentation

FCam::Histogram::Histogram (  )  [inline]

The default constructor is an invalid histogram storing no data.

Definition at line 186 of file Base.h.


Member Function Documentation

unsigned FCam::Histogram::operator() ( int  x,
int  c 
) [inline]

Sample the histogram at a particular bucket in a particular image channel.

The absolute number should not be relied on, because the histogram is computed over the bayer-mosaiced raw sensor data, which may be a different resolution to the actual output image if the imaging pipe is doing some resizing. The channels are in the same order as returned by Sensor::getBayerPattern - typically GRBG.

Definition at line 197 of file Base.h.

unsigned FCam::Histogram::operator() ( int  x  )  [inline]

Sample the histogram at a particular bucket, summed over all channels.

Definition at line 204 of file Base.h.


Member Data Documentation

Is it safe to dereference data and/or call operator().

Definition at line 214 of file Base.h.

Access to the raw histogram data.

The meaning of this data is platform specific. On the OMAP3430 it's just a histogram for each channel, one after the other.

Definition at line 222 of file Base.h.


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

Generated on Mon Jan 18 20:48:13 2010 for FCam by  doxygen 1.5.6