#include <Histogram.hh>

Collaboration diagram for Histogram:

Classes
struct	hist
Public Member Functions
	Histogram (Image &img, double dlt=1.0)
	Histogram (ImageInformation &ii, double dlt=1.0)
	~Histogram (void)
int	at (int pos, coeff &lower)
int	at (coeff value)
int	size (void)
double	delta (void)
void	update (void)
void	print (void)
void	add (coeff value, int number)
Protected Attributes
Image *	m_image
ImageInformation *	m_data
ImageInformation *	m_ii
double	m_dlt
struct hist *	m_values
int	m_nvals

Detailed Description

A class for histograms.

Definition at line 21 of file Histogram.hh.

Constructor & Destructor Documentation

Histogram::Histogram	(	Image &	img,
		double	dlt = `1.0`
	)

Constructor. Creates the histogram from an Image object.

Exceptions:

invalid_argument a zero value for {dlt} was specified

Parameters:

img	the image to look at
dlt	the quantization step (necessary for histograms in the DWT domain

Histogram::Histogram	(	ImageInformation &	ii,
		double	dlt = `1.0`
	)

Constructor. Creates the histogram from an ImageInformation object.

Exceptions:

invalid_argument a zero value for {dlt} was specified

Parameters:

ii	the image data to look at (will be duplicated)
dlt	the quantization step (necessary for histograms in the DWT domain

Histogram::~Histogram ( void )

Destructor. Releases allocated memory

Member Function Documentation

void Histogram::add	(	coeff	value,
		int	number
	)

Add an occurrence number for a given value.

Exceptions:

invalid_argument adding number would make the result negative

Parameters:

value	the value
number	the number to be added

int Histogram::at	(	int	pos,
		coeff &	lower
	)

Get a value via an index.

Exceptions:

invalid_argument the index {pos} is out of bounds.

Parameters:

pos	The index position.
lower	The lower greyscale boundary (returned value).

Returns:: the value

int Histogram::at ( coeff value )

Get a value via a greyscale value.

Parameters:

value the greyscale value.

Returns:: the value

double Histogram::delta ( void ) [inline]

Get the histogram's delta.

Returns:: the delta

Definition at line 62 of file Histogram.hh.

References m_dlt.

void Histogram::print ( void )

Print the histogram to stdout.

int Histogram::size ( void ) [inline]

Return the number of numbers stored.

Returns:: the number of numbers.

Definition at line 59 of file Histogram.hh.

References m_nvals.

void Histogram::update ( void )

Update the Histogram. This may be necessary after changes to the image.

Member Data Documentation

ImageInformation* Histogram::m_data [protected]

A pointer as a reference to the ImageInformation object (needs to be stored in order to be able to update the histogram after changes to the original image).

Definition at line 82 of file Histogram.hh.

double Histogram::m_dlt [protected]

The delta between two histogram slots.

Definition at line 86 of file Histogram.hh.

Referenced by delta().

ImageInformation* Histogram::m_ii [protected]

A helper object for getting the image's coefficients sorted.

Definition at line 84 of file Histogram.hh.

Image* Histogram::m_image [protected]

A pointer as a reference to the image.

Definition at line 78 of file Histogram.hh.

int Histogram::m_nvals [protected]