Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members

mitkHistogram2D Class Reference

mitkHistogram2D - a tool to generate a 2D histogram from two volumes More...

#include <mitkHistogram2D.h>

Inherits mitkObject.

Inheritance diagram for mitkHistogram2D:

Inheritance graph
[legend]
Collaboration diagram for mitkHistogram2D:

Collaboration graph
[legend]
List of all members.

Public Member Functions

void SetSourceVolumeX (mitkVolume *vol, int chIdx=1, unsigned int *extent=NULL)
void SetSourceVolumeY (mitkVolume *vol, int chIdx=1, unsigned int *extent=NULL)
void SetRange (double minX, double maxX, unsigned int intervalNumX, double minY, double maxY, unsigned int intervalNumY)
void GetRange (double &minX, double &maxX, unsigned int &intervalNumX, double &minY, double &maxY, unsigned int &intervalNumY)
double GetMaxPixValX ()
double GetMinPixValX ()
double GetMaxPixValY ()
double GetMinPixValY ()
double GetMeanPixValX ()
double GetMeanPixValY ()
double GetStandardDeviationX ()
double GetStandardDeviationY ()
unsigned long GetTotalPixels ()
unsigned long * GetStatistics ()
bool IsModified ()
void SetUnmodified ()
mitkVolumeGetSourceVolumeX ()
mitkVolumeGetSourceVolumeY ()

Detailed Description

mitkHistogram2D - a tool to generate a 2D histogram from two volumes

mitkHistogram2D is a tool to generate a 2D histogram from two volumes


Member Function Documentation

double mitkHistogram2D::GetMaxPixValX  ) 
 

Get the maximum pixel value within the specified extent of VolumeX

Returns:
Return the maximum pixel value within the specified extent

double mitkHistogram2D::GetMaxPixValY  ) 
 

Get the maximum pixel value within the specified extent of VolumeY

Returns:
Return the maximum pixel value within the specified extent

double mitkHistogram2D::GetMeanPixValX  ) 
 

Get the average pixel value within the specified extent of VolumeX, this will trigger the calculation

Returns:
Return the average pixel value within the specified extent

double mitkHistogram2D::GetMeanPixValY  ) 
 

Get the average pixel value within the specified extent of VolumeY, this will trigger the calculation

Returns:
Return the average pixel value within the specified extent

double mitkHistogram2D::GetMinPixValX  ) 
 

Get the minimum pixel value within the specified extent of VolumeX this will trigger the calculation

Returns:
Return the minimum pixel value within the specified extent

double mitkHistogram2D::GetMinPixValY  ) 
 

Get the minimum pixel value within the specified extent of VolumeY this will trigger the calculation

Returns:
Return the minimum pixel value within the specified extent

void mitkHistogram2D::GetRange double &  minX,
double &  maxX,
unsigned int &  intervalNumX,
double &  minY,
double &  maxY,
unsigned int &  intervalNumY
[inline]
 

////////////////// Get the value range and interval where statistics are calculated,

Parameters:
minX Receive the min value of the histogram's X-Axial
maxX Receive the max value of the histogram's X-Axial
intervalNum Receive number of intervals between minX and maxX
minY Receive the min value of the histogram's Y-Axial
maxY Receive the max value of the histogram's Y-Axial
intervalNum Receive number of intervals between minY and maxY

mitkVolume* mitkHistogram2D::GetSourceVolumeX  )  [inline]
 

Get the first volume (the X-Axial volume)

Returns:
Return the first volume

mitkVolume* mitkHistogram2D::GetSourceVolumeY  )  [inline]
 

Get the second volume (the Y-Axial volume)

Returns:
Return the second volume

double mitkHistogram2D::GetStandardDeviationX  ) 
 

Get the standard deviation of pixel value within the specified extent, of VolumeX, this will trigger the calculation

Returns:
Return the standard deviation of pixel value within the specified extent

double mitkHistogram2D::GetStandardDeviationY  ) 
 

Get the standard deviation of pixel value within the specified extent, of VolumeY, this will trigger the calculation

Returns:
Return the standard deviation of pixel value within the specified extent

unsigned long* mitkHistogram2D::GetStatistics  ) 
 

Get histogram statistics, this will trigger the calculation

Returns:
Return the histogram statistics, the array is as large as intervalNumX*intervalNumY

unsigned long mitkHistogram2D::GetTotalPixels  ) 
 

Get the total number of pixels within the specified extent

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

bool mitkHistogram2D::IsModified  ) 
 

Get the modified status of the histogram

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

void mitkHistogram2D::SetRange double  minX,
double  maxX,
unsigned int  intervalNumX,
double  minY,
double  maxY,
unsigned int  intervalNumY
 

////////////////// Set the value range and interval where to calculate statistics, this will allocate memory for statistics

Parameters:
minX Specify the min value of the histogram's X-Axial
maxX Specify the max value of the histogram's X-Axial
intervalNum Specify number of intervals between minX and maxX
minY Specify the min value of the histogram's Y-Axial
maxY Specify the max value of the histogram's Y-Axial
intervalNum Specify number of intervals between minY and maxY

void mitkHistogram2D::SetSourceVolumeX mitkVolume vol,
int  chIdx = 1,
unsigned int *  extent = NULL
 

Set the first volume (the X-Axial volume)

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, 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 mitkHistogram2D::SetSourceVolumeY mitkVolume vol,
int  chIdx = 1,
unsigned int *  extent = NULL
 

Set the second volume (the Y-Axial volume)

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, 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 mitkHistogram2D::SetUnmodified  ) 
 

Set the modified status the false


The documentation for this class was generated from the following file:
Generated on Tue Feb 25 15:03:05 2014 for MITK (Medical Imaging ToolKit) by  doxygen 1.4.3