Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer > Class Template Reference

#include <itkHistogram.h>

Inheritance diagram for itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >:

Inheritance graph
[legend]
Collaboration diagram for itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
class itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >

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 can set the second template parameter to 0. This can conveniently be obtained from MeasurementVectorTraits. For instance, instantiate a histogram as below:

 typedef Histogram< THistogramMeasurement, typename 
      MeasurementVectorTraits< MeasurementVectorType >::MeasurementVectorLength,
      TFrequencyContainer > HistogramType;

See also:
Sample, DenseFrequencyContainer, SparseFrequencyContainer

Definition at line 82 of file itkHistogram.h.

Public Types

typedef std::vector< BinMaxVectorTypeBinMaxContainerType
typedef std::vector< MeasurementTypeBinMaxVectorType
typedef std::vector< BinMinVectorTypeBinMinContainerType
typedef std::vector< MeasurementTypeBinMinVectorType
typedef SmartPointer< const
Self
ConstPointer
typedef FrequencyContainerType::Pointer FrequencyContainerPointer
typedef TFrequencyContainer FrequencyContainerType
typedef FrequencyContainerType::FrequencyType FrequencyType
typedef itk::Index< VMeasurementVectorSize > IndexType
typedef IndexType::IndexValueType IndexValueType
typedef Superclass::InstanceIdentifier InstanceIdentifier
typedef TMeasurement MeasurementType
typedef Superclass::MeasurementVectorSizeType MeasurementVectorSizeType
typedef Superclass::MeasurementVectorType MeasurementVectorType
typedef SmartPointer< SelfPointer
typedef Histogram Self
typedef itk::Size< VMeasurementVectorSize > SizeType
typedef SizeType::SizeValueType SizeValueType
typedef Sample< FixedArray<
TMeasurement, VMeasurementVectorSize > > 
Superclass
typedef FrequencyContainerType::TotalFrequencyType TotalFrequencyType
typedef MeasurementVectorType ValueType

Public Member Functions

ConstIterator Begin () const
Iterator Begin ()
virtual LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
ConstIterator End () const
Iterator End ()
const MeasurementTypeGetBinMax (const unsigned int dimension, const unsigned long nbin) const
const MeasurementTypeGetBinMaxFromValue (const unsigned int dimension, const float value) const
const MeasurementTypeGetBinMin (const unsigned int dimension, const unsigned long nbin) const
const MeasurementTypeGetBinMinFromValue (const unsigned int dimension, const float value) const
virtual bool GetClipBinsAtEnds ()
CommandGetCommand (unsigned long tag)
bool GetDebug () const
const BinMaxVectorTypeGetDimensionMaxs (const unsigned int dimension) const
const BinMinVectorTypeGetDimensionMins (const unsigned int dimension) const
virtual FrequencyType GetFrequency (const InstanceIdentifier &id) const=0
FrequencyType GetFrequency (const unsigned long n, const unsigned int dimension) const
FrequencyType GetFrequency (const IndexType &index) const
FrequencyType GetFrequency (const InstanceIdentifier &id) const
MeasurementVectorTypeGetHistogramMaxFromIndex (const IndexType &index)
MeasurementVectorTypeGetHistogramMinFromIndex (const IndexType &index)
const IndexTypeGetIndex (const InstanceIdentifier &id) const
bool GetIndex (const MeasurementVectorType &measurement, IndexType &index) const
const IndexTypeGetIndex (const MeasurementVectorType &measurement) const
InstanceIdentifier GetInstanceIdentifier (const IndexType &index) const
const BinMaxContainerTypeGetMaxs () const
MeasurementType GetMeasurement (const unsigned long n, const unsigned int dimension) const
virtual const MeasurementVectorTypeGetMeasurementVector (const InstanceIdentifier &id) const=0
const MeasurementVectorTypeGetMeasurementVector (const IndexType &index) const
const MeasurementVectorTypeGetMeasurementVector (const InstanceIdentifier &id) const
MeasurementVectorSizeType GetMeasurementVectorSize () const
const MetaDataDictionaryGetMetaDataDictionary (void) const
MetaDataDictionaryGetMetaDataDictionary (void)
const BinMinContainerTypeGetMins () const
virtual unsigned long GetMTime () const
virtual const char * GetNameOfClass () const
virtual int GetReferenceCount () const
SizeValueType GetSize (const unsigned int dimension) const
SizeType GetSize () const
TotalFrequencyType GetTotalFrequency () const
bool HasObserver (const EventObject &event) const
bool IncreaseFrequency (const MeasurementVectorType &measurement, const FrequencyType value)
bool IncreaseFrequency (const IndexType &index, const FrequencyType value)
bool IncreaseFrequency (const InstanceIdentifier &id, const FrequencyType value)
void Initialize (const SizeType &size, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound)
void Initialize (const SizeType &size)
void InvokeEvent (const EventObject &) const
void InvokeEvent (const EventObject &)
bool IsIndexOutOfBounds (const IndexType &index) const
 itkStaticConstMacro (MeasurementVectorSize, unsigned int, VMeasurementVectorSize)
