mitkHistogram1D Class Reference

mitkHistogram1D - a tool to generate a 1D histogram from a volume More...

#include <mitkHistogram1D.h>

Inherits mitkObject.

Inheritance diagram for mitkHistogram1D:

[legend]Collaboration diagram for mitkHistogram1D:

[legend]List of all members.

Public Member Functions
void	SetSourceVolume (mitkVolume *vol, int chIdx=-1, unsigned int *extent=NULL, mitkVolume *mask=NULL)
void	SetRange (double min, double max, unsigned int intervalNum)
void	GetRange (double &min, double &max, unsigned int &intervalNum) const
double	GetMaxPixVal ()
double	GetMinPixVal ()
double	GetMeanPixVal ()
double	GetStandardDeviation ()
unsigned long	GetTotalPixels ()
unsigned long *	GetStatistics ()
bool	IsModified ()
void	SetUnmodified ()
mitkVolume *	GetSourceVolume ()

---

Detailed Description

mitkHistogram1D - a tool to generate a 1D histogram from a volume

mitkHistogram1D is a tool to generate a 1D histogram from a volume

---

Member Function Documentation

double mitkHistogram1D::GetMaxPixVal (   )

Get the maximum pixel value within the specified extent Returns: Return the maximum pixel value within the specified extent

double mitkHistogram1D::GetMeanPixVal (   )

Get the average pixel value within the specified extent, this will trigger the calculation Returns: Return the average pixel value within the specified extent

double mitkHistogram1D::GetMinPixVal (   )

Get the minimum pixel value within the specified extent this will trigger the calculation Returns: Return the minimum pixel value within the specified extent

void mitkHistogram1D::GetRange (  double &  min, double &  max, unsigned int &  intervalNum )  const [inline]

////////////////// Get the value range and interval where statistics are calculated, Parameters: min  Recieve the min value of histogram max  Recieve the max value of histogram intervalNum  Recieve number of intervals between min and max

mitkVolume* mitkHistogram1D::GetSourceVolume (   )  [inline]

Get the volume whose histogram is generated Returns: Return the volume whose histogram is generated

double mitkHistogram1D::GetStandardDeviation (   )

Get the standard deviation of pixel value within the specified extent, this will trigger the calculation Returns: Return the standard deviation of pixel value within the specified extent

unsigned long* mitkHistogram1D::GetStatistics (   )

Get histogram statistics, this will trigger the calculation Returns: Return the histogram statistics, the array is as large as intervalNum

unsigned long mitkHistogram1D::GetTotalPixels (   )

Get the total number of pixels within the specified extent Returns: Return the total number of pixels within the specified extent

bool mitkHistogram1D::IsModified (   )

Get the modified status of the histogram Returns: whether the histogram is modified after last call to SetUnmodified()

void mitkHistogram1D::SetRange (  double  min, double  max, unsigned int  intervalNum )

////////////////// Set the value range and interval where to calculate statistics, this will allocate memory for statistics Parameters: min  Specify the min value of histogram max  Specify the max value of histogram intervalNum  Specify number of intervals between min and max

void mitkHistogram1D::SetSourceVolume (  mitkVolume *  vol, int  chIdx = -1, unsigned int *  extent = NULL, mitkVolume *  mask = NULL )

Set the volume whose histogram is to be generated Parameters: vol  Specify pointer to the volume chIdx  Specify the channel of the the histogram, if the value is greater or equal than the number of channel present or smaller than zero, an average of all channels will be genrated. extent  Specify (optionally) the region of the volume to generate the histogram. NULL means to take the whole volume into consideration.

void mitkHistogram1D::SetUnmodified (   )

Set the modified status the false

---

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

• mitkHistogram1D.h

---