Orfeo Toolbox  3.16
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer > Class Template Reference

This class is similar to the Histogram class. It however allows you to specify the histogram dimension at run time. (and is therefore not templated over the size of a measurement vector). Users who know that the length of a measurement vector will be fixed, for instance joint statistics on pixel values of 2 images, (where the dimension will be 2), etc should use the Histogram class instead. More...

#include <itkVariableDimensionHistogram.h>

+ Inheritance diagram for itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >:
+ Collaboration diagram for itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >:

List of all members.

Classes

class  ConstIterator
class  Iterator

Public Types

typedef std::vector
< BinMaxVectorType > 		BinMaxContainerType
typedef std::vector
< MeasurementType > 		BinMaxVectorType
typedef std::vector
< BinMinVectorType > 		BinMinContainerType
typedef std::vector
< MeasurementType > 		BinMinVectorType
typedef SmartPointer< const Self > ConstPointer
typedef
FrequencyContainerType::Pointer 		FrequencyContainerPointer
typedef TFrequencyContainer FrequencyContainerType
typedef
FrequencyContainerType::FrequencyType 		FrequencyType
typedef itk::Array< long > IndexType
typedef IndexType::ValueType IndexValueType
typedef
Superclass::InstanceIdentifier 		InstanceIdentifier
typedef TMeasurement MeasurementType
typedef
Superclass::MeasurementVectorSizeType 		MeasurementVectorSizeType
typedef
Superclass::MeasurementVectorType 		MeasurementVectorType
typedef SmartPointer< Self > Pointer
typedef VariableDimensionHistogram Self
typedef itk::Array< long > SizeType
typedef SizeType::ValueType SizeValueType
typedef Sample< Array
< TMeasurement > > 		Superclass
typedef
FrequencyContainerType::TotalFrequencyType 		TotalFrequencyType
typedef MeasurementVectorType ValueType

Public Member Functions

unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const
Iterator Begin ()
ConstIterator Begin () const
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
Iterator End ()
ConstIterator End () const
const MeasurementType & GetBinMax (const unsigned int dimension, const unsigned long nbin) const
const MeasurementType & GetBinMaxFromValue (const unsigned int dimension, const float value) const
const MeasurementType & GetBinMin (const unsigned int dimension, const unsigned long nbin) const
const MeasurementType & GetBinMinFromValue (const unsigned int dimension, const float value) const
virtual bool GetClipBinsAtEnds ()
Command * GetCommand (unsigned long tag)
bool GetDebug () const
const BinMaxVectorType & GetDimensionMaxs (const unsigned int dimension) const
const BinMinVectorType & GetDimensionMins (const unsigned int dimension) const
FrequencyType GetFrequency (const InstanceIdentifier &ident) const
FrequencyType GetFrequency (const IndexType &index) const
FrequencyType GetFrequency (const unsigned long n, const unsigned int dimension) const
MeasurementVectorType & GetHistogramMaxFromIndex (const IndexType &index)
MeasurementVectorType & GetHistogramMaxFromValue (const MeasurementVectorType &measurement)
MeasurementVectorType & GetHistogramMinFromIndex (const IndexType &index)
MeasurementVectorType & GetHistogramMinFromValue (const MeasurementVectorType &measurement)
bool GetIndex (const MeasurementVectorType &measurement, IndexType &index) const
const IndexType & GetIndex (const InstanceIdentifier &ident) const
InstanceIdentifier GetInstanceIdentifier (const IndexType &index) const
const BinMaxContainerType & GetMaxs () const
MeasurementType GetMeasurement (const unsigned long n, const unsigned int dimension) const
const MeasurementVectorType & GetMeasurementVector (const InstanceIdentifier &ident) const
const MeasurementVectorType & GetMeasurementVector (const IndexType &index) const
virtual MeasurementVectorSizeType GetMeasurementVectorSize () const
MetaDataDictionary & GetMetaDataDictionary (void)
const MetaDataDictionary & GetMetaDataDictionary (void) const
const BinMinContainerType & GetMins () const
virtual unsigned long GetMTime () const
virtual const char * GetNameOfClass () const
virtual int GetReferenceCount () const
SizeType GetSize () const
SizeValueType GetSize (const unsigned int dimension) const
TotalFrequencyType GetTotalFrequency () const
bool HasObserver (const EventObject &event) const
bool IncreaseFrequency (const InstanceIdentifier &ident, const FrequencyType value)
bool IncreaseFrequency (const IndexType &index, const FrequencyType value)
bool IncreaseFrequency (const MeasurementVectorType &measurement, const FrequencyType value)
void Initialize (const SizeType &size)
void Initialize (const SizeType &size, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound)
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
bool IsIndexOutOfBounds (const IndexType &index) const
virtual void Modified () const
void Print (std::ostream &os, Indent indent=0) const
double Quantile (const unsigned int dimension, const double &p) const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetBinMax (const unsigned int dimension, unsigned long nbin, const MeasurementType max)
void SetBinMin (const unsigned int dimension, const unsigned long nbin, const MeasurementType min)
virtual void SetClipBinsAtEnds (bool _arg)
void SetDebug (bool debugFlag) const
void SetFrequency (const FrequencyType value)
bool SetFrequency (const InstanceIdentifier &ident, const FrequencyType value)
bool SetFrequency (const IndexType &index, const FrequencyType value)
bool SetFrequency (const MeasurementVectorType &measurement, const FrequencyType value)
virtual void SetMeasurementVectorSize (const MeasurementVectorSizeType s)
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
void SetToZero ()
unsigned int Size () const
virtual void UnRegister () const