virtual void Modified () const
void Print (std::ostream &os, Indent indent=0) 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
bool SetFrequency (const MeasurementVectorType &measurement, const FrequencyType value)
bool SetFrequency (const IndexType &index, const FrequencyType value)
bool SetFrequency (const InstanceIdentifier &id, const FrequencyType value)
void SetFrequency (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
unsigned long AddObserver (const EventObject &event, Command *) const
unsigned long AddObserver (const EventObject &event, Command *)
double Quantile (const unsigned int dimension, const double &p) const
virtual void SetMeasurementVectorSize (const MeasurementVectorSizeType s)

Static Public Member Functions

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

Protected Types

typedef int InternalReferenceCountType

Protected Member Functions

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

Protected Attributes

InternalReferenceCountType m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
SizeType m_Size

Classes

class  ConstIterator
class  Iterator


Member Typedef Documentation

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef std::vector< BinMaxVectorType > itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::BinMaxContainerType

Definition at line 134 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef std::vector< MeasurementType > itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::BinMaxVectorType

Definition at line 132 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef std::vector< BinMinVectorType > itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::BinMinContainerType

Definition at line 133 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef std::vector< MeasurementType > itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::BinMinVectorType

bin min max value storage types

Definition at line 131 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef SmartPointer<const Self> itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::ConstPointer

Reimplemented from itk::Statistics::Sample< TMeasurementVector >.

Definition at line 92 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef FrequencyContainerType::Pointer itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::FrequencyContainerPointer

Definition at line 116 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef TFrequencyContainer itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::FrequencyContainerType

frequency container typedef

Definition at line 115 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef FrequencyContainerType::FrequencyType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::FrequencyType

Frequency and TotalFrequency value type from superclass

Reimplemented from itk::Statistics::Sample< TMeasurementVector >.

Definition at line 119 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef itk::Index< VMeasurementVectorSize > itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::IndexType

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

Definition at line 123 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef IndexType::IndexValueType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::IndexValueType

Definition at line 124 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef Superclass::InstanceIdentifier itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::InstanceIdentifier

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

Reimplemented from itk::Statistics::Sample< TMeasurementVector >.

Definition at line 110 of file itkHistogram.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

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

Definition at line 139 of file itkLightObject.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef TMeasurement itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::MeasurementType

type of an element of a measurement vector

Reimplemented from itk::Statistics::Sample< TMeasurementVector >.

Definition at line 106 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef Superclass::MeasurementVectorSizeType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::MeasurementVectorSizeType

Typedef for the length of each measurement vector

Reimplemented from itk::Statistics::Sample< TMeasurementVector >.

Definition at line 112 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef Superclass::MeasurementVectorType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::MeasurementVectorType

Common sample class typedefs

Reimplemented from itk::Statistics::Sample< TMeasurementVector >.

Definition at line 109 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef SmartPointer<Self> itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::Pointer

Reimplemented from itk::Statistics::Sample< TMeasurementVector >.

Definition at line 91 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef Histogram itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::Self

Standard typedefs

Reimplemented from itk::Statistics::Sample< TMeasurementVector >.

Definition at line 89 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef itk::Size< VMeasurementVectorSize > itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::SizeType

size array type

Definition at line 127 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef SizeType::SizeValueType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::SizeValueType

Definition at line 128 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef Sample< FixedArray< TMeasurement, VMeasurementVectorSize > > itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::Superclass

Reimplemented from itk::Statistics::Sample< TMeasurementVector >.

Definition at line 90 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef FrequencyContainerType::TotalFrequencyType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::TotalFrequencyType

Total frequency type

Reimplemented from itk::Statistics::Sample< TMeasurementVector >.

Definition at line 120 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef MeasurementVectorType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::ValueType

Definition at line 111 of file itkHistogram.h.


Constructor & Destructor Documentation

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::Histogram (  )  [protected]

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
virtual itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::~Histogram (  )  [inline, protected, virtual]

Definition at line 514 of file itkHistogram.h.


Member Function Documentation

unsigned long itk::Object::AddObserver ( const EventObject event,
Command  
) const [inherited]

unsigned long itk::Object::AddObserver ( const EventObject event,
Command  
) [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

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
ConstIterator itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::Begin ( void   )  const [inline]

Definition at line 486 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
Iterator itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::Begin ( void   )  [inline]

Definition at line 475 of file itkHistogram.h.

static void itk::LightObject::BreakOnError (  )  [static, inherited]

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

virtual LightObject::Pointer itk::Object::CreateAnother (  )  const [virtual, inherited]

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::LightObject.

virtual void itk::Object::DebugOff (  )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (  )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (  )  [virtual, inherited]

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.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
ConstIterator itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::End ( void   )  const [inline]

Definition at line 492 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
Iterator itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::End ( void   )  [inline]

Definition at line 481 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const MeasurementType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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 203 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const MeasurementType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetBinMaxFromValue ( const unsigned int  dimension,
const float  value 
) const

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

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const MeasurementType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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 198 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const MeasurementType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetBinMinFromValue ( const unsigned int  dimension,
const float  value 
) const

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

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
virtual bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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.

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

Get the value of the debug flag.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const BinMaxVectorType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetDimensionMaxs ( const unsigned int  dimension  )  const [inline]

Get the vector of maximums along a dimension

Definition at line 232 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const BinMinVectorType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetDimensionMins ( const unsigned int  dimension  )  const [inline]

Get the vector of bin minimums along a dimension

Definition at line 228 of file itkHistogram.h.

template<class TMeasurementVector>
virtual FrequencyType itk::Statistics::Sample< TMeasurementVector >::GetFrequency ( const InstanceIdentifier id  )  const [pure virtual, inherited]

Get the frequency of a measurement specified by instance identifier.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
FrequencyType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetFrequency ( const unsigned long  n,
const unsigned int  dimension 
) const

Get the frequency of a dimension's nth element.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
FrequencyType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetFrequency ( const IndexType index  )  const

Get the frequency of an index

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
FrequencyType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetFrequency ( const InstanceIdentifier id  )  const [inline]

Get the frequency of an instance indentifier

Definition at line 259 of file itkHistogram.h.

static bool itk::Object::GetGlobalWarningDisplay (  )  [static, inherited]

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
MeasurementVectorType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetHistogramMaxFromIndex ( const IndexType index  ) 

Get the maximums of the bin corresponding to a particular index

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
MeasurementVectorType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetHistogramMinFromIndex ( const IndexType index  ) 

Get the minimums of the bin corresponding to a particular index

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const IndexType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetIndex ( const 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

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const IndexType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetIndex ( const MeasurementVectorType measurement  )  const

Get the index of a measurement value from the histogram.

Deprecated:
Use GetIndex(const MeasurementVectorType & measurement, IndexType & index ) const instead.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
InstanceIdentifier itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const BinMaxContainerType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetMaxs (  )  const [inline]

Method the maximums of the bins

Definition at line 240 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
MeasurementType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetMeasurement ( const unsigned long  n,
const unsigned int  dimension 
) const

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

template<class TMeasurementVector>
virtual const MeasurementVectorType& itk::Statistics::Sample< TMeasurementVector >::GetMeasurementVector ( const InstanceIdentifier id  )  const [pure virtual, inherited]

Get the measurement associated with a particular InstanceIdentifier.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const MeasurementVectorType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetMeasurementVector ( const IndexType index  )  const

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

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const MeasurementVectorType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetMeasurementVector ( const InstanceIdentifier id  )  const

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

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
MeasurementVectorSizeType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetMeasurementVectorSize (  )  const [inline, virtual]

Reimplemented from itk::Statistics::Sample< TMeasurementVector >.

Definition at line 506 of file itkHistogram.h.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void   )  const [inherited]

Returns:
A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void   )  [inherited]

Returns:
A reference to this objects MetaDataDictionary.
Warning:
This reference may be changed.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const BinMinContainerType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetMins (  )  const [inline]

Get the minimums of the bins

Definition at line 236 of file itkHistogram.h.

virtual unsigned long itk::Object::GetMTime (  )  const [virtual, inherited]

Return this objects modified time.

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

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
virtual const char* itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetNameOfClass (  )  const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::Statistics::Sample< TMeasurementVector >.

virtual int itk::LightObject::GetReferenceCount (  )  const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
SizeValueType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetSize ( const unsigned int  dimension  )  const [inline]

Get the size of histogram along a specified dimension

Definition at line 192 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
SizeType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetSize ( void   )  const [inline]

Get the size (N-dimensional) of the histogram

Definition at line 188 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
TotalFrequencyType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetTotalFrequency (  )  const [virtual]

Get the total frequency in the histogram

Implements itk::Statistics::Sample< TMeasurementVector >.

static void itk::Object::GlobalWarningDisplayOff (  )  [inline, static, inherited]

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (  )  [inline, static, inherited]

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.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::IncreaseFrequency ( const MeasurementVectorType measurement,
const FrequencyType  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.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::IncreaseFrequency ( const IndexType index,
const FrequencyType  value 
)

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

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::IncreaseFrequency ( const InstanceIdentifier id,
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 287 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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::Object::InvokeEvent ( const EventObject  )  const [inherited]

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

void itk::Object::InvokeEvent ( const EventObject  )  [inherited]

Call Execute on all the Commands observing this event id.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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]

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::itkStaticConstMacro ( MeasurementVectorSize  ,
unsigned  int,
VMeasurementVectorSize   
)

Dimension of a measurement vector

virtual void itk::Object::Modified (  )  const [virtual, inherited]

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

Reimplemented in itk::NormalizeImageFilter< TInputImage, TOutputImage >, itk::ImageAdaptor< TImage, TAccessor >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, and itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, itk::RankImageFilter< TInputImage, TInputImage, itk::FlatStructuringElement< ::itk::GetImageDimension< TInputImage >::ImageDimension > > >.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
static Pointer itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::New (  )  [static]

standard New() method support

Reimplemented from itk::Object.

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

Cause the object to print itself out.

Referenced by itk::WeakPointer< itk::ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader ( std::ostream &  os,
Indent  indent 
) const [protected, virtual, inherited]

bool itk::Object::PrintObservers ( std::ostream &  os,
Indent  indent 
) const [protected, inherited]

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, 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 itk::Statistics::Sample< TMeasurementVector >.

virtual void itk::LightObject::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const [protected, virtual, inherited]

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
double itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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

virtual void itk::Object::Register (  )  const [virtual, inherited]

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

Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (  )  [inherited]

Remove all observers .

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

Remove the observer with this tag value.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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 213 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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 208 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
virtual void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::SetFrequency ( const MeasurementVectorType measurement,
const FrequencyType  value 
)

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

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::SetFrequency ( const IndexType index,
const FrequencyType  value 
)

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

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::SetFrequency ( const InstanceIdentifier id,
const FrequencyType  value 
) [inline]

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

Definition at line 270 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::SetFrequency ( const FrequencyType  value  ) 

Set all the bins in the histogram to a specified frequency

static void itk::Object::SetGlobalWarningDisplay ( bool  flag  )  [static, inherited]

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

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

template<class TMeasurementVector>
virtual void itk::Statistics::Sample< TMeasurementVector >::SetMeasurementVectorSize ( const MeasurementVectorSizeType  s  )  [inline, virtual, inherited]

Set/Get macros for the length of the measurement vector

Definition at line 113 of file itkSample.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
virtual void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::SetMeasurementVectorSize ( const MeasurementVectorSizeType  s  )  [inline, virtual]

Definition at line 497 of file itkHistogram.h.

References itkExceptionMacro.

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary rhs  )  [inherited]

Returns:
Set the MetaDataDictionary

virtual void itk::Object::SetReferenceCount ( int   )  [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::SetToZero (  ) 

Initialize the values of the histogram bins to zero

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
unsigned int itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::Size (  )  const [virtual]

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

Implements itk::Statistics::Sample< TMeasurementVector >.

virtual void itk::Object::UnRegister (  )  const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.


Member Data Documentation

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
SizeType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::m_Size [protected]

Definition at line 517 of file itkHistogram.h.


The documentation for this class was generated from the following file:
Generated at Thu Nov 6 14:22:09 2008 for ITK by doxygen 1.5.1 written by Dimitri van Heesch, © 1997-2000