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

[legend]

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

[legend]

List of all members.

Classes
class	ConstIterator
class	Iterator
Public Types
typedef MeasurementVectorTraits::AbsoluteFrequencyType	AbsoluteFrequencyType
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 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 SmartPointer< Self >	Pointer
typedef VariableDimensionHistogram	Self
typedef DataObject	Self
typedef itk::Array< long >	SizeType
typedef SizeType::ValueType	SizeValueType
typedef Object	Superclass
typedef Sample< Array < TMeasurement > >	Superclass
typedef NumericTraits < AbsoluteFrequencyType > ::AccumulateType	TotalAbsoluteFrequencyType
typedef FrequencyContainerType::TotalFrequencyType	TotalFrequencyType
typedef MeasurementVectorType	ValueType
Public Member Functions
Iterator	Begin ()
ConstIterator	Begin () const
virtual void	CopyInformation (const DataObject *)
virtual LightObject::Pointer	CreateAnother () const
void	DataHasBeenGenerated ()
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
void	DisconnectPipeline ()
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)
Command *	GetCommand (unsigned long tag)
bool	GetDataReleased () const
bool	GetDebug () const
bool	GetDebug () const
const BinMaxVectorType &	GetDimensionMaxs (const unsigned int dimension) const
const BinMinVectorType &	GetDimensionMins (const unsigned int dimension) const
FrequencyType	GetFrequency (const unsigned long n, const unsigned int dimension) const
virtual AbsoluteFrequencyType	GetFrequency (InstanceIdentifier id) const =0
virtual FrequencyType	GetFrequency (const InstanceIdentifier &id) const =0
FrequencyType	GetFrequency (const InstanceIdentifier &ident) const
FrequencyType	GetFrequency (const IndexType &index) const
MeasurementVectorType &	GetHistogramMaxFromIndex (const IndexType &index)
MeasurementVectorType &	GetHistogramMaxFromValue (const MeasurementVectorType &measurement)
MeasurementVectorType &	GetHistogramMinFromIndex (const IndexType &index)
MeasurementVectorType &	GetHistogramMinFromValue (const MeasurementVectorType &measurement)
const IndexType &	GetIndex (const InstanceIdentifier &ident) const
bool	GetIndex (const MeasurementVectorType &measurement, IndexType &index) 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 const MeasurementVectorType &	GetMeasurementVector (const InstanceIdentifier &id) const =0
virtual const MeasurementVectorType &	GetMeasurementVector (InstanceIdentifier id) const =0
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
const BinMinContainerType &	GetMins () const
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
SizeType	GetSize () const
SizeValueType	GetSize (const unsigned int dimension) const
SmartPointerForwardReference < ProcessObject >	GetSource () const
unsigned int	GetSourceOutputIndex () const
TotalFrequencyType	GetTotalFrequency () const
virtual unsigned long	GetUpdateMTime () const
virtual void	Graft (const DataObject *thatObject)
virtual void	Graft (const DataObject *)
bool	HasObserver (const EventObject &event) 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)
virtual void	Initialize ()
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
bool	IsIndexOutOfBounds (const IndexType &index) const
virtual void	Modified () const
virtual void	PrepareForNewData ()
void	Print (std::ostream &os, Indent indent=0) const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	ReleaseData ()
void	RemoveAllObservers ()
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	RemoveObserver (unsigned long tag)
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual void	ResetPipeline ()
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	SetDebug (bool debugFlag) const
bool	SetFrequency (const IndexType &index, const FrequencyType value)
bool	SetFrequency (const MeasurementVectorType &measurement, const FrequencyType value)
void	SetFrequency (const FrequencyType value)
bool	SetFrequency (const InstanceIdentifier &ident, const FrequencyType value)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	SetRequestedRegion (DataObject *)
virtual void	SetRequestedRegionToLargestPossibleRegion ()
void	SetToZero ()
bool	ShouldIReleaseData () const
unsigned int	Size () const
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateOutputInformation ()
virtual bool	VerifyRequestedRegion ()