Static Public Member Functions

static void BreakOnError ()
static bool GetGlobalWarningDisplay ()
static void GlobalWarningDisplayOff ()
static void GlobalWarningDisplayOn ()
static Pointer New ()
static void SetGlobalWarningDisplay (bool flag)

Protected Types

typedef int InternalReferenceCountType

Protected Member Functions

 VariableDimensionHistogram ()
virtual ~VariableDimensionHistogram ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
bool PrintObservers (std::ostream &os, Indent indent) const
void PrintSelf (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
void SetMeasurementVectorSize (const MeasurementVectorSizeType)

Protected Attributes

InternalReferenceCountType m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
SizeType m_Size

Private Member Functions

 VariableDimensionHistogram (const Self &)
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
Array< InstanceIdentifier > m_OffsetTable
IndexType m_TempIndex
MeasurementVectorType m_TempMeasurementVector

Detailed Description

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
class itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >

This class is similar to the Histogram class. It however allows you to specify the histogram dimension at run time. (and is therefore not templated over the size of a measurement vector). Users who know that the length of a measurement vector will be fixed, for instance joint statistics on pixel values of 2 images, (where the dimension will be 2), etc should use the Histogram class instead.

This class stores measurement vectors in the context of n-dimensional histogram.

VariableDimensionHistogram 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.

See also:
Histogram, Sample, DenseFrequencyContainer, SparseFrequencyContainer

Definition at line 68 of file itkVariableDimensionHistogram.h.

Member Typedef Documentation

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef std::vector< BinMaxVectorType > itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::BinMaxContainerType

Definition at line 114 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef std::vector< MeasurementType > itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::BinMaxVectorType

Definition at line 112 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef std::vector< BinMinVectorType > itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::BinMinContainerType

Definition at line 113 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef std::vector< MeasurementType > itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::BinMinVectorType

bin min max value storage types

Definition at line 111 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef SmartPointer<const Self> itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::ConstPointer

Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >.

Definition at line 77 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef FrequencyContainerType::Pointer itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::FrequencyContainerPointer

Definition at line 96 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef TFrequencyContainer itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::FrequencyContainerType

frequency container typedef

Definition at line 95 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef FrequencyContainerType::FrequencyType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::FrequencyType

Frequency value and TotalFrequency type from superclass

Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >.

Definition at line 99 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef itk::Array< long > itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::IndexType

Index typedef support. An index is used to access pixel values.

Definition at line 103 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef IndexType::ValueType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::IndexValueType

Definition at line 104 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef Superclass::InstanceIdentifier itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::InstanceIdentifier

InstanceIdentifier typedef. This identifier is a unique sequential id for each measurement vector in a Sample subclass.

Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >.

Definition at line 90 of file itkVariableDimensionHistogram.h.

typedef int itk::LightObject::InternalReferenceCountType
protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef TMeasurement itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementType

type of an element of a measurement vector

Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >.

Definition at line 83 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef Superclass::MeasurementVectorSizeType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementVectorSizeType

Typedef for the length of each measurement vector

Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >.

Definition at line 91 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef Superclass::MeasurementVectorType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementVectorType

Common sample class typedefs

Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >.

Definition at line 89 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef SmartPointer<Self> itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Pointer

Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >.

Definition at line 76 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef VariableDimensionHistogram itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Self

Standard typedefs

Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >.

Definition at line 74 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef itk::Array< long > itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SizeType

size array type

Definition at line 107 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef SizeType::ValueType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SizeValueType

Definition at line 108 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef Sample< Array< TMeasurement > > itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Superclass

Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >.

Definition at line 75 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef FrequencyContainerType::TotalFrequencyType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::TotalFrequencyType

Total frequency type

Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >.

Definition at line 100 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
typedef MeasurementVectorType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::ValueType

Definition at line 92 of file itkVariableDimensionHistogram.h.

Constructor & Destructor Documentation

template<class TMeasurement , class TFrequencyContainer >
itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::VariableDimensionHistogram ( )
protected

Definition at line 29 of file itkVariableDimensionHistogram.txx.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
virtual itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::~VariableDimensionHistogram ( )
inlineprotectedvirtual

Definition at line 474 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::VariableDimensionHistogram ( const Self &  )
private

Member Function Documentation

unsigned long itk::Object::AddObserver ( const EventObject &  event,
Command *  cmd 
)
inherited

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver ( const EventObject &  event,
Command *  cmd 
) const
inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
Iterator itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Begin ( void  )
inline

Definition at line 450 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
ConstIterator itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Begin ( void  ) const
inline

Definition at line 461 of file itkVariableDimensionHistogram.h.

void itk::LightObject::BreakOnError ( )
staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
virtual::itk::LightObject::Pointer itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::CreateAnother ( void  ) const
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.

void itk::Object::DebugOff ( ) const
virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const
virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )
virtualinherited

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Delete a itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C++ delete method will not work with reference counting.

