itk::Statistics::Subsample< TSample > Class Template Reference

#include <itkSubsample.h>

Inheritance diagram for itk::Statistics::Subsample< TSample >:

[legend]Collaboration diagram for itk::Statistics::Subsample< TSample >:

[legend]List of all members.

---

Detailed Description

template<class TSample>
class itk::Statistics::Subsample< TSample >

This class stores a subset of instance identifiers from another sample object. You can create a subsample out of another sample object or another subsample object. The class is useful when storing or extracting a portion of a sample object. Note that when the elements of a subsample are sorted, the instance identifiers of the subsample are sorted without changing the original source sample. Most Statistics algorithms (that derive from StatisticsAlgorithmBase accept Subsample objects as inputs).

Definition at line 38 of file itkSubsample.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TSample::FrequencyType	FrequencyType
typedef TSample::InstanceIdentifier	InstanceIdentifier
typedef std::vector< InstanceIdentifier >	InstanceIdentifierHolder
typedef TSample::MeasurementType	MeasurementType
typedef unsigned int	MeasurementVectorSizeType
typedef TSample::MeasurementVectorType	MeasurementVectorType
typedef SmartPointer< Self >	Pointer
typedef TSample::Pointer	SamplePointer
typedef Subsample	Self
typedef Sample< typename TSample::MeasurementVectorType >	Superclass
typedef TSample::TotalFrequencyType	TotalFrequencyType
typedef MeasurementVectorType	ValueType
Public Member Functions
void	AddInstance (InstanceIdentifier id)
ConstIterator	Begin () const
Iterator	Begin ()
void	Clear ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
ConstIterator	End () const
Iterator	End ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
FrequencyType	GetFrequency (const InstanceIdentifier &id) const
FrequencyType	GetFrequencyByIndex (int index) const
InstanceIdentifier	GetInstanceIdentifier (int index) const
const MeasurementVectorType &	GetMeasurementVector (const InstanceIdentifier &id) const
MeasurementVectorType	GetMeasurementVectorByIndex (int index) const
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
const TSample *	GetSample () const
TotalFrequencyType	GetTotalFrequency () const
bool	HasObserver (const EventObject &event) const
void	InitializeWithAllInstances ()
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
Set Get macros for the length of the measurement vector *virtual void	SetMeasurementVectorSize (const MeasurementVectorSizeType s)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
Plug in the actual sample data *void	SetSample (const TSample *sample)
unsigned int	Size () const
void	Swap (int index1, int index2)
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
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 unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	Sample ()
	Subsample ()
virtual	~Subsample ()
Protected Attributes
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual 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 PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const
Classes
class	ConstIterator
class	Iterator

---

Member Typedef Documentation

template<class TSample> typedef SmartPointer<const Self> itk::Statistics::Subsample< TSample >::ConstPointer

Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 46 of file itkSubsample.h.

template<class TSample> typedef TSample::FrequencyType itk::Statistics::Subsample< TSample >::FrequencyType

Frequency value type Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 62 of file itkSubsample.h.

template<class TSample> typedef TSample::InstanceIdentifier itk::Statistics::Subsample< TSample >::InstanceIdentifier

InstanceIdentifier typedef. This identifier is a unique sequential id for each measurement vector in a Sample subclass. Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 61 of file itkSubsample.h.

template<class TSample> typedef std::vector< InstanceIdentifier > itk::Statistics::Subsample< TSample >::InstanceIdentifierHolder

Type of the storage for instances that belong to the class represented by a Subsample object. A Subsample object stores only the InstanceIdentifiers. The actual data is still in the Sample object Definition at line 70 of file itkSubsample.h.

template<class TSample> typedef TSample::MeasurementType itk::Statistics::Subsample< TSample >::MeasurementType