double	Quantile (const unsigned int dimension, const double &p) const


virtual void	SetMeasurementVectorSize (const MeasurementVectorSizeType s)
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const


void	SetReleaseDataFlag (bool flag)
virtual const bool &	GetReleaseDataFlag ()
virtual void	ReleaseDataFlagOn ()
virtual void	ReleaseDataFlagOff ()


virtual void	PropagateRequestedRegion () throw (InvalidRequestedRegionError)
virtual void	UpdateOutputData ()


void	SetPipelineMTime (unsigned long time)
virtual const unsigned long &	GetPipelineMTime ()


unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
Static Public Member Functions
static void	BreakOnError ()
static void	BreakOnError ()
static Pointer	New ()


static void	SetGlobalReleaseDataFlag (bool val)
static bool	GetGlobalReleaseDataFlag ()
static void	GlobalReleaseDataFlagOn ()
static void	GlobalReleaseDataFlagOff ()


static void	SetGlobalWarningDisplay (bool flag)
static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOff ()
Protected Types


typedef int	InternalReferenceCountType
typedef int	InternalReferenceCountType
Protected Member Functions
bool	PrintObservers (std::ostream &os, Indent indent) const
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
void	SetMeasurementVectorSize (const MeasurementVectorSizeType)
	VariableDimensionHistogram ()
virtual	~VariableDimensionHistogram ()


virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
InternalReferenceCountType	m_ReferenceCount
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
SimpleFastMutexLock	m_ReferenceCountLock
SizeType	m_Size

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

typedef MeasurementVectorTraits::AbsoluteFrequencyType itk::Statistics::Sample< Array< TMeasurement > >::AbsoluteFrequencyType [inherited]

Frequency value type

Definition at line 84 of file Review/Statistics/itkSample.h.

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.

typedef SmartPointer<const Self> itk::DataObject::ConstPointer [inherited]

Reimplemented from itk::Object.

