VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkImageHistogramStatistics Class Reference

Compute statistics for an image. More...

#include <vtkImageHistogramStatistics.h>

Inheritance diagram for vtkImageHistogramStatistics:
[legend]
Collaboration diagram for vtkImageHistogramStatistics:
[legend]

Public Types

typedef vtkImageHistogram Superclass
 
- Public Types inherited from vtkImageHistogram
typedef vtkThreadedImageAlgorithm Superclass
 
enum  { Linear = 0, Log = 1, Sqrt = 2 }
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkImageHistogramStatisticsNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
double GetMinimum ()
 
double GetMaximum ()
 
double GetMean ()
 
double GetMedian ()
 
double GetStandardDeviation ()
 
virtual void SetAutoRangePercentiles (double, double)
 
void SetAutoRangePercentiles (double[2])
 
virtual double * GetAutoRangePercentiles ()
 
virtual void GetAutoRangePercentiles (double &, double &)
 
virtual void GetAutoRangePercentiles (double[2])
 
virtual void SetAutoRangeExpansionFactors (double, double)
 
void SetAutoRangeExpansionFactors (double[2])
 
virtual double * GetAutoRangeExpansionFactors ()
 
virtual void GetAutoRangeExpansionFactors (double &, double &)
 
virtual void GetAutoRangeExpansionFactors (double[2])
 
virtual double * GetAutoRange ()
 
virtual void GetAutoRange (double &, double &)
 
virtual void GetAutoRange (double[2])
 
- Public Member Functions inherited from vtkImageHistogram
vtkImageHistogramNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetStencilConnection (vtkAlgorithmOutput *algOutput)
 
vtkIdTypeArray * GetHistogram ()
 
vtkIdType GetTotal ()
 
virtual void SetActiveComponent (int)
 
virtual int GetActiveComponent ()
 
virtual void SetAutomaticBinning (int)
 
virtual void AutomaticBinningOn ()
 
virtual void AutomaticBinningOff ()
 
virtual int GetAutomaticBinning ()
 
virtual void SetMaximumNumberOfBins (int)
 
virtual int GetMaximumNumberOfBins ()
 
virtual void SetNumberOfBins (int)
 
virtual int GetNumberOfBins ()
 
virtual void SetBinOrigin (double)
 
virtual double GetBinOrigin ()
 
virtual void SetBinSpacing (double)
 
virtual double GetBinSpacing ()
 
void SetStencilData (vtkImageStencilData *stencil)
 
vtkImageStencilDataGetStencil ()
 
virtual void SetGenerateHistogramImage (int)
 
virtual void GenerateHistogramImageOn ()
 
virtual void GenerateHistogramImageOff ()
 
virtual int GetGenerateHistogramImage ()
 
virtual void SetHistogramImageSize (int, int)
 
void SetHistogramImageSize (int[2])
 
virtual int * GetHistogramImageSize ()
 
virtual void GetHistogramImageSize (int &, int &)
 
virtual void GetHistogramImageSize (int[2])
 
virtual void SetHistogramImageScale (int)
 
void SetHistogramImageScaleToLinear ()
 
void SetHistogramImageScaleToLog ()
 
void SetHistogramImageScaleToSqrt ()
 
virtual int GetHistogramImageScale ()
 
const char * GetHistogramImageScaleAsString ()
 
virtual void ThreadedRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int ext[6], int id)
 

Static Public Member Functions

static
vtkImageHistogramStatistics
New ()
 
static int IsTypeOf (const char *type)
 
static
vtkImageHistogramStatistics
SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageHistogram
static vtkImageHistogramNew ()
 
static int IsTypeOf (const char *type)
 
static vtkImageHistogramSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkImageHistogramStatistics ()
 
 ~vtkImageHistogramStatistics ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkImageHistogram
virtual int RequestUpdateExtent (vtkInformation *vtkNotUsed(request), vtkInformationVector **inInfo, vtkInformationVector *vtkNotUsed(outInfo))
 
virtual int RequestInformation (vtkInformation *vtkNotUsed(request), vtkInformationVector **inInfo, vtkInformationVector *vtkNotUsed(outInfo))
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
void ComputeImageScalarRange (vtkImageData *data, double range[2])
 
 vtkImageHistogram ()
 
 ~vtkImageHistogram ()
 

Protected Attributes

double Minimum
 
double Maximum
 
double Mean
 
double StandardDeviation
 
double Median
 
double AutoRange [2]
 
double AutoRangePercentiles [2]
 
double AutoRangeExpansionFactors [2]
 
- Protected Attributes inherited from vtkImageHistogram
int ActiveComponent
 
