#include <itkSample.h>

Inheritance diagram for itk::Statistics::Sample< TMeasurementVector >:

Collaboration diagram for itk::Statistics::Sample< TMeasurementVector >:

Public Types
typedef MeasurementVectorTraits::AbsoluteFrequencyType	AbsoluteFrequencyType
typedef SmartPointer< const Self >	ConstPointer
typedef MeasurementVectorTraits::InstanceIdentifier	InstanceIdentifier
typedef MeasurementVectorTraitsTypes < MeasurementVectorType > ::ValueType	MeasurementType
typedef unsigned int	MeasurementVectorSizeType
typedef TMeasurementVector	MeasurementVectorType
typedef SmartPointer< Self >	Pointer
typedef Sample	Self
typedef DataObject	Superclass
typedef NumericTraits < AbsoluteFrequencyType > ::AccumulateType	TotalAbsoluteFrequencyType
Public Types inherited from itk::DataObject
typedef std::string	DataObjectIdentifierType
typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual AbsoluteFrequencyType	GetFrequency (InstanceIdentifier id) const =0
virtual const MeasurementVectorType &	GetMeasurementVector (InstanceIdentifier id) const =0
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
virtual const char *	GetNameOfClass () const
virtual TotalAbsoluteFrequencyType	GetTotalFrequency () const =0
virtual void	Graft (const DataObject *thatObject)
virtual void	SetMeasurementVectorSize (MeasurementVectorSizeType s)
virtual InstanceIdentifier	Size () const =0
Public Member Functions inherited from itk::DataObject
virtual void	CopyInformation (const DataObject *)
virtual void	DataHasBeenGenerated ()
void	DisconnectPipeline ()
bool	GetDataReleased () const
virtual const bool &	GetReleaseDataFlag ()
SmartPointerForwardReference < ProcessObject >	GetSource () const
DataObjectPointerArraySizeType	GetSourceOutputIndex () const
const DataObjectIdentifierType &	GetSourceOutputName () const
virtual unsigned long	GetUpdateMTime () const
virtual void	Initialize ()
virtual void	PrepareForNewData ()
virtual void	PropagateRequestedRegion ()
void	ReleaseData ()
virtual void	ReleaseDataFlagOff ()
virtual void	ReleaseDataFlagOn ()
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual void	ResetPipeline ()
void	SetReleaseDataFlag (bool flag)
virtual void	SetRequestedRegion (const DataObject *)
virtual void	SetRequestedRegionToLargestPossibleRegion ()
bool	ShouldIReleaseData () const
virtual void	Update ()
virtual void	UpdateOutputData ()
virtual void	UpdateOutputInformation ()
virtual bool	VerifyRequestedRegion ()
void	SetPipelineMTime (unsigned long time)
virtual const unsigned long &	GetPipelineMTime ()
virtual void	SetRealTimeStamp (RealTimeStamp _arg)
virtual const RealTimeStamp &	GetRealTimeStamp ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const
	Sample ()
virtual	~Sample ()
Protected Member Functions inherited from itk::DataObject
virtual void	PropagateResetPipeline ()
	DataObject ()
	~DataObject ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
void	operator= (const Self &)
	Sample (const Self &)

Private Attributes
MeasurementVectorSizeType	m_MeasurementVectorSize

Additional Inherited Members
Static Public Member Functions inherited from itk::DataObject
static bool	GetGlobalReleaseDataFlag ()
static void	GlobalReleaseDataFlagOff ()
static void	GlobalReleaseDataFlagOn ()
static void	SetGlobalReleaseDataFlag (bool val)
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

Detailed Description

template<class TMeasurementVector>
class itk::Statistics::Sample< TMeasurementVector >

A collection of measurements for statistical analysis.

Sample represents a set of measurements for statistical analysis. Sample is templated over a measurement vector. The measurement vector encapsulates the set of values associated with a single measurement. For instance, a measurement vector may contain an image intensity of a pixel and the gradient magnitude at that pixel.