Definition at line 88 of file itkLightObject.cxx.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
Iterator itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::End ( void  )
inline

Definition at line 456 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
ConstIterator itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::End ( void  ) const
inline

Definition at line 467 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
const MeasurementType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetBinMax ( const unsigned int  dimension,
const unsigned long  nbin 
) const
inline

Get the maximum value of nth bin of dimension d

Definition at line 178 of file itkVariableDimensionHistogram.h.

template<class TMeasurement , class TFrequencyContainer >
const VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementType & itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetBinMaxFromValue ( const unsigned int  dimension,
const float  value 
) const
inline

Get the maximum of the bin along dimension d corresponding to a particular measurement.

Definition at line 351 of file itkVariableDimensionHistogram.txx.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
const MeasurementType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetBinMin ( const unsigned int  dimension,
const unsigned long  nbin 
) const
inline

Get the minimum value of nth bin of dimension d

Definition at line 173 of file itkVariableDimensionHistogram.h.

template<class TMeasurement , class TFrequencyContainer >
const VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementType & itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetBinMinFromValue ( const unsigned int  dimension,
const float  value 
) const
inline

Get the minimum of the bin along dimension d corresponding to a particular measurement.

Definition at line 320 of file itkVariableDimensionHistogram.txx.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
virtual bool itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetClipBinsAtEnds ( )
virtual

Is set to false if the bins at edges of the histogram extend to +/- infinity.

Command * itk::Object::GetCommand ( unsigned long  tag)
inherited

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::Object::GetDebug ( ) const
inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
const BinMaxVectorType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetDimensionMaxs ( const unsigned int  dimension) const
inline

Get the vector of maximums along a dimension

Definition at line 207 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
const BinMinVectorType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetDimensionMins ( const unsigned int  dimension) const
inline

Get the vector of bin minimums along a dimension

Definition at line 203 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
FrequencyType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetFrequency ( const InstanceIdentifier &  ident) const
inlinevirtual

