ITK
4.4.0
Insight Segmentation and Registration Toolkit
|
#include <itkHistogram.h>
This class stores measurement vectors in the context of n-dimensional histogram.
Histogram represents an ND histogram. Histogram bins can be regularly or irregularly spaced. The storage for the histogram is managed via the FrequencyContainer specified by the template argument. The default frequency container is a DenseFrequencyContainer. A SparseFrequencyContainer can be used as an alternative.
Frequencies of a bin (SetFrequency(), IncreaseFrequency()) can be specified by measurement, index, or instance identifier.
Measurements can be queried by bin index or instance identifier. In this case, the measurement returned in the centroid of the histogram bin.
The Initialize() method is used to specified the number of bins for each dimension of the histogram. An overloaded version also allows for regularly spaced bins to defined. To define irregularly sized bins, use the SetBinMin()/SetBinMax() methods.
If you do not know the length of the measurement vector at compile time, you should use the VariableDimensionHistogram class, instead of the Histogram class.
If you know the length of the measuremen vector at compile time, you can conveniently be obtained from MeasurementVectorTraits. For instance, instantiate a histogram as below:
Definition at line 77 of file itkHistogram.h.
Classes | |
class | ConstIterator |
class | Iterator |
Static Public Member Functions | |
static Pointer | New () |
Protected Member Functions | |
Histogram () | |
void | PrintSelf (std::ostream &os, Indent indent) const |
virtual | ~Histogram () |
Protected Member Functions inherited from itk::Statistics::Sample< Array< TMeasurement > > | |
void | PrintSelf (std::ostream &os, Indent indent) const |
Sample () | |
virtual | ~Sample () |
Protected Member Functions inherited from itk::DataObject | |
DataObject () | |
virtual void | PropagateResetPipeline () |
~DataObject () | |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
virtual void | SetTimeStamp (const TimeStamp &time) |
virtual | ~Object () |
Protected Member Functions inherited from itk::LightObject | |
virtual LightObject::Pointer | InternalClone () const |
LightObject () | |
virtual void | PrintHeader (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Protected Attributes | |
SizeType | m_Size |
Private Types | |
typedef std::vector < InstanceIdentifier > | OffsetTableType |
Private Member Functions | |
Histogram (const Self &) | |
virtual void | Initialize () |
void | operator= (const Self &) |
Private Attributes | |
bool | m_ClipBinsAtEnds |
FrequencyContainerPointer | m_FrequencyContainer |
std::vector< std::vector < MeasurementType > > | m_Max |
std::vector< std::vector < MeasurementType > > | m_Min |
unsigned int | m_NumberOfInstances |
OffsetTableType | m_OffsetTable |
IndexType | m_TempIndex |
MeasurementVectorType | m_TempMeasurementVector |
Additional Inherited Members | |
Protected Types inherited from itk::LightObject | |
typedef int | InternalReferenceCountType |
typedef FrequencyContainerType::AbsoluteFrequencyType itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::AbsoluteFrequencyType |
Frequency and TotalFrequency value type from superclass
Definition at line 112 of file itkHistogram.h.
typedef Array< TMeasurement > itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::ArrayType |
Definition at line 83 of file itkHistogram.h.
typedef std::vector< BinMaxVectorType > itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::BinMaxContainerType |
Definition at line 129 of file itkHistogram.h.
typedef std::vector< MeasurementType > itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::BinMaxVectorType |
Definition at line 127 of file itkHistogram.h.
typedef std::vector< BinMinVectorType > itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::BinMinContainerType |
Definition at line 128 of file itkHistogram.h.
typedef std::vector< MeasurementType > itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::BinMinVectorType |
bin min max value storage types
Definition at line 126 of file itkHistogram.h.
typedef SmartPointer< const Self > itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::ConstPointer |
Definition at line 89 of file itkHistogram.h.
typedef FrequencyContainerType::Pointer itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::FrequencyContainerPointer |
Definition at line 109 of file itkHistogram.h.
typedef TFrequencyContainer itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::FrequencyContainerType |
frequency container typedef
Definition at line 108 of file itkHistogram.h.
typedef Array< ::itk::IndexValueType > itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::IndexType |
Index typedef support. An index is used to access pixel values.
Definition at line 118 of file itkHistogram.h.
typedef IndexType::ValueType itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::IndexValueType |
Definition at line 119 of file itkHistogram.h.
typedef Superclass::InstanceIdentifier itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::InstanceIdentifier |
Definition at line 102 of file itkHistogram.h.
typedef TMeasurement itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::MeasurementType |
type of an element of a measurement vector
Definition at line 95 of file itkHistogram.h.
typedef Superclass::MeasurementVectorSizeType itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::MeasurementVectorSizeType |
Definition at line 103 of file itkHistogram.h.
typedef Superclass::MeasurementVectorType itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::MeasurementVectorType |
Common sample class typedefs
Definition at line 101 of file itkHistogram.h.
|
private |
Definition at line 498 of file itkHistogram.h.
typedef SmartPointer< Self > itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::Pointer |
Definition at line 88 of file itkHistogram.h.
typedef FrequencyContainerType::RelativeFrequencyType itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::RelativeFrequencyType |
Definition at line 114 of file itkHistogram.h.
typedef Histogram itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::Self |
Standard typedefs
Definition at line 86 of file itkHistogram.h.
typedef Array< ::itk::SizeValueType > itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::SizeType |
size array type
Definition at line 122 of file itkHistogram.h.
typedef SizeType::ValueType itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::SizeValueType |
Definition at line 123 of file itkHistogram.h.
typedef Sample< ArrayType > itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::Superclass |
Definition at line 87 of file itkHistogram.h.
typedef FrequencyContainerType::TotalAbsoluteFrequencyType itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::TotalAbsoluteFrequencyType |
Definition at line 113 of file itkHistogram.h.
typedef FrequencyContainerType::TotalRelativeFrequencyType itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::TotalRelativeFrequencyType |
Definition at line 115 of file itkHistogram.h.
typedef MeasurementVectorType itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::ValueType |
Definition at line 105 of file itkHistogram.h.
|
protected |
|
inlineprotectedvirtual |
Definition at line 489 of file itkHistogram.h.
|
private |
|
inline |
Definition at line 463 of file itkHistogram.h.
|
inline |
Definition at line 475 of file itkHistogram.h.
|
virtual |
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.
Reimplemented from itk::Object.
|
inline |
Definition at line 470 of file itkHistogram.h.
|
inline |
Definition at line 482 of file itkHistogram.h.
const MeasurementType& itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetBinMax | ( | unsigned int | dimension, |
InstanceIdentifier | nbin | ||
) | const |
Get the maximum value of nth bin of dimension d
const MeasurementType& itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetBinMaxFromValue | ( | unsigned int | dimension, |
float | value | ||
) | const |
Get the maximum of the bin along dimension d corresponding to a particular measurement.
const MeasurementType& itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetBinMin | ( | unsigned int | dimension, |
InstanceIdentifier | nbin | ||
) | const |
Get the minimum value of nth bin of dimension d
const MeasurementType& itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetBinMinFromValue | ( | unsigned int | dimension, |
float | value | ||
) | const |
Get the minimum of the bin along dimension d corresponding to a particular measurement.
|
virtual |
Is set to false if the bins at edges of the histogram extend to +/- infinity.
const BinMaxVectorType& itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetDimensionMaxs | ( | unsigned int | dimension | ) | const |
Get the vector of maximums along a dimension
const BinMinVectorType& itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetDimensionMins | ( | unsigned int | dimension | ) | const |
Get the vector of bin minimums along a dimension
AbsoluteFrequencyType itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetFrequency | ( | InstanceIdentifier | id | ) | const |
Get the frequency of an instance identifier
AbsoluteFrequencyType itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetFrequency | ( | const IndexType & | index | ) | const |
Get the frequency of an index
AbsoluteFrequencyType itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetFrequency | ( | InstanceIdentifier | n, |
unsigned int | dimension | ||
) | const |
Get the frequency of a dimension's nth element.
const MeasurementVectorType& itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetHistogramMaxFromIndex | ( | const IndexType & | index | ) | const |
Get the maximums of the bin corresponding to a particular index
const MeasurementVectorType& itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetHistogramMinFromIndex | ( | const IndexType & | index | ) | const |
Get the minimums of the bin corresponding to a particular index
bool itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetIndex | ( | const MeasurementVectorType & | measurement, |
IndexType & | index | ||
) | const |
Get the index of histogram corresponding to the specified measurement value. Returns true if index is valid and false if the measurement is outside the histogram
const IndexType& itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetIndex | ( | InstanceIdentifier | id | ) | const |
Get the index that is uniquely labelled by an instance identifier The corresponding id is the offset of the index This method uses ImageBase::ComputeIndex() method
InstanceIdentifier itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetInstanceIdentifier | ( | const IndexType & | index | ) | const |
Get the instance identifier of the bin that is indexed by the index. The corresponding instance identifier is the offset of the index This method uses ImageBase::ComputeIndex() method
const BinMaxContainerType& itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetMaxs | ( | ) | const |
Method the maximums of the bins
MeasurementType itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetMeasurement | ( | InstanceIdentifier | n, |
unsigned int | dimension | ||
) | const |
Get the measurement a bin along a specified dimension. This is the midpoint of the bin along that dimension.
const MeasurementVectorType& itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetMeasurementVector | ( | InstanceIdentifier | id | ) | const |
Get the measurement of an instance identifier. This is the centroid of the bin.
const MeasurementVectorType& itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetMeasurementVector | ( | const IndexType & | index | ) | const |
Get the measurement of an index. This is the centroid of the bin.
const BinMinContainerType& itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetMins | ( | ) | const |
Get the minimums of the bins
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >.
const SizeType& itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetSize | ( | ) | const |
Get the size (N-dimensional) of the histogram
SizeValueType itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::GetSize | ( | unsigned int | dimension | ) | const |
Get the size of histogram along a specified dimension
|
virtual |
Get the total frequency in the histogram
Implements itk::Statistics::Sample< Array< TMeasurement > >.
|
virtual |
Method to graft another histogram's output
Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >.
bool itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::IncreaseFrequency | ( | InstanceIdentifier | id, |
AbsoluteFrequencyType | value | ||
) |
Increase the frequency of an instance identifier. Frequency is increased by the specified value. Returns false if the bin is out of bounds.
bool itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::IncreaseFrequencyOfIndex | ( | const IndexType & | index, |
AbsoluteFrequencyType | value | ||
) |
Increase the frequency of an index. Frequency is increased by the specified value. Returns false if the bin is out of bounds.
bool itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::IncreaseFrequencyOfMeasurement | ( | const MeasurementVectorType & | measurement, |
AbsoluteFrequencyType | value | ||
) |
Increase the frequency of a measurement. Frequency is increased by the specified value. Returns false if the measurement is outside the bounds of the histogram.
void itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::Initialize | ( | const SizeType & | size | ) |
Initialize the histogram, generating the offset table and preparing the frequency container. Subclasses should call this method in their Initialize() method.
void itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::Initialize | ( | const SizeType & | size, |
MeasurementVectorType & | lowerBound, | ||
MeasurementVectorType & | upperBound | ||
) |
Initialize the histogram using equal size bins. To assign bin's min and max values along each dimension use SetBinMin() and SetBinMax() functions.
|
inlineprivatevirtual |
Restore the data object to its initial state. This means releasing memory.
Reimplemented from itk::DataObject.
Definition at line 505 of file itkHistogram.h.
bool itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::IsIndexOutOfBounds | ( | const IndexType & | index | ) | const |
Returns true if the given index is out of bound meaning one of index is not between [0, last index]
itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::itkLegacyMacro | ( | const IndexType &GetIndex(const MeasurementVectorType &measurement) | const | ) |
Get the index of a measurement value from the histogram.
double itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::Mean | ( | unsigned int | dimension | ) | const |
Get the mean value for a dimension
|
static |
standard New() method support
|
private |
|
protectedvirtual |
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 itk::DataObject.
double itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::Quantile | ( | unsigned int | dimension, |
double | p | ||
) | const |
Get the pth percentile value for a dimension.
Let assume n = the index of the bin where the p-th percentile value is, min = min value of the dimension of the bin, max = max value of the dimension of the bin, interval = max - min , pp = cumlated proportion until n-1 bin; and pb = frequency of the bin / total frequency of the dimension. If p is less than 0.5, the percentile value = min + ((p - pp ) / pb) * interval If p is greater than or equal to 0.5 the percentile value = max - ((pp - p) / pb) * interval
void itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::SetBinMax | ( | unsigned int | dimension, |
InstanceIdentifier | nbin, | ||
MeasurementType | max | ||
) |
Set the maximum value of nth bin of dimension d
void itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::SetBinMin | ( | unsigned int | dimension, |
InstanceIdentifier | nbin, | ||
MeasurementType | min | ||
) |
Set the minimum value of nth bin of dimension d
|
virtual |
Set to false to have the bins at edges of the histogram extend to +/- infinity.
void itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::SetFrequency | ( | AbsoluteFrequencyType | value | ) |
Set all the bins in the histogram to a specified frequency
bool itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::SetFrequency | ( | InstanceIdentifier | id, |
AbsoluteFrequencyType | value | ||
) |
Set the frequency of an instance identifier. Returns false if the bin is out of bounds.
bool itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::SetFrequencyOfIndex | ( | const IndexType & | index, |
AbsoluteFrequencyType | value | ||
) |
Set the frequency of an index. Returns false if the bin is out of bounds.
bool itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::SetFrequencyOfMeasurement | ( | const MeasurementVectorType & | measurement, |
AbsoluteFrequencyType | value | ||
) |
Set the frequency of a measurement. Returns false if the bin is out of bounds.
void itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >::SetToZero | ( | ) |
Initialize the values of the histogram bins to zero
|
virtual |
Returns the number of instances (bins or cells) in this container
Implements itk::Statistics::Sample< Array< TMeasurement > >.
|
private |
Definition at line 516 of file itkHistogram.h.
|
private |
Definition at line 500 of file itkHistogram.h.
|
private |
Definition at line 511 of file itkHistogram.h.
|
private |
Definition at line 508 of file itkHistogram.h.
|
private |
Definition at line 501 of file itkHistogram.h.
|
private |
Definition at line 499 of file itkHistogram.h.
|
protected |
Definition at line 492 of file itkHistogram.h.
|
mutableprivate |
Definition at line 514 of file itkHistogram.h.
|
mutableprivate |
Definition at line 513 of file itkHistogram.h.