int AutomaticBinning
 
int MaximumNumberOfBins
 
int HistogramImageSize [2]
 
int HistogramImageScale
 
int GenerateHistogramImage
 
int NumberOfBins
 
double BinOrigin
 
double BinSpacing
 
vtkIdTypeArray * Histogram
 
vtkIdType Total
 
vtkIdType * ThreadOutput [VTK_MAX_THREADS]
 
int ThreadBinRange [VTK_MAX_THREADS][2]
 

Detailed Description

Compute statistics for an image.

vtkImageHistogramStatistics computes statistics such as mean, median, and standard deviation. These statistics are computed from the histogram of the image, rather than from the image itself, because this is more efficient than computing the statistics while traversing the pixels. If the input image is of type float or double, then the precision of the Mean, Median, and StandardDeviation will depend on the number of histogram bins. By default, 65536 bins are used for float data, giving at least 16 bits of precision.

Thanks:
Thanks to David Gobbi at the Seaman Family MR Centre and Dept. of Clinical Neurosciences, Foothills Medical Centre, Calgary, for providing this class.
Tests:
vtkImageHistogramStatistics (Tests)

Definition at line 43 of file vtkImageHistogramStatistics.h.

Member Typedef Documentation

Definition at line 47 of file vtkImageHistogramStatistics.h.

Constructor & Destructor Documentation

vtkImageHistogramStatistics::vtkImageHistogramStatistics ( )
protected
vtkImageHistogramStatistics::~vtkImageHistogramStatistics ( )
protected

Member Function Documentation

static vtkImageHistogramStatistics* vtkImageHistogramStatistics::New ( )
static
static int vtkImageHistogramStatistics::IsTypeOf ( const char *  type)
static
virtual int vtkImageHistogramStatistics::IsA ( const char *  type)
virtual

Reimplemented from vtkImageHistogram.

static vtkImageHistogramStatistics* vtkImageHistogramStatistics::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkImageHistogramStatistics::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageHistogram.

vtkImageHistogramStatistics* vtkImageHistogramStatistics::NewInstance ( ) const
void vtkImageHistogramStatistics::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
double vtkImageHistogramStatistics::GetMinimum ( )
inline

Get the minimum value present in the image. This value is computed when Update() is called.

Definition at line 53 of file vtkImageHistogramStatistics.h.

double vtkImageHistogramStatistics::GetMaximum ( )
inline

Get the maximum value present in the image. This value is computed when Update() is called.

Definition at line 57 of file vtkImageHistogramStatistics.h.

double vtkImageHistogramStatistics::GetMean ( )
inline

Get the mean value of the image. This value is computed when Update() is called.

Definition at line 61 of file vtkImageHistogramStatistics.h.

double vtkImageHistogramStatistics::GetMedian ( )
inline

Get the median value. This is computed when Update() is called.

Definition at line 64 of file vtkImageHistogramStatistics.h.

double vtkImageHistogramStatistics::GetStandardDeviation ( )
inline

Get the standard deviation of the values in the image. This is computed when Update() is called.

Definition at line 68 of file vtkImageHistogramStatistics.h.

virtual void vtkImageHistogramStatistics::SetAutoRangePercentiles ( double  ,
double   
)
virtual

Set the percentiles to use for automatic view range computation. This allows one to compute a range that does not include outliers that are significantly darker or significantly brighter than the rest of the pixels in the image. The default is to use the first percentile and the 99th percentile.

void vtkImageHistogramStatistics::SetAutoRangePercentiles ( double  [2])

Set the percentiles to use for automatic view range computation. This allows one to compute a range that does not include outliers that are significantly darker or significantly brighter than the rest of the pixels in the image. The default is to use the first percentile and the 99th percentile.

virtual double* vtkImageHistogramStatistics::GetAutoRangePercentiles ( )
virtual

Set the percentiles to use for automatic view range computation. This allows one to compute a range that does not include outliers that are significantly darker or significantly brighter than the rest of the pixels in the image. The default is to use the first percentile and the 99th percentile.

virtual void vtkImageHistogramStatistics::GetAutoRangePercentiles ( double &  ,
double &   
)
virtual

Set the percentiles to use for automatic view range computation. This allows one to compute a range that does not include outliers that are significantly darker or significantly brighter than the rest of the pixels in the image. The default is to use the first percentile and the 99th percentile.

virtual void vtkImageHistogramStatistics::GetAutoRangePercentiles ( double  [2])
virtual

Set the percentiles to use for automatic view range computation. This allows one to compute a range that does not include outliers that are significantly darker or significantly brighter than the rest of the pixels in the image. The default is to use the first percentile and the 99th percentile.