Get the frequency of an instance indentifier

Implements itk::Statistics::Sample< Array< TMeasurement > >.

Definition at line 232 of file itkVariableDimensionHistogram.h.

template<class TMeasurement , class TFrequencyContainer >
VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::FrequencyType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetFrequency ( const IndexType &  index) const
inline

Get the frequency of an index

Definition at line 564 of file itkVariableDimensionHistogram.txx.

References itk::MeasurementVectorTraits::Assert().

template<class TMeasurement , class TFrequencyContainer >
VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::FrequencyType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetFrequency ( const unsigned long  n,
const unsigned int  dimension 
) const
inline

Get the frequency of a dimension's nth element.

Definition at line 588 of file itkVariableDimensionHistogram.txx.

bool itk::Object::GetGlobalWarningDisplay ( )
staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

template<class TMeasurement , class TFrequencyContainer >
VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementVectorType & itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetHistogramMaxFromIndex ( const IndexType &  index)
inline

Get the maximums of the bin corresponding to a particular index

Definition at line 441 of file itkVariableDimensionHistogram.txx.

References itk::MeasurementVectorTraits::Assert().

template<class TMeasurement , class TFrequencyContainer >
VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementVectorType & itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetHistogramMaxFromValue ( const MeasurementVectorType &  measurement)
inline

Get the maximums of the bin corresponding to a particular measurement

Definition at line 402 of file itkVariableDimensionHistogram.txx.

References itk::MeasurementVectorTraits::Assert().

template<class TMeasurement , class TFrequencyContainer >
VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementVectorType & itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetHistogramMinFromIndex ( const IndexType &  index)
inline

Get the minimums of the bin corresponding to a particular index

Definition at line 423 of file itkVariableDimensionHistogram.txx.

References itk::MeasurementVectorTraits::Assert().

template<class TMeasurement , class TFrequencyContainer >
VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementVectorType & itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetHistogramMinFromValue ( const MeasurementVectorType &  measurement)
inline

Get the minimums of the bin corresponding to a particular measurement

Definition at line 382 of file itkVariableDimensionHistogram.txx.

References itk::MeasurementVectorTraits::Assert().

template<class TMeasurement , class TFrequencyContainer >
bool itk::Statistics::VariableDimensionHistogram< 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

Definition at line 183 of file itkVariableDimensionHistogram.txx.

References itk::MeasurementVectorTraits::Assert().

template<class TMeasurement , class TFrequencyContainer >
const VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::IndexType & itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetIndex ( const InstanceIdentifier &  ident) const
inline

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

Definition at line 257 of file itkVariableDimensionHistogram.txx.

template<class TMeasurement , class TFrequencyContainer >
VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::InstanceIdentifier itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetInstanceIdentifier ( const IndexType &  index) const
inline

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

Definition at line 297 of file itkVariableDimensionHistogram.txx.

References itk::MeasurementVectorTraits::Assert().

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
const BinMaxContainerType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetMaxs ( ) const
inline

Method the maximums of the bins

Definition at line 214 of file itkVariableDimensionHistogram.h.

template<class TMeasurement , class TFrequencyContainer >
VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetMeasurement ( const unsigned long  n,
const unsigned int  dimension 
) const
inline

Get the measurement a bin along a specified dimension. This is the midpoint of the bin along that dimension.

Definition at line 577 of file itkVariableDimensionHistogram.txx.

template<class TMeasurement , class TFrequencyContainer >
const VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementVectorType & itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetMeasurementVector ( const InstanceIdentifier &  ident) const
inlinevirtual

Get the measurement of an instance identifier. This is the centroid of the bin.

Implements itk::Statistics::Sample< Array< TMeasurement > >.

Definition at line 478 of file itkVariableDimensionHistogram.txx.

template<class TMeasurement , class TFrequencyContainer >
const VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementVectorType & itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetMeasurementVector ( const IndexType &  index) const
inline

Get the measurement of an index. This is the centroid of the bin.

Definition at line 459 of file itkVariableDimensionHistogram.txx.

References itk::MeasurementVectorTraits::Assert().

