#include <itkSample.h>

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

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

Detailed Description

template<typename 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.

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 SmartPointer< const Self >	ConstPointer

typedef std::string	DataObjectIdentifierType

typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType

typedef SmartPointer< Self >	Pointer

typedef DataObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

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) override

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

SmartPointerForwardReference < ProcessObject >	GetSource () const

DataObjectPointerArraySizeType	GetSourceOutputIndex () const

const DataObjectIdentifierType &	GetSourceOutputName () const

virtual ModifiedTimeType	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 (ModifiedTimeType time)

virtual const ModifiedTimeType &	GetPipelineMTime () const

virtual void	SetRealTimeStamp (RealTimeStamp _arg)

virtual const RealTimeStamp &	GetRealTimeStamp () const

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 override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	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 override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () 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
virtual void	PrintSelf (std::ostream &os, Indent indent) const override

	Sample ()

virtual	~Sample ()

Protected Member Functions inherited from itk::DataObject
	DataObject ()

virtual void	PropagateResetPipeline ()

	~DataObject ()

Protected Member Functions inherited from itk::Object
	Object ()

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

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

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

static Pointer	New ()

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TMeasurementVector>

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

Frequency value type

Definition at line 82 of file itkSample.h.

template<typename TMeasurementVector>

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

Definition at line 68 of file itkSample.h.

template<typename 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<typename 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<typename TMeasurementVector>

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

Type of the length of each measurement vector

Definition at line 92 of file itkSample.h.

template<typename TMeasurementVector>

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

MeasurementVector typedef support

Definition at line 71 of file itkSample.h.

template<typename TMeasurementVector>

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

Definition at line 67 of file itkSample.h.

template<typename TMeasurementVector>

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

Standard class typedefs

Definition at line 65 of file itkSample.h.

template<typename TMeasurementVector>

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

Definition at line 66 of file itkSample.h.

template<typename 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<typename TMeasurementVector>

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

inlineprotected

Definition at line 173 of file itkSample.h.

template<typename TMeasurementVector>

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

inlineprotectedvirtual

Definition at line 179 of file itkSample.h.

template<typename TMeasurementVector>

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

private

Member Function Documentation

template<typename 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<typename 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<typename 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 >.

Referenced by itk::Statistics::ImageToListSampleAdaptor< TImage >::GetMeasurementVectorSize().

template<typename 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<typename TMeasurementVector>

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

pure virtual

Get the total frequency of the sample.

template<typename TMeasurementVector>

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

inlineoverridevirtual

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<typename TMeasurementVector>

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

private

template<typename TMeasurementVector>

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

inlineoverrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::DataObject.

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