Main Page | Packages | Class Hierarchy | Class List | Directories | Class Members

IDVR.Volume.DataStructures.Histogram Class Reference

#include <Histogram.h>

List of all members.


Detailed Description

Class for representing a density histogram for a specific volume data object.

This class is part of the DataStructure namespace which is actually a subnamespace of the main namespace Volume. Furthermore the standard class Object is inherted to the Histogram class for better controlling of a particular quantity of Histogram instances.

An instance of this class contains a single histogram which will be included in every volume object. It gives information about the count of grayvalues per density value. Thus, it is possible to represent the density distribution in the TransferFuncWin class and a visual interpretation could be drwan for better user understanding of the specific volume data object.

See also:
VolumeData - the main datastructure class.

DataObject - the volume data object class.

Author:
Bernhard Pflugfelder
Version:
1.0
Date:
02-18-2005


Public Member Functions

 Histogram (void)
 This is the standard constructor.
 Histogram (int numOfGrayvalues)
 Constructor initialization with the maximum number of valid gray (density) values.
 Histogram (int n_DensityFrequency __gc[], int n_Length)
 Constructor initialization by an user-defined histogram.
 ~Histogram (void)
 This is the standard deconstructor.
void addNewValue (unsigned short n_Density)
 Increments the count of the specific density value.
void addNewValue (unsigned short n_Density, int n_Value)
 Sets the choosen value to the specific density value.
HistogramgetDownSampledHistogramValues (int n_SampleFactor)
 Returns a new downsampled histogam by the chossen sample factor.
int getHistogramValue (unsigned short n_Density)
 Returns the current density count of the specified density value.
__property int get_HistogramValues (void) __gc[]
 Returns the current density histogram.
__property int get_HistogramLength (void)
 Returns the current density histogram length.
__property int get_MaxVoxelCount (void)
 Returns the maximum voxel count of the current histogram.

Private Attributes

int m_Length
 Saves the current histogram length.
int m_MaxValue
 Saves the maximum voxel count of the histogram.
int m_DensityFrequency __gc []
 Represents the actual histogram values.


Constructor & Destructor Documentation

Histogram::Histogram void   ) 
 

This is the standard constructor.

All member variables of this new instance will be set to zero/null.

Histogram::Histogram int  numOfGrayvalues  ) 
 

Constructor initialization with the maximum number of valid gray (density) values.

All member variables will be set to zero, the Histogram::m_DensityFrequency member will be initialized with the given maximum number of gray values.

Parameters:
numOfGrayvalues the maximum valid number of gray values.

Histogram::Histogram int n_DensityFrequency  __gc[],
int  n_Length
 

Constructor initialization by an user-defined histogram.

The new instance will be set to the corresponding user-defined histogram values.

Parameters:
n_DensityFrequency the user-defined histogram as an one dimensional array.
n_Length the length of the user-defined histogram.

Histogram::~Histogram void   ) 
 

This is the standard deconstructor.

Espacially the Histogram::m_DensityFrequency member which actual is an array will be deleted.


Member Function Documentation

void Histogram::addNewValue unsigned short  n_Density,
int  n_Value
 

Sets the choosen value to the specific density value.

The current histogram will not be changed besides the particularly choosen density value.

Parameters:
n_Density the specific density value.
n_Value the new density count.

void Histogram::addNewValue unsigned short  n_Density  ) 
 

Increments the count of the specific density value.

The current histogram will not be changed besides the particularly choosen density value.

Parameters:
n_Density the specific density value for incrementation.

int Histogram::get_HistogramLength void   ) 
 

Returns the current density histogram length.

Returns:
The current density histogram length.
Note:
The density histogram length is actually the maximum density scope.

int Histogram::get_HistogramValues void   ) 
 

Returns the current density histogram.

Returns:
The current density histogram as an one dimensional int array.

int Histogram::get_MaxVoxelCount void   ) 
 

Returns the maximum voxel count of the current histogram.

Returns:
The maximum voxel count.

Histogram * Histogram::getDownSampledHistogramValues int  n_SampleFactor  ) 
 

Returns a new downsampled histogam by the chossen sample factor.

Parameters:
n_SampleFactor the choosen sample factor for down sampling.
Returns:
A new instance of the Histogram class.

int Histogram::getHistogramValue unsigned short  n_Density  ) 
 

Returns the current density count of the specified density value.

Parameters:
n_Density the specific density value.
Returns:
The current density count to the choosen density value.


The documentation for this class was generated from the following files:
Generated on Sat Apr 9 11:51:01 2005 for RayCaster wiht Importance Driven Volume Rendering (IDVR) by  doxygen 1.4.1