virtual MeasurementVectorSizeType itk::Statistics::Sample< Array< TMeasurement > >::GetMeasurementVectorSize ( ) const
virtualinherited
MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void  )
inherited
Returns:
A reference to this objects MetaDataDictionary.
Warning:
This reference may be changed.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 532 of file itkObject.cxx.

References NULL.

Referenced by otb::RenderingImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData(), itk::Brains2MaskImageIO::CanReadFile(), otb::DataNode< TPrecision, VDimension, TValuePrecision >::CopyFieldList(), otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), otb::Image< TPixel, VImageDimension >::CopyInformation(), itk::GDCMImageIO::GetBodyPart(), itk::GDCMImageIO::GetInstitution(), itk::GDCMImageIO::GetManufacturer(), itk::GDCMImageIO::GetModality(), itk::GDCMImageIO::GetModel(), itk::GDCMImageIO::GetNumberOfSeriesInStudy(), itk::GDCMImageIO::GetNumberOfStudyRelatedSeries(), itk::GDCMImageIO::GetPatientAge(), itk::GDCMImageIO::GetPatientDOB(), itk::GDCMImageIO::GetPatientID(), itk::GDCMImageIO::GetPatientName(), itk::GDCMImageIO::GetPatientSex(), itk::GDCMImageIO::GetScanOptions(), itk::GDCMImageIO::GetStudyDate(), itk::GDCMImageIO::GetStudyDescription(), itk::GDCMImageIO::GetStudyID(), itk::GDCMImageIO::GetValueFromTag(), otb::GDALImageIO::InternalReadImageInformation(), itk::GDCMImageIO::InternalReadImageInformation(), otb::GDALImageIO::InternalWriteImageInformation(), otb::RAMDrivenAdaptativeStreamingManager< TImage >::PrepareStreaming(), itk::DICOMImageIO2::Read(), itk::DICOMImageIO2::ReadImageInformation(), itk::NrrdImageIO::ReadImageInformation(), otb::JPEG2000ImageIO::ReadImageInformation(), itk::MetaImageIO::ReadImageInformation(), itk::VoxBoCUBImageIO::ReadImageInformation(), itk::MRCImageIO::ReadImageInformation(), itk::IPLCommonImageIO::ReadImageInformation(), itk::PhilipsRECImageIO::ReadImageInformation(), itk::AnalyzeImageIO::ReadImageInformation(), itk::Bruker2DSEQImageIO::ReadImageInformation(), otb::ImageMetadataInterfaceBase::SetImage(), itk::NiftiImageIO::SetImageIOMetadataFromNIfTI(), otb::VectorDataToLabelImageFilter< TVectorData, TOutputImage >::SetOutputParametersFromImage(), itk::NrrdImageIO::Write(), itk::GDCMImageIO::Write(), and itk::PolygonGroupSpatialObjectXMLFileWriter::WriteFile().

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void  ) const
inherited
Returns:
A constant reference to this objects MetaDataDictionary.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 543 of file itkObject.cxx.

References NULL.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
const BinMinContainerType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetMins ( ) const
inline

Get the minimums of the bins

Definition at line 211 of file itkVariableDimensionHistogram.h.

unsigned long itk::Object::GetMTime ( void  ) const
virtualinherited

Return this objects modified time.

Return the modification for this object.

Reimplemented in itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ShiftScalePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::SpatialObject< TDimension >, itk::SpatialObject< 3 >, itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >, itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >, itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >, itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >, itk::DeformationFieldSource< TOutputImage >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::ImageSpatialObject< TDimension, unsigned char >, itk::MeshSpatialObject< TMesh >, and itk::SceneSpatialObject< TSpaceDimension >.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
virtual const char* itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >.

virtual int itk::LightObject::GetReferenceCount ( ) const
inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
SizeType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetSize ( void  ) const
inline

Get the size (N-dimensional) of the histogram

Definition at line 163 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
SizeValueType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetSize ( const unsigned int  dimension) const
inline

Get the size of histogram along a specified dimension

Definition at line 167 of file itkVariableDimensionHistogram.h.

template<class TMeasurement , class TFrequencyContainer >
VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::TotalFrequencyType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetTotalFrequency ( ) const
inlinevirtual