Definition at line 269 of file itkDataObject.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 [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.

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

typedef SmartPointer<Self> itk::DataObject::Pointer [inherited]

Reimplemented from itk::Object.

Definition at line 268 of file itkDataObject.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.

typedef DataObject itk::DataObject::Self [inherited]

Standard class typedefs.

Reimplemented from itk::Object.

Definition at line 266 of file itkDataObject.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.

typedef Object itk::DataObject::Superclass [inherited]

Reimplemented from itk::Object.

Definition at line 267 of file itkDataObject.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.

typedef NumericTraits<AbsoluteFrequencyType>::AccumulateType itk::Statistics::Sample< Array< TMeasurement > >::TotalAbsoluteFrequencyType [inherited]

Total frequency type

Definition at line 87 of file Review/Statistics/itkSample.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 = float, class TFrequencyContainer = DenseFrequencyContainer>

itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::VariableDimensionHistogram ( ) [protected]

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

virtual itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::~VariableDimensionHistogram ( ) [inline, protected, virtual]

Definition at line 476 of file itkVariableDimensionHistogram.h.

Member Function Documentation

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

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

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

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[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, class TFrequencyContainer = DenseFrequencyContainer>

ConstIterator itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Begin ( void ) const [inline]

Definition at line 463 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

Iterator itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Begin ( void ) [inline]

Definition at line 452 of file itkVariableDimensionHistogram.h.

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

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

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

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

virtual void itk::DataObject::CopyInformation ( const DataObject * ) [inline, virtual, inherited]

Copy information from the specified data set. This method is part of the pipeline execution model. By default, a ProcessObject will copy meta-data from the first input to all of its outputs. See ProcessObject::GenerateOutputInformation(). Each subclass of DataObject is responsible for being able to copy whatever meta-data it needs from from another DataObject. The default implementation of this method is empty. If a subclass overrides this method, it should always call its superclass' version.

Definition at line 439 of file itkDataObject.h.

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.

void itk::DataObject::DataHasBeenGenerated ( ) [inherited]

Inform the pipeline mechanism that data has been generated. This method is called by ProcessObject::UpdateOutputData() once the process object has finished generating its data. This essentially marks the DataObject as being updated and ready for use.

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.

void itk::DataObject::DisconnectPipeline ( ) [inherited]

Separate this data object from the pipeline. This routine disconnects a data object from the upstream pipeline. Hence an Update() from downstream will not propagate back past this data object. To completely isolate this data object from the pipeline, the application must remove this data object from any filters which it is connected as the input.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

Iterator itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::End ( void ) [inline]

Definition at line 458 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

ConstIterator itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::End ( void ) const [inline]

Definition at line 469 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 = float, class TFrequencyContainer = DenseFrequencyContainer>

const MeasurementType& itk::Statistics::VariableDimensionHistogram< TMeasurement, 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, 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 = float, class TFrequencyContainer = DenseFrequencyContainer>

const MeasurementType& itk::Statistics::VariableDimensionHistogram< TMeasurement, 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, 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.

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::DataObject::GetDataReleased ( ) const [inline, inherited]

Get the flag indicating the data has been released.

Definition at line 334 of file itkDataObject.h.

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

Get the value of the debug flag.

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

Get the value of the debug flag.

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 unsigned long	n,
		const unsigned int	dimension
	)			const

Get the frequency of a dimension's nth element.

virtual FrequencyType itk::Statistics::Sample< Array< TMeasurement > >::GetFrequency ( const InstanceIdentifier & id ) const [pure virtual, inherited]

Get the frequency of a measurement specified by instance identifier.

virtual AbsoluteFrequencyType itk::Statistics::Sample< Array< TMeasurement > >::GetFrequency ( InstanceIdentifier id ) const [pure virtual, inherited]

Get the frequency of a measurement specified by instance identifier.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

FrequencyType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetFrequency ( const InstanceIdentifier & ident ) const [inline]

Get the frequency of an instance indentifier

Definition at line 233 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

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

Get the frequency of an index

static bool itk::DataObject::GetGlobalReleaseDataFlag ( ) [static, inherited]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

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

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

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

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

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

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

Get the maximums of the bin corresponding to a particular index

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

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

Get the maximums of the bin corresponding to a particular measurement

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

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

Get the minimums of the bin corresponding to a particular index

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

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

Get the minimums of the bin corresponding to a particular measurement

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

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

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

const IndexType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetIndex ( const InstanceIdentifier & ident ) 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, class TFrequencyContainer = DenseFrequencyContainer>

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

Get the instance identifier of the bin that is indexed by the index. The corresponding instance identifier is the offset of the index This method uses ImageBase::ComputeIndex() method

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 215 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

MeasurementType itk::Statistics::VariableDimensionHistogram< TMeasurement, 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 TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

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

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

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

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

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

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

Get the measurement associated with a particular InstanceIdentifier.

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

Get the measurement associated with a particular InstanceIdentifier.

virtual MeasurementVectorSizeType itk::Statistics::Sample< Array< TMeasurement > >::GetMeasurementVectorSize ( ) const [virtual, inherited]

Set/Get macros for the length of the measurement vector

virtual MeasurementVectorSizeType itk::Statistics::Sample< Array< TMeasurement > >::GetMeasurementVectorSize ( ) const [virtual, inherited]

Get method for the length of the measurement vector

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

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

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.

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

Returns:: A constant reference to this objects MetaDataDictionary.

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.

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

Return this objects modified time.

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

virtual const char* itk::DataObject::GetNameOfClass ( ) const [virtual, inherited]

Run-time type information (and related methods).

Reimplemented from itk::Object.

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 const unsigned long& itk::DataObject::GetPipelineMTime ( ) [virtual, inherited]

The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object.

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

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

virtual const bool& itk::DataObject::GetReleaseDataFlag ( ) [virtual, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

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.

SmartPointerForwardReference<ProcessObject> itk::DataObject::GetSource ( ) const [inherited]

Get the process object that generated this data object. If there is no process object, then the data object has been disconnected from the pipeline, or the data object was created manually. (Note: we cannot use the GetObjectMacro() defined in itkMacro because the mutual dependency of DataObject and ProcessObject causes compile problems. Also, a forward reference smart pointer is returned, not a smart pointer, because of the circular dependency between the process and data object.)

GetSource() returns a SmartPointerForwardReference and not a WeakPointer because it is assumed the code calling GetSource() wants to hold a long term reference to the source.

unsigned int itk::DataObject::GetSourceOutputIndex ( ) const [inherited]

Which of the source's outputs corresponds to this data object?

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

TotalFrequencyType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetTotalFrequency ( ) const [virtual]

Get the total frequency in the histogram

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

virtual unsigned long itk::DataObject::GetUpdateMTime ( ) const [virtual, inherited]

MTime for the last time this DataObject was generated.

static void itk::DataObject::GlobalReleaseDataFlagOff ( ) [inline, static, inherited]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

Definition at line 319 of file itkDataObject.h.

static void itk::DataObject::GlobalReleaseDataFlagOn ( ) [inline, static, inherited]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

Definition at line 317 of file itkDataObject.h.

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

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

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

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

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

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

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

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

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

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

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

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

virtual void itk::Statistics::Sample< Array< TMeasurement > >::Graft ( const DataObject * thatObject ) [inline, virtual, inherited]

Method to graft another sample

Definition at line 161 of file Review/Statistics/itkSample.h.

virtual void itk::DataObject::Graft ( const DataObject * ) [inline, virtual, inherited]

Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.

Definition at line 453 of file itkDataObject.h.

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

Return true if an observer is registered for this event.

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

Return true if an observer is registered for this event.

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 261 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

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

bool itk::Statistics::VariableDimensionHistogram< TMeasurement, 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.

virtual void itk::DataObject::Initialize ( ) [virtual, inherited]

Restore the data object to its initial state. This means releasing memory.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

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.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

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.

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.

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

Call Execute on all the Commands observing this event id.

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.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

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

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

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.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), 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(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

static Pointer itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::New ( ) [static]

standard New() method support

Reimplemented from itk::Object.

virtual void itk::DataObject::PrepareForNewData ( ) [inline, virtual, inherited]

Setup a DataObject to receive new data. This method is called by the pipeline mechanism on each output of filter that needs to execute. The default implementation is to return a DataObject to its initial state. This may involve releasing previously allocated bulk data. Subclasses of DataObject may want to override this method and/or the Initialize() method if they want a different default behavior (for instance a DataObject might want finer control over its bulk data memory management).

Definition at line 389 of file itkDataObject.h.

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

Cause the object to print itself out.

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

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

Cause the object to print itself out.

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

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

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.

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

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

void itk::DataObject::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

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

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

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.

virtual void itk::DataObject::PropagateRequestedRegion ( ) throw (InvalidRequestedRegionError) [virtual, inherited]

Methods to update the pipeline. Called internally by the pipeline mechanism.

virtual void itk::DataObject::PropagateResetPipeline ( ) [protected, virtual, inherited]

Propagate a call to ResetPipeline(). Called only from ProcessObject.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

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

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

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

Reimplemented from itk::LightObject.

void itk::DataObject::ReleaseData ( ) [inherited]

Release data back to system to conserve memory resource. Used during pipeline execution. Releasing this data does not make down-stream data invalid, so it does not modify the MTime of this data object.

virtual void itk::DataObject::ReleaseDataFlagOff ( ) [virtual, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

virtual void itk::DataObject::ReleaseDataFlagOn ( ) [virtual, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

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

Remove all observers .

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

Remove all observers .

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

Remove the observer with this tag value.

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

Remove the observer with this tag value.

virtual bool itk::DataObject::RequestedRegionIsOutsideOfTheBufferedRegion ( ) [inline, virtual, inherited]

Determine whether the RequestedRegion is outside of the BufferedRegion. This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute

Reimplemented in itk::ImageBase< VImageDimension >, itk::PointSet< TPixelType, VDimension, TMeshTraits >, itk::QuadEdgeMesh< TPixel, VDimension, TTraits >, itk::SpatialObject< TDimension >, itk::ImageBase< ::itk::GetImageDimension< TLabelObject >::ImageDimension >, itk::ImageBase< ::itk::GetImageDimension< VectorImage< TPixelType, Dimension > >::ImageDimension >, itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >, itk::PointSet< TPixel, VDimension, TTraits >, itk::PointSet< TCoordType, VDimension, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >, itk::SpatialObject< 3 >, and itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >.

Definition at line 413 of file itkDataObject.h.

virtual void itk::DataObject::ResetPipeline ( ) [virtual, inherited]

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

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.

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, 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 244 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

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

Set all the bins in the histogram to a specified frequency

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

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

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

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

static void itk::DataObject::SetGlobalReleaseDataFlag ( bool val ) [static, inherited]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

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().

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().

virtual void itk::Statistics::Sample< Array< TMeasurement > >::SetMeasurementVectorSize ( const MeasurementVectorSizeType s ) [inline, virtual, inherited]

Set/Get macros for the length of the measurement vector

Definition at line 113 of file Numerics/Statistics/itkSample.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

void itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetMeasurementVectorSize ( const MeasurementVectorSizeType ) [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.

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

Returns:: Set the MetaDataDictionary

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

Returns:: Set the MetaDataDictionary

void itk::DataObject::SetPipelineMTime ( unsigned long time ) [inline, inherited]

The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object.

Definition at line 373 of file itkDataObject.h.

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

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

void itk::DataObject::SetReleaseDataFlag ( bool flag ) [inline, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

Definition at line 304 of file itkDataObject.h.

virtual void itk::DataObject::SetRequestedRegion ( DataObject * ) [inline, virtual, inherited]

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. For DataObject's that do not support Regions, this method does nothing. Subclasses of DataObject that do support Regions, provide an alternative implementation.

Definition at line 446 of file itkDataObject.h.

virtual void itk::DataObject::SetRequestedRegionToLargestPossibleRegion ( ) [inline, virtual, inherited]

Set the RequestedRegion to the LargestPossibleRegion. This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update().

Definition at line 402 of file itkDataObject.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

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

Initialize the values of the histogram bins to zero

bool itk::DataObject::ShouldIReleaseData ( ) const [inherited]

Return flag indicating whether data should be released after use by a filter.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>

unsigned int itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Size ( ) const [virtual]

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

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

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

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

virtual void itk::DataObject::Update ( ) [virtual, inherited]

Provides opportunity for the data object to insure internal consistency before access. Also causes owning source/filter (if any) to update itself. The Update() method is composed of UpdateOutputInformation(), PropagateRequestedRegion(), and UpdateOutputData(). This method may call methods that throw an InvalidRequestedRegionError exception. This exception will leave the pipeline in an inconsistent state. You will need to call ResetPipeline() on the last ProcessObject in your pipeline in order to restore the pipeline to a state where you can call Update() again.

virtual void itk::DataObject::UpdateOutputData ( ) [virtual, inherited]

Methods to update the pipeline. Called internally by the pipeline mechanism.

virtual void itk::DataObject::UpdateOutputInformation ( ) [virtual, inherited]

Update the information for this DataObject so that it can be used as an output of a ProcessObject. This method is used in the pipeline mechanism to propagate information and initialize the meta data associated with a DataObject. Any implementation of this method in a derived class is assumed to call its source's ProcessObject::UpdateOutputInformation() which determines modified times, LargestPossibleRegions, and any extra meta data like spacing, origin, etc. Default implementation simply call's it's source's UpdateOutputInformation().

virtual bool itk::DataObject::VerifyRequestedRegion ( ) [inline, virtual, inherited]

Verify that the RequestedRegion is within the LargestPossibleRegion.

If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possibly satisfy the request. This method returns true if the request can be satisfied (even if it will be necessary to process the entire LargestPossibleRegion) and returns false otherwise. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception if the requested region is not within the LargestPossibleRegion. Default implementation simply returns true in order to support DataObjects that do not need regions (for instance itk::EquivalencyTable).