Data within a sample can be accessed via an InstanceIdentifier. InstanceIdentifiers have different forms and meanings depending on the type of sample. For ListSamples, the InstanceIdentifier is an index into the corresponding list. In this case, the InstanceIndentifier corresponds to a particular measurement stored in the Sample. For Histograms, an InstanceIdentifier corresponds to a particular bin in the N-dimensional histogram. In other words, the InstanceIdentifier in a histogram does not correspond to a specific measurement used to build the histogram but to the "bin" in which a number of original measurements were "accumulated".

Recent API changes: The static const macro to get the length of a measurement vector, 'MeasurementVectorSize' has been removed to allow the length of a measurement vector to be specified at run time. Please use the function GetMeasurementVectorSize() instead.

Definition at line 61 of file itkSample.h.

Member Typedef Documentation

template<class TMeasurementVector>

typedef MeasurementVectorTraits::AbsoluteFrequencyType itk::Statistics::Sample< TMeasurementVector >::AbsoluteFrequencyType

Frequency value type

Definition at line 82 of file itkSample.h.

template<class TMeasurementVector>

typedef SmartPointer< const Self > itk::Statistics::Sample< TMeasurementVector >::ConstPointer

Reimplemented from itk::DataObject.

Reimplemented in itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >, itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::ImageToNeighborhoodSampleAdaptor< TImage, TBoundaryCondition >, itk::Statistics::ListSample< TMeasurementVector >, itk::Statistics::ListSample< std::vector< ConstNeighborhoodIterator< TImage, TBoundaryCondition > > >, itk::Statistics::ListSample< TVectorContainer::Element >, itk::Statistics::ListSample< MeasurementVectorPixelTraits< TImage::PixelType >::MeasurementVectorType >, itk::Statistics::ListSample< TPointSet::PointType >, itk::Statistics::ListSample< ImageJointDomainTraits< TImage >::MeasurementVectorType >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 68 of file itkSample.h.

template<class TMeasurementVector>

typedef MeasurementVectorTraits::InstanceIdentifier itk::Statistics::Sample< TMeasurementVector >::InstanceIdentifier

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

Definition at line 89 of file itkSample.h.

template<class TMeasurementVector>

typedef MeasurementVectorTraitsTypes< MeasurementVectorType >::ValueType itk::Statistics::Sample< TMeasurementVector >::MeasurementType