Get the total frequency in the histogram

Implements itk::Statistics::Sample< Array< TMeasurement > >.

Definition at line 617 of file itkVariableDimensionHistogram.txx.

static void itk::Object::GlobalWarningDisplayOff ( )
inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )
inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject &  event) const
inherited

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::IncreaseFrequency ( const InstanceIdentifier &  ident,
const FrequencyType  value 
)
inline

Increase the frequency of an instance identifier. Frequency is increased by the specified value. Returns false if the bin is out of bounds.

Definition at line 260 of file itkVariableDimensionHistogram.h.

template<class TMeasurement , class TFrequencyContainer >
bool itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::IncreaseFrequency ( const IndexType &  index,
const FrequencyType  value 
)
inline

Increase the frequency of an index. Frequency is increased by the specified value. Returns false if the bin is out of bounds.

Definition at line 531 of file itkVariableDimensionHistogram.txx.

References itk::MeasurementVectorTraits::Assert().

template<class TMeasurement , class TFrequencyContainer >
bool itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::IncreaseFrequency ( const MeasurementVectorType &  measurement,
const FrequencyType  value 
)
inline

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.

Definition at line 546 of file itkVariableDimensionHistogram.txx.

References itk::MeasurementVectorTraits::Assert().

template<class TMeasurement , class TFrequencyContainer >
void itk::Statistics::VariableDimensionHistogram< 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.

Definition at line 85 of file itkVariableDimensionHistogram.txx.

References itk::MeasurementVectorTraits::Assert(), and itk::Array< TValueType >::Size().

template<class TMeasurement , class TFrequencyContainer >
void itk::Statistics::VariableDimensionHistogram< 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.

Definition at line 142 of file itkVariableDimensionHistogram.txx.

References itk::MeasurementVectorTraits::Assert().

void itk::Object::InvokeEvent ( const EventObject &  event)
inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject &  event) const
inherited

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

Definition at line 457 of file itkObject.cxx.

template<class TMeasurement , class TFrequencyContainer >
bool itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::IsIndexOutOfBounds ( const IndexType &  index) const
inline

Returns true if the given index is out of bound meaning one of index is not between [0, last index]

Definition at line 276 of file itkVariableDimensionHistogram.txx.

References itk::MeasurementVectorTraits::Assert().

void itk::Object::Modified ( void  ) const
virtualinherited

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Make sure this object's modified time is greater than all others.

Reimplemented in otb::SVMModel< TValue, TLabel >, otb::SurfaceAdjacencyEffect6SCorrectionSchemeFilter< TInputImage, TOutputImage >, itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ShiftScalePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, otb::GenericRSTransform< TScalarType, NInputDimensions, NOutputDimensions >, otb::MeanShiftImageFilter< TInputImage, TOutputImage, TLabeledOutput, TBufferConverter >, otb::MeanShiftImageFilter< TInputImage, TOutputImage, TLabeledOutput, MeanShift::VectorBufferConverter >, otb::GCPsToRPCSensorModelImageFilter< TImage >, otb::Polygon< TValue >, otb::ImageRegionAdaptativeSplitter< VImageDimension >, otb::GenericInterpolateImageFunction< TInputImage, TFunction, TBoundaryCondition, TCoordRep >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, otb::PolyLineParametricPathWithValue< TValue, VDimension >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, otb::PolyLineParametricPathWithValue< TValue, 2 >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, otb::PhysicalToRPCSensorModelImageFilter< TImage >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, RankImageFilter< TInputImage, TInputImage, FlatStructuringElement< ::itk::GetImageDimension< TInputImage >::ImageDimension > > >, itk::NormalizeImageFilter< TInputImage, TOutputImage >, and otb::StatisticsXMLFileReader< TMeasurementVector >.

Definition at line 297 of file itkObject.cxx.

