Compute statistics for an image. More...
#include <vtkImageHistogramStatistics.h>
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.
Definition at line 42 of file vtkImageHistogramStatistics.h.
Member Typedef Documentation
Reimplemented from vtkImageHistogram.
Definition at line 46 of file vtkImageHistogramStatistics.h.
Constructor & Destructor Documentation
| vtkImageHistogramStatistics::vtkImageHistogramStatistics | ( | ) | [protected] |
| vtkImageHistogramStatistics::~vtkImageHistogramStatistics | ( | ) | [protected] |
Member Function Documentation
| static vtkImageHistogramStatistics* vtkImageHistogramStatistics::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkImageHistogram.
| virtual const char* vtkImageHistogramStatistics::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkImageHistogram.
| static int vtkImageHistogramStatistics::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkImageHistogram.
| virtual int vtkImageHistogramStatistics::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkImageHistogram.
| static vtkImageHistogramStatistics* vtkImageHistogramStatistics::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkImageHistogram.
| void vtkImageHistogramStatistics::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkImageHistogram.
| double vtkImageHistogramStatistics::GetMinimum | ( | ) | [inline] |
Get the minimum value present in the image. This value is computed when Update() is called.
Definition at line 52 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 56 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 60 of file vtkImageHistogramStatistics.h.
| double vtkImageHistogramStatistics::GetMedian | ( | ) | [inline] |
Get the median value. This is computed when Update() is called.
Definition at line 63 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 67 of file vtkImageHistogramStatistics.h.
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.
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.
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 * | request, |
| vtkInformationVector ** | inputVector, | ||
| vtkInformationVector * | outputVector | ||
| ) | [protected, virtual] |
This is called by the superclass. This is the method you should override.
Reimplemented from vtkImageHistogram.
Member Data Documentation
double vtkImageHistogramStatistics::Minimum [protected] |
Definition at line 109 of file vtkImageHistogramStatistics.h.
double vtkImageHistogramStatistics::Maximum [protected] |
Definition at line 110 of file vtkImageHistogramStatistics.h.
double vtkImageHistogramStatistics::Mean [protected] |
Definition at line 111 of file vtkImageHistogramStatistics.h.
double vtkImageHistogramStatistics::StandardDeviation [protected] |
Definition at line 112 of file vtkImageHistogramStatistics.h.
double vtkImageHistogramStatistics::Median [protected] |
Definition at line 113 of file vtkImageHistogramStatistics.h.
double vtkImageHistogramStatistics::AutoRange[2] [protected] |
Definition at line 115 of file vtkImageHistogramStatistics.h.
double vtkImageHistogramStatistics::AutoRangePercentiles[2] [protected] |
Definition at line 116 of file vtkImageHistogramStatistics.h.
double vtkImageHistogramStatistics::AutoRangeExpansionFactors[2] [protected] |
Definition at line 117 of file vtkImageHistogramStatistics.h.
The documentation for this class was generated from the following file:
- dox/Imaging/vtkImageHistogramStatistics.h