ValueType of a measurement (ValueType of a component of the MeasurementVector Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 60 of file itkSubsample.h.

typedef unsigned int itk::Statistics::Sample< TSample::MeasurementVectorType >::MeasurementVectorSizeType [inherited]

Typedef for the length of each measurement vector Definition at line 93 of file itkSample.h.

template<class TSample> typedef TSample::MeasurementVectorType itk::Statistics::Subsample< TSample >::MeasurementVectorType

Typedefs for Measurement vector, measurement, Instance Identifier, frequency, size, size element value from the template argument TSample Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 59 of file itkSubsample.h.

template<class TSample> typedef SmartPointer< Self > itk::Statistics::Subsample< TSample >::Pointer

Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 45 of file itkSubsample.h.

template<class TSample> typedef TSample::Pointer itk::Statistics::Subsample< TSample >::SamplePointer

Smart pointer to the actual sample data holder Definition at line 52 of file itkSubsample.h.

template<class TSample> typedef Subsample itk::Statistics::Subsample< TSample >::Self

Standard class typedefs Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 43 of file itkSubsample.h.

template<class TSample> typedef Sample< typename TSample::MeasurementVectorType > itk::Statistics::Subsample< TSample >::Superclass

Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 44 of file itkSubsample.h.

template<class TSample> typedef TSample::TotalFrequencyType itk::Statistics::Subsample< TSample >::TotalFrequencyType

Total frequency type Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 63 of file itkSubsample.h.

template<class TSample> typedef MeasurementVectorType itk::Statistics::Subsample< TSample >::ValueType

Definition at line 64 of file itkSubsample.h.

---

Constructor & Destructor Documentation

template<class TSample> itk::Statistics::Subsample< TSample >::Subsample (   )  [protected]

template<class TSample> virtual itk::Statistics::Subsample< TSample >::~Subsample (   )  [inline, protected, virtual]

Definition at line 295 of file itkSubsample.h.

---

Member Function Documentation

template<class TSample> void itk::Statistics::Subsample< TSample >::AddInstance (  InstanceIdentifier  id  )  [inline]

Definition at line 99 of file itkSubsample.h.

template<class TSample> ConstIterator itk::Statistics::Subsample< TSample >::Begin (  void   )  const [inline]

Definition at line 281 of file itkSubsample.h.

template<class TSample> Iterator itk::Statistics::Subsample< TSample >::Begin (  void   )  [inline]

Definition at line 269 of file itkSubsample.h.

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

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

template<class TSample> void itk::Statistics::Subsample< TSample >::Clear (  void   )  [inline]

Definition at line 112 of file itkSubsample.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.

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

Turn debugging output off.

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

Turn debugging output on.

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

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

template<class TSample> ConstIterator itk::Statistics::Subsample< TSample >::End (  void   )  const [inline]

Definition at line 287 of file itkSubsample.h.

template<class TSample> Iterator itk::Statistics::Subsample< TSample >::End (  void   )  [inline]

Definition at line 275 of file itkSubsample.h.

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

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

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

Get the value of the debug flag.

template<class TSample> FrequencyType itk::Statistics::Subsample< TSample >::GetFrequency (  const InstanceIdentifier &  id  )  const [inline, virtual]

returns the frequency of the instance which is identified by the 'id' Implements itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 124 of file itkSubsample.h.

template<class TSample> FrequencyType itk::Statistics::Subsample< TSample >::GetFrequencyByIndex (  int  index  )  const

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

template<class TSample> InstanceIdentifier itk::Statistics::Subsample< TSample >::GetInstanceIdentifier (  int  index  )  const

template<class TSample> const MeasurementVectorType& itk::Statistics::Subsample< TSample >::GetMeasurementVector (  const InstanceIdentifier &  id  )  const [inline, virtual]

retunrs the measurement of the instance which is identified by the 'id' Implements itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 120 of file itkSubsample.h.

template<class TSample> MeasurementVectorType itk::Statistics::Subsample< TSample >::GetMeasurementVectorByIndex (  int  index  )  const

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

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.

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

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

template<class TSample> virtual const char* itk::Statistics::Subsample< TSample >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >.

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

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

template<class TSample> const TSample* itk::Statistics::Subsample< TSample >::GetSample (   )  const [inline]

Definition at line 80 of file itkSubsample.h.

template<class TSample> TotalFrequencyType itk::Statistics::Subsample< TSample >::GetTotalFrequency (   )  const [inline, virtual]

returns the total frequency for the 'd' dimension Implements itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 128 of file itkSubsample.h.

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

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

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

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

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

Return true if an observer is registered for this event.

template<class TSample> void itk::Statistics::Subsample< TSample >::InitializeWithAllInstances (   )  [inline]

Definition at line 84 of file itkSubsample.h. References itk::iterator().

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.

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::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TSample> static Pointer itk::Statistics::Subsample< TSample >::New (   )  [static]

standard New() method support Reimplemented from itk::Object.

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

Cause the object to print itself out.

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

template<class TSample> void itk::Statistics::Subsample< TSample >::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< TSample::MeasurementVectorType >.

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

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

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

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

Remove all observers .

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

Remove the observer with this tag value.

itk::Statistics::Sample< TSample::MeasurementVectorType >::Sample (   )  [inline, protected, inherited]

Definition at line 130 of file itkSample.h.

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

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

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

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

Set Get macros for the length of the measurement vector* virtual void itk::Statistics::Sample< TSample::MeasurementVectorType >::SetMeasurementVectorSize (  const MeasurementVectorSizeType  s  )  [inline, virtual, inherited]

Definition at line 113 of file itkSample.h.

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

Returns: Set the MetaDataDictionary

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

Sets the reference count (use with care) Reimplemented from itk::LightObject.

template<class TSample> Plug in the actual sample data* void itk::Statistics::Subsample< TSample >::SetSample (  const TSample *  sample  )  [inline]

Definition at line 73 of file itkSubsample.h.

template<class TSample> unsigned int itk::Statistics::Subsample< TSample >::Size (  void   )  const [inline, virtual]

returns SizeType object whose each element is the number of elements in each dimension Implements itk::Statistics::Sample< TSample::MeasurementVectorType >. Definition at line 107 of file itkSubsample.h.

template<class TSample> void itk::Statistics::Subsample< TSample >::Swap (  int  index1, int  index2 )

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

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

---

Member Data Documentation

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

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

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

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

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

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual 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 PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkSubsample.h

---