itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample > Class Template Reference

#include <itkSelectiveSubsampleGenerator.h>

Inheritance diagram for itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >:

[legend]Collaboration diagram for itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >:

[legend]List of all members.

---

Detailed Description

template<class TInputSample, class TClassMaskSample>
class itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >

SelectiveSubsampleGenerator generates a Subsample object that includes measurement vectors that belong to the classes that are specified by the SetSelectedClassLabels method.

To instantiate an object of this class you have to provide two template arguments: the type of the input sample and the type of class mask sample.

The input sample is a sample that has all the measurement vectors and the class mask sample contains class labels for their corresponding measurement vectors in the input sample. Therefore, the sizes of both should be the same.

To generate a subsample that a part of the input sample that belongs to a set of classes, you should call SetSelectedClassLabels method with the class labels that you want to include in the output.

See also:

Subsample

Definition at line 49 of file itkSelectiveSubsampleGenerator.h.

Public Types
typedef TClassMaskSample::MeasurementType	ClassLabelType
typedef std::vector< ClassLabelType >	ClassLabelVectorType
typedef SmartPointer< const Self >	ConstPointer
typedef TInputSample::MeasurementVectorType	MeasurementVectorType
typedef OutputType::Pointer	OutputPointer
typedef Subsample< TInputSample >	OutputType
typedef SmartPointer< Self >	Pointer
typedef SelectiveSubsampleGenerator	Self
typedef Object	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
void	GenerateData ()
const TClassMaskSample *	GetClassMask () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
TInputSample *	GetInput ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
Standard Macros *virtual const char *	GetNameOfClass () const
const OutputType *	GetOutput () const
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
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	SetClassMask (const TClassMaskSample *classMask)
void	SetDebug (bool debugFlag) const
void	SetInput (TInputSample *sample)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
void	SetSelectedClassLabels (const ClassLabelVectorType &classLabels)
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
	SelectiveSubsampleGenerator ()
virtual	~SelectiveSubsampleGenerator ()
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

---

Member Typedef Documentation

template<class TInputSample, class TClassMaskSample> typedef TClassMaskSample::MeasurementType itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::ClassLabelType

Definition at line 67 of file itkSelectiveSubsampleGenerator.h.

template<class TInputSample, class TClassMaskSample> typedef std::vector< ClassLabelType > itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::ClassLabelVectorType

Definition at line 68 of file itkSelectiveSubsampleGenerator.h.

template<class TInputSample, class TClassMaskSample> typedef SmartPointer<const Self> itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::ConstPointer

Reimplemented from itk::Object. Definition at line 57 of file itkSelectiveSubsampleGenerator.h.

template<class TInputSample, class TClassMaskSample> typedef TInputSample::MeasurementVectorType itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::MeasurementVectorType

Input sample types alias Definition at line 61 of file itkSelectiveSubsampleGenerator.h.

template<class TInputSample, class TClassMaskSample> typedef OutputType::Pointer itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::OutputPointer

Definition at line 72 of file itkSelectiveSubsampleGenerator.h.

template<class TInputSample, class TClassMaskSample> typedef Subsample< TInputSample > itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::OutputType

Output: MembershipSample types Definition at line 71 of file itkSelectiveSubsampleGenerator.h.

template<class TInputSample, class TClassMaskSample> typedef SmartPointer<Self> itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::Pointer

Reimplemented from itk::Object. Definition at line 56 of file itkSelectiveSubsampleGenerator.h.

template<class TInputSample, class TClassMaskSample> typedef SelectiveSubsampleGenerator itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::Self

Standard class typedefs. Reimplemented from itk::Object. Definition at line 54 of file itkSelectiveSubsampleGenerator.h.

template<class TInputSample, class TClassMaskSample> typedef Object itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::Superclass

Reimplemented from itk::Object. Definition at line 55 of file itkSelectiveSubsampleGenerator.h.

---

Constructor & Destructor Documentation

template<class TInputSample, class TClassMaskSample> itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::SelectiveSubsampleGenerator (   )  [protected]

template<class TInputSample, class TClassMaskSample> virtual itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::~SelectiveSubsampleGenerator (   )  [inline, protected, virtual]

Definition at line 98 of file itkSelectiveSubsampleGenerator.h.

---

Member Function Documentation

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

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

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

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class. Reimplemented from itk::LightObject.

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

Turn debugging output off.

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

Turn debugging output on.

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

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

template<class TInputSample, class TClassMaskSample> void itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::GenerateData (   )

The actual output generation procedure.

template<class TInputSample, class TClassMaskSample> const TClassMaskSample* itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::GetClassMask (   )  const

Returns the class mask sample pointer

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.

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

template<class TInputSample, class TClassMaskSample> TInputSample* itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::GetInput (   )

Returns the input sample pointer

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 TInputSample, class TClassMaskSample> Standard Macros* virtual const char* itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::GetNameOfClass (   )  const [virtual]

Standard part of all itk objects. Reimplemented from itk::Object.

template<class TInputSample, class TClassMaskSample> const OutputType* itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::GetOutput (   )  const

Returns the pointer to the MembershipSample object that has been generated by this

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

Gets the reference count on this object. Definition at line 98 of file itkLightObject.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.

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 TInputSample, class TClassMaskSample> static Pointer itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::New (   )  [static]

Method for creation through the object factory. 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 TInputSample, class TClassMaskSample> void itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::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::Object.

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.

template<class TInputSample, class TClassMaskSample> void itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::SetClassMask (  const TClassMaskSample *  classMask  )

Stores the class mask sample

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

template<class TInputSample, class TClassMaskSample> void itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::SetInput (  TInputSample *  sample  )

Stores the input sample

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 TInputSample, class TClassMaskSample> void itk::Statistics::SelectiveSubsampleGenerator< TInputSample, TClassMaskSample >::SetSelectedClassLabels (  const ClassLabelVectorType &  classLabels  )  [inline]

Definition at line 86 of file itkSelectiveSubsampleGenerator.h.

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:

• itkSelectiveSubsampleGenerator.h

---