ValueType of a measurement (ValueType of a component of the MeasurementVector

Definition at line 79 of file itkSample.h.

template<class TMeasurementVector>

typedef unsigned int itk::Statistics::Sample< TMeasurementVector >::MeasurementVectorSizeType

Typedef for the length of each measurement vector

Definition at line 92 of file itkSample.h.

template<class TMeasurementVector>

typedef TMeasurementVector itk::Statistics::Sample< TMeasurementVector >::MeasurementVectorType

MeasurementVector typedef support

Definition at line 71 of file itkSample.h.

template<class TMeasurementVector>

typedef SmartPointer< Self > itk::Statistics::Sample< TMeasurementVector >::Pointer

Reimplemented from itk::DataObject.

Reimplemented in itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >, itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::ImageToNeighborhoodSampleAdaptor< TImage, TBoundaryCondition >, itk::Statistics::ListSample< TMeasurementVector >, itk::Statistics::ListSample< std::vector< ConstNeighborhoodIterator< TImage, TBoundaryCondition > > >, itk::Statistics::ListSample< TVectorContainer::Element >, itk::Statistics::ListSample< MeasurementVectorPixelTraits< TImage::PixelType >::MeasurementVectorType >, itk::Statistics::ListSample< TPointSet::PointType >, itk::Statistics::ListSample< ImageJointDomainTraits< TImage >::MeasurementVectorType >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 67 of file itkSample.h.

template<class TMeasurementVector>

typedef Sample itk::Statistics::Sample< TMeasurementVector >::Self

Standard class typedefs

Reimplemented from itk::DataObject.

Reimplemented in itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >, itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::ImageToNeighborhoodSampleAdaptor< TImage, TBoundaryCondition >, itk::Statistics::ListSample< TMeasurementVector >, itk::Statistics::ListSample< std::vector< ConstNeighborhoodIterator< TImage, TBoundaryCondition > > >, itk::Statistics::ListSample< TVectorContainer::Element >, itk::Statistics::ListSample< MeasurementVectorPixelTraits< TImage::PixelType >::MeasurementVectorType >, itk::Statistics::ListSample< TPointSet::PointType >, itk::Statistics::ListSample< ImageJointDomainTraits< TImage >::MeasurementVectorType >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 65 of file itkSample.h.

template<class TMeasurementVector>

typedef DataObject itk::Statistics::Sample< TMeasurementVector >::Superclass

Reimplemented from itk::DataObject.

Reimplemented in itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >, itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::ImageToNeighborhoodSampleAdaptor< TImage, TBoundaryCondition >, itk::Statistics::ListSample< TMeasurementVector >, itk::Statistics::ListSample< std::vector< ConstNeighborhoodIterator< TImage, TBoundaryCondition > > >, itk::Statistics::ListSample< TVectorContainer::Element >, itk::Statistics::ListSample< MeasurementVectorPixelTraits< TImage::PixelType >::MeasurementVectorType >, itk::Statistics::ListSample< TPointSet::PointType >, itk::Statistics::ListSample< ImageJointDomainTraits< TImage >::MeasurementVectorType >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 66 of file itkSample.h.

template<class TMeasurementVector>

typedef NumericTraits< AbsoluteFrequencyType >::AccumulateType itk::Statistics::Sample< TMeasurementVector >::TotalAbsoluteFrequencyType

Total frequency type

Definition at line 85 of file itkSample.h.

Constructor & Destructor Documentation

template<class TMeasurementVector>

itk::Statistics::Sample< TMeasurementVector >::Sample ( )

inlineprotected

Definition at line 173 of file itkSample.h.

template<class TMeasurementVector>

virtual itk::Statistics::Sample< TMeasurementVector >::~Sample ( )

inlineprotectedvirtual

Definition at line 179 of file itkSample.h.

template<class TMeasurementVector>

itk::Statistics::Sample< TMeasurementVector >::Sample ( const Self & )

private

Member Function Documentation

template<class TMeasurementVector>

virtual AbsoluteFrequencyType itk::Statistics::Sample< TMeasurementVector >::GetFrequency ( InstanceIdentifier id ) const

pure virtual

Get the frequency of a measurement specified by instance identifier.

Implemented in itk::Statistics::ListSample< TMeasurementVector >.

template<class TMeasurementVector>

virtual const MeasurementVectorType& itk::Statistics::Sample< TMeasurementVector >::GetMeasurementVector ( InstanceIdentifier id ) const

pure virtual

Get the measurement associated with a particular InstanceIdentifier.

Implemented in itk::Statistics::ListSample< TMeasurementVector >.

template<class TMeasurementVector>

virtual MeasurementVectorSizeType itk::Statistics::Sample< TMeasurementVector >::GetMeasurementVectorSize ( ) const

virtual

Get method for the length of the measurement vector

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >.

template<class TMeasurementVector>

virtual const char* itk::Statistics::Sample< TMeasurementVector >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods)

Reimplemented from itk::DataObject.

Reimplemented in itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >, itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::ImageToNeighborhoodSampleAdaptor< TImage, TBoundaryCondition >, itk::Statistics::ListSample< TMeasurementVector >, itk::Statistics::ListSample< std::vector< ConstNeighborhoodIterator< TImage, TBoundaryCondition > > >, itk::Statistics::ListSample< TVectorContainer::Element >, itk::Statistics::ListSample< MeasurementVectorPixelTraits< TImage::PixelType >::MeasurementVectorType >, itk::Statistics::ListSample< TPointSet::PointType >, itk::Statistics::ListSample< ImageJointDomainTraits< TImage >::MeasurementVectorType >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