Referenced by otb::Wrapper::InputImageListParameter::AddFromFileName(), otb::Wrapper::InputVectorDataListParameter::AddFromFileName(), otb::Wrapper::InputImageListParameter::AddImage(), otb::Wrapper::InputImageListParameter::AddNullElement(), otb::Wrapper::InputVectorDataListParameter::AddNullElement(), otb::Wrapper::StringListParameter::AddNullElement(), otb::VectorDataModel::AddPointToGeometry(), otb::Wrapper::InputVectorDataListParameter::AddVectorData(), otb::Wrapper::InputImageListParameter::ClearValue(), otb::Wrapper::InputVectorDataListParameter::ClearValue(), otb::VectorDataModel::DeleteGeometry(), otb::VectorDataModel::EndGeometry(), otb::Wrapper::InputImageListParameter::Erase(), otb::Wrapper::InputVectorDataListParameter::Erase(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), otb::ImageWidget< TInputImage >::LinearInterpolationOff(), otb::ImageWidget< TInputImage >::LinearInterpolationOn(), itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >::MatrixOffsetTransformBase(), otb::ogr::ImageReference< double >::Modified(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetAutoMinMax(), otb::BlendingImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetBlendingFunction(), otb::ImageLayerGenerator< TImageLayer >::SetBlendingFunction(), otb::TileMapImageIO::SetCacheDirectory(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetChannelList(), itk::LBFGSBOptimizer::SetCostFunction(), itk::MINC2ImageIO::SetDimensionName(), itk::ImageIOBase::SetDimensions(), itk::ImageIOBase::SetDirection(), otb::Wrapper::InputImageListParameter::SetImageList(), itk::GDCMSeriesFileNames::SetInputDirectory(), otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::SetInputHistogram(), otb::ImageToGenericRSOutputParameters< TImage >::SetInputKeywordList(), otb::Wrapper::InputVectorDataListParameter::SetListFromFileName(), otb::Wrapper::InputImageListParameter::SetListFromFileName(), otb::Function::RenderingFunction< TPixel, TRGBPixel >::SetListSample(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), otb::Wrapper::InputImageListParameter::SetNthFileName(), otb::Wrapper::InputVectorDataListParameter::SetNthFileName(), itk::ImageIOBase::SetNumberOfDimensions(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ImageIOBase::SetOrigin(), otb::ImageToGenericRSOutputParameters< TImage >::SetOutputProjectionRef(), otb::MapProjectionAdapter::SetParameter(), otb::Function::GaussianRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetParameters(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetParameters(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), otb::ImageLayerGenerator< TImageLayer >::SetRenderingFunction(), otb::RenderingImageFilter< TInputImage, TOutputImage >::SetRenderingFunction(), itk::ImageIOBase::SetSpacing(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation(), otb::Wrapper::OutputFilenameParameter::SetValue(), otb::Wrapper::InputFilenameParameter::SetValue(), otb::Wrapper::ListViewParameter::SetValue(), otb::Wrapper::ChoiceParameter::SetValue(), otb::Wrapper::InputVectorDataListParameter::SetVectorDataList(), and otb::MapProjectionAdapter::SetWkt().

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
static Pointer itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::New ( )
static

standard New() method support

Reimplemented from itk::Object.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
void itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::operator= ( const Self &  )
private

Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >.

void itk::LightObject::Print ( std::ostream &  os,
Indent  indent = 0 
) const
inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader ( std::ostream &  os,
Indent  indent 
) const
protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

bool itk::Object::PrintObservers ( std::ostream &  os,
Indent  indent 
) const
protectedinherited

Definition at line 478 of file itkObject.cxx.

template<class TMeasurement , class TFrequencyContainer >
void itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
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.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >.

Definition at line 687 of file itkVariableDimensionHistogram.txx.

void itk::LightObject::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const
protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

template<class TMeasurement , class TFrequencyContainer >
double itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Quantile ( const unsigned int  dimension,
const 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

Definition at line 626 of file itkVariableDimensionHistogram.txx.

void itk::Object::Register ( ) const
virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

void itk::Object::RemoveAllObservers ( )
inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::Object::RemoveObserver ( unsigned long  tag)
inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
void itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetBinMax ( const unsigned int  dimension,
unsigned long  nbin,
const MeasurementType  max 
)
inline

Set the maximum value of nth bin of dimension d

Definition at line 188 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
void itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetBinMin ( const unsigned int  dimension,
const unsigned long  nbin,
const MeasurementType  min 
)
inline

Set the minimum value of nth bin of dimension d

Definition at line 183 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
virtual void itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetClipBinsAtEnds ( bool  _arg)
virtual

Set to false to have the bins at edges of the histogram extend to +/- infinity.

void itk::Object::SetDebug ( bool  debugFlag) const
inherited

Set the value of the debug flag. A non-zero value turns debugging on.

Definition at line 275 of file itkObject.cxx.

template<class TMeasurement , class TFrequencyContainer >
void itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetFrequency ( const FrequencyType  value)
inline

Set all the bins in the histogram to a specified frequency

Definition at line 487 of file itkVariableDimensionHistogram.txx.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetFrequency ( const InstanceIdentifier &  ident,
const FrequencyType  value 
)
inline

Set the frequency of an instance identifier. Returns false if the bin is out of bounds.

Definition at line 243 of file itkVariableDimensionHistogram.h.

template<class TMeasurement , class TFrequencyContainer >
bool itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetFrequency ( const IndexType &  index,
const FrequencyType  value 
)
inline

Set the frequency of an index. Returns false if the bin is out of bounds.

Definition at line 503 of file itkVariableDimensionHistogram.txx.

References itk::MeasurementVectorTraits::Assert().

template<class TMeasurement , class TFrequencyContainer >
bool itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetFrequency ( const MeasurementVectorType &  measurement,
const FrequencyType  value 
)
inline

Set the frequency of a measurement. Returns false if the bin is out of bounds.

Definition at line 516 of file itkVariableDimensionHistogram.txx.

References itk::MeasurementVectorTraits::Assert().

void itk::Object::SetGlobalWarningDisplay ( bool  val)
staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

virtual void itk::Statistics::Sample< Array< TMeasurement > >::SetMeasurementVectorSize ( const MeasurementVectorSizeType  s)
inlinevirtualinherited

Set/Get macros for the length of the measurement vector

Definition at line 113 of file itkSample.h.

template<class TMeasurement , class TFrequencyContainer >
void itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetMeasurementVectorSize ( const MeasurementVectorSizeType  s)
protected

Set the length of each measurement vector = dimension of the histogram. The method will destructively set the size of all other parameters of the histogram. This method should be called only from the Initialize() method.

Definition at line 38 of file itkVariableDimensionHistogram.txx.

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary &  rhs)
inherited
Returns:
Set the MetaDataDictionary

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 554 of file itkObject.cxx.

References NULL.

Referenced by otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), and otb::Image< TPixel, VImageDimension >::CopyInformation().

void itk::Object::SetReferenceCount ( int  ref)
virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

template<class TMeasurement , class TFrequencyContainer >
void itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetToZero ( )

Initialize the values of the histogram bins to zero

Definition at line 133 of file itkVariableDimensionHistogram.txx.

template<class TMeasurement , class TFrequencyContainer >
unsigned int itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Size ( void  ) const
virtual

Returns the number of instances (bins or cells) in this container

Implements itk::Statistics::Sample< Array< TMeasurement > >.

Definition at line 66 of file itkVariableDimensionHistogram.txx.

void itk::Object::UnRegister ( ) const
virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().

Member Data Documentation

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::m_ClipBinsAtEnds
private

Definition at line 501 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
FrequencyContainerPointer itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::m_FrequencyContainer
private

Definition at line 489 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
std::vector< std::vector<MeasurementType> > itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::m_Max
private

Definition at line 496 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
std::vector< std::vector<MeasurementType> > itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::m_Min
private

Definition at line 493 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
unsigned int itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::m_NumberOfInstances
private

Definition at line 490 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
Array< InstanceIdentifier > itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::m_OffsetTable
private

Definition at line 488 of file itkVariableDimensionHistogram.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount
mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock
mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
SizeType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::m_Size
protected

Definition at line 482 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
IndexType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::m_TempIndex
mutableprivate

Definition at line 499 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
MeasurementVectorType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::m_TempMeasurementVector
mutableprivate

Definition at line 498 of file itkVariableDimensionHistogram.h.

The documentation for this class was generated from the following files:
Generated at Sun Feb 3 2013 03:02:47 for Orfeo Toolbox with doxygen 1.8.1.1