virtual void vtkImageHistogramStatistics::SetAutoRangeExpansionFactors ( double  ,
double   
)
virtual

Set lower and upper expansion factors to apply to the auto range that was computed from the AutoRangePercentiles. Any outliers that are within this expanded range will be included, even if they are beyond the percentile. This allows inclusion of values that are just slightly outside of the percentile, while rejecting values that are far beyond the percentile. The default is to expand the range by a factor of 0.1 at each end. The range will never be expanded beyond the Minimum or Maximum pixel values.

void vtkImageHistogramStatistics::SetAutoRangeExpansionFactors ( double  [2])

Set lower and upper expansion factors to apply to the auto range that was computed from the AutoRangePercentiles. Any outliers that are within this expanded range will be included, even if they are beyond the percentile. This allows inclusion of values that are just slightly outside of the percentile, while rejecting values that are far beyond the percentile. The default is to expand the range by a factor of 0.1 at each end. The range will never be expanded beyond the Minimum or Maximum pixel values.

virtual double* vtkImageHistogramStatistics::GetAutoRangeExpansionFactors ( )
virtual

Set lower and upper expansion factors to apply to the auto range that was computed from the AutoRangePercentiles. Any outliers that are within this expanded range will be included, even if they are beyond the percentile. This allows inclusion of values that are just slightly outside of the percentile, while rejecting values that are far beyond the percentile. The default is to expand the range by a factor of 0.1 at each end. The range will never be expanded beyond the Minimum or Maximum pixel values.

virtual void vtkImageHistogramStatistics::GetAutoRangeExpansionFactors ( double &  ,
double &   
)
virtual

Set lower and upper expansion factors to apply to the auto range that was computed from the AutoRangePercentiles. Any outliers that are within this expanded range will be included, even if they are beyond the percentile. This allows inclusion of values that are just slightly outside of the percentile, while rejecting values that are far beyond the percentile. The default is to expand the range by a factor of 0.1 at each end. The range will never be expanded beyond the Minimum or Maximum pixel values.

virtual void vtkImageHistogramStatistics::GetAutoRangeExpansionFactors ( double  [2])
virtual

Set lower and upper expansion factors to apply to the auto range that was computed from the AutoRangePercentiles. Any outliers that are within this expanded range will be included, even if they are beyond the percentile. This allows inclusion of values that are just slightly outside of the percentile, while rejecting values that are far beyond the percentile. The default is to expand the range by a factor of 0.1 at each end. The range will never be expanded beyond the Minimum or Maximum pixel values.

virtual double* vtkImageHistogramStatistics::GetAutoRange ( )
virtual

Get an automatically computed view range for the image, for use with the lookup table or image property that is used when viewing the image. The use of this range will avoid situations where an image looks too dark because a few pixels happen to be much brighter than the rest.

virtual void vtkImageHistogramStatistics::GetAutoRange ( double &  ,
double &   
)
virtual

Get an automatically computed view range for the image, for use with the lookup table or image property that is used when viewing the image. The use of this range will avoid situations where an image looks too dark because a few pixels happen to be much brighter than the rest.

virtual void vtkImageHistogramStatistics::GetAutoRange ( double  [2])
virtual

Get an automatically computed view range for the image, for use with the lookup table or image property that is used when viewing the image. The use of this range will avoid situations where an image looks too dark because a few pixels happen to be much brighter than the rest.

virtual int vtkImageHistogramStatistics::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Reimplemented from vtkImageHistogram.

Member Data Documentation

double vtkImageHistogramStatistics::Minimum
protected

Definition at line 110 of file vtkImageHistogramStatistics.h.

double vtkImageHistogramStatistics::Maximum
protected

Definition at line 111 of file vtkImageHistogramStatistics.h.

double vtkImageHistogramStatistics::Mean
protected

Definition at line 112 of file vtkImageHistogramStatistics.h.

double vtkImageHistogramStatistics::StandardDeviation
protected

Definition at line 113 of file vtkImageHistogramStatistics.h.

double vtkImageHistogramStatistics::Median
protected

Definition at line 114 of file vtkImageHistogramStatistics.h.

double vtkImageHistogramStatistics::AutoRange[2]
protected

Definition at line 116 of file vtkImageHistogramStatistics.h.

double vtkImageHistogramStatistics::AutoRangePercentiles[2]
protected

Definition at line 117 of file vtkImageHistogramStatistics.h.

double vtkImageHistogramStatistics::AutoRangeExpansionFactors[2]
protected

Definition at line 118 of file vtkImageHistogramStatistics.h.


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