template<class TMeasurementVector>

virtual TotalAbsoluteFrequencyType itk::Statistics::Sample< TMeasurementVector >::GetTotalFrequency ( ) const

pure virtual

Get the total frequency of the sample.

template<class TMeasurementVector>

virtual void itk::Statistics::Sample< TMeasurementVector >::Graft ( const DataObject * thatObject )

inlinevirtual

Method to graft another sample

Reimplemented from itk::DataObject.

Reimplemented in itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >, itk::Statistics::ListSample< TMeasurementVector >, itk::Statistics::ListSample< std::vector< ConstNeighborhoodIterator< TImage, TBoundaryCondition > > >, itk::Statistics::ListSample< TVectorContainer::Element >, itk::Statistics::ListSample< MeasurementVectorPixelTraits< TImage::PixelType >::MeasurementVectorType >, itk::Statistics::ListSample< TPointSet::PointType >, and itk::Statistics::ListSample< ImageJointDomainTraits< TImage >::MeasurementVectorType >.

Definition at line 161 of file itkSample.h.

template<class TMeasurementVector>

void itk::Statistics::Sample< TMeasurementVector >::operator= ( const Self & )

private

Reimplemented from itk::DataObject.

Reimplemented in itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::ImageToNeighborhoodSampleAdaptor< TImage, TBoundaryCondition >, itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::ListSample< TMeasurementVector >, itk::Statistics::ListSample< std::vector< ConstNeighborhoodIterator< TImage, TBoundaryCondition > > >, itk::Statistics::ListSample< TVectorContainer::Element >, itk::Statistics::ListSample< MeasurementVectorPixelTraits< TImage::PixelType >::MeasurementVectorType >, itk::Statistics::ListSample< TPointSet::PointType >, itk::Statistics::ListSample< ImageJointDomainTraits< TImage >::MeasurementVectorType >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

template<class TMeasurementVector>

void itk::Statistics::Sample< TMeasurementVector >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

inlineprotectedvirtual

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.

Reimplemented from itk::DataObject.

Reimplemented in itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::ImageToNeighborhoodSampleAdaptor< TImage, TBoundaryCondition >, itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::ListSample< TMeasurementVector >, itk::Statistics::ListSample< std::vector< ConstNeighborhoodIterator< TImage, TBoundaryCondition > > >, itk::Statistics::ListSample< TVectorContainer::Element >, itk::Statistics::ListSample< MeasurementVectorPixelTraits< TImage::PixelType >::MeasurementVectorType >, itk::Statistics::ListSample< TPointSet::PointType >, itk::Statistics::ListSample< ImageJointDomainTraits< TImage >::MeasurementVectorType >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 181 of file itkSample.h.

template<class TMeasurementVector>

virtual void itk::Statistics::Sample< TMeasurementVector >::SetMeasurementVectorSize ( MeasurementVectorSizeType s )

inlinevirtual

Set method for the length of the measurement vector

Definition at line 110 of file itkSample.h.

template<class TMeasurementVector>

virtual InstanceIdentifier itk::Statistics::Sample< TMeasurementVector >::Size ( ) const

pure virtual

Get the size of the sample (number of measurements)

Member Data Documentation

template<class TMeasurementVector>

MeasurementVectorSizeType itk::Statistics::Sample< TMeasurementVector >::m_MeasurementVectorSize

private

Definition at line 192 of file itkSample.h.

The documentation for this class was generated from the following file:

itkSample.h

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class TMeasurementVector> class itk::Statistics::Sample< TMeasurementVector >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TMeasurementVector>
class itk::Statistics::Sample< TMeasurementVector >