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

#include <itkNeighborhoodSampler.h>

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

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

[legend]List of all members.

---

Detailed Description

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

generates a Subsample that is sampled from the input sample using a spherical kernel.

The resulting Subsample has measurement vectors that falls in a hyper-sphere that is defined by a center and a radius. To set the center, use SetCenter method, and to set radius, use SetRadius method. The distance metric is Euclidean one.

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() to get the length. The typedef for CenterType has changed from FixedArray to Array

Definition at line 48 of file itkNeighborhoodSampler.h.

Public Types
typedef Array< double >	CenterType
typedef SmartPointer< const Self >	ConstPointer
typedef TSample::FrequencyType	FrequencyType
typedef Superclass::InputSampleType	InputSampleType
typedef TSample::InstanceIdentifier	InstanceIdentifier
typedef TSample::MeasurementType	MeasurementType
typedef unsigned int	MeasurementVectorSizeType
typedef TSample::MeasurementVectorType	MeasurementVectorType
typedef SubsampleType::Pointer	OutputPointer
typedef SubsampleType	OutputType
typedef SmartPointer< Self >	Pointer
typedef double	RadiusType
typedef TSample	SampleType
typedef NeighborhoodSampler	Self
typedef Subsample< TSample >	SubsampleType
typedef SampleAlgorithmBase< TSample >	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
CenterType *	GetCenter ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
const TSample *	GetInputSample () const
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
OutputPointer	GetOutput ()
RadiusType *	GetRadius ()
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	SetCenter (CenterType *center)
void	SetDebug (bool debugFlag) const
Stores the sample pointer *void	SetInputSample (const TSample *sample)
virtual void	SetMeasurementVectorSize (MeasurementVectorSizeType _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
Sets the radius of the kernel *void	SetRadius (RadiusType *radius)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
void	Update ()
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
void	GenerateData ()
	NeighborhoodSampler ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	SampleAlgorithmBase ()
virtual	~NeighborhoodSampler ()
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 TSample> typedef Array< double > itk::Statistics::NeighborhoodSampler< TSample >::CenterType

Type of the array of the radii Definition at line 83 of file itkNeighborhoodSampler.h.

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

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 55 of file itkNeighborhoodSampler.h.

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

Definition at line 70 of file itkNeighborhoodSampler.h.

template<class TSample> typedef Superclass::InputSampleType itk::Statistics::NeighborhoodSampler< TSample >::InputSampleType

typedefs from the superclass Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 74 of file itkNeighborhoodSampler.h.

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

Definition at line 71 of file itkNeighborhoodSampler.h.

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

Definition at line 69 of file itkNeighborhoodSampler.h.

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

Length of a measurement vector Reimplemented in itk::Statistics::CovarianceCalculator< TSample >, itk::Statistics::MeanCalculator< TSample >, itk::Statistics::WeightedCovarianceCalculator< TSample >, and itk::Statistics::WeightedMeanCalculator< TSample >. Definition at line 52 of file itkSampleAlgorithmBase.h.

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

Enums and typedefs from the TSample Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 68 of file itkNeighborhoodSampler.h.

template<class TSample> typedef SubsampleType::Pointer itk::Statistics::NeighborhoodSampler< TSample >::OutputPointer

Output of this algorithm Definition at line 126 of file itkNeighborhoodSampler.h.

template<class TSample> typedef SubsampleType itk::Statistics::NeighborhoodSampler< TSample >::OutputType

Output of this algorithm Definition at line 123 of file itkNeighborhoodSampler.h.

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

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 54 of file itkNeighborhoodSampler.h.

template<class TSample> typedef double itk::Statistics::NeighborhoodSampler< TSample >::RadiusType

Type of the array of the radii Definition at line 80 of file itkNeighborhoodSampler.h.

template<class TSample> typedef TSample itk::Statistics::NeighborhoodSampler< TSample >::SampleType

MeasurementVector typedef support Definition at line 61 of file itkNeighborhoodSampler.h.

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

Standard class typedefs Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 52 of file itkNeighborhoodSampler.h.

template<class TSample> typedef Subsample< TSample > itk::Statistics::NeighborhoodSampler< TSample >::SubsampleType

Type of the output subsample object Definition at line 77 of file itkNeighborhoodSampler.h.

template<class TSample> typedef SampleAlgorithmBase< TSample > itk::Statistics::NeighborhoodSampler< TSample >::Superclass

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 53 of file itkNeighborhoodSampler.h.

---

Constructor & Destructor Documentation

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

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

Definition at line 133 of file itkNeighborhoodSampler.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 TSample> void itk::Statistics::NeighborhoodSampler< TSample >::GenerateData (  void   )  [protected, virtual]

Calculates the mean and save it Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

template<class TSample> CenterType* itk::Statistics::NeighborhoodSampler< TSample >::GetCenter (  void   )  [inline]

Gets the center Definition at line 104 of file itkNeighborhoodSampler.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.

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

const TSample * itk::Statistics::SampleAlgorithmBase< TSample >::GetInputSample (   )  const [inline, inherited]

Definition at line 82 of file itkSampleAlgorithmBase.h.

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

Get Macro to get the length of a measurement vector. This is equal to the length of each measurement vector contained in the samples that are plugged in as input to this class. GetMeasurementVectorSize() will return zero until the SetInputSample() method has been called

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::NeighborhoodSampler< TSample >::GetNameOfClass (   )  const [virtual]

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

template<class TSample> OutputPointer itk::Statistics::NeighborhoodSampler< TSample >::GetOutput (   )

Gets the Subsample

template<class TSample> RadiusType* itk::Statistics::NeighborhoodSampler< TSample >::GetRadius (  void   )  [inline]

Gets the radius Definition at line 119 of file itkNeighborhoodSampler.h. References itk::m_Radius.

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 TSample> static Pointer itk::Statistics::NeighborhoodSampler< TSample >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

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> virtual void itk::Statistics::NeighborhoodSampler< 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::SampleAlgorithmBase< TSample >.

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::SampleAlgorithmBase< TSample >::SampleAlgorithmBase (   )  [protected, inherited]

template<class TSample> void itk::Statistics::NeighborhoodSampler< TSample >::SetCenter (  CenterType *  center  )  [inline]

Sets the center of the spherical kernel Definition at line 86 of file itkNeighborhoodSampler.h. References itkExceptionMacro, itk::Array< TValueType >::Size(), and itk::fem::this.

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

Stores the sample pointer* void itk::Statistics::SampleAlgorithmBase< TSample >::SetInputSample (  const TSample *  sample  )  [inline, inherited]

Definition at line 63 of file itkSampleAlgorithmBase.h.

virtual void itk::Statistics::SampleAlgorithmBase< TSample >::SetMeasurementVectorSize (  MeasurementVectorSizeType  _arg  )  [virtual, inherited]

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

Returns: Set the MetaDataDictionary

template<class TSample> Sets the radius of the kernel* void itk::Statistics::NeighborhoodSampler< TSample >::SetRadius (  RadiusType *  radius  )  [inline]

Definition at line 108 of file itkNeighborhoodSampler.h. References itk::m_Radius.

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

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

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

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

void itk::Statistics::SampleAlgorithmBase< TSample >::Update (  void   )  [inline, inherited]

dummy function that calls the GenerateData() function to generate output. It exists for future compatibility with ProcessObject without streaming Definition at line 88 of file itkSampleAlgorithmBase.h.

---

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:

• itkNeighborhoodSampler.h

---