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

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

#include <itkNeighborhoodSampler.h>

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

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

[legend]List of all members.

Public Types
typedef NeighborhoodSampler	Self
typedef SampleAlgorithmBase< TSample >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TSample	SampleType
typedef TSample::MeasurementVectorType	MeasurementVectorType
typedef TSample::MeasurementType	MeasurementType
typedef TSample::FrequencyType	FrequencyType
typedef TSample::InstanceIdentifier	InstanceIdentifier
typedef Superclass::InputSampleType	InputSampleType
typedef Subsample< TSample >	SubsampleType
typedef double	RadiusType
typedef Array< double >	CenterType
typedef SubsampleType	OutputType
typedef SubsampleType::Pointer	OutputPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
void	SetCenter (CenterType *center)
CenterType *	GetCenter ()
RadiusType *	GetRadius ()
OutputPointer	GetOutput ()
void	SetRadius (RadiusType *radius)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	NeighborhoodSampler ()
virtual	~NeighborhoodSampler ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
void	GenerateData ()

---

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.

---

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. Referenced by itk::Statistics::NeighborhoodSampler< TSample >::GetCenter(), itk::Statistics::NeighborhoodSampler< TSample >::SetCenter(), and itk::Statistics::NeighborhoodSampler< TSample >::~NeighborhoodSampler().

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.

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. Referenced by itk::Statistics::NeighborhoodSampler< TSample >::SetRadius(), and itk::Statistics::NeighborhoodSampler< TSample >::~NeighborhoodSampler().

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

MeasurementVector typedef support Definition at line 64 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. Referenced by itk::Statistics::NeighborhoodSampler< TSample >::~NeighborhoodSampler().

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. References itk::Statistics::NeighborhoodSampler< TSample >::CenterType, itk::Statistics::NeighborhoodSampler< TSample >::RadiusType, and itk::Statistics::NeighborhoodSampler< TSample >::Self.

---

Member Function Documentation

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. References itk::Statistics::NeighborhoodSampler< TSample >::CenterType.

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.

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

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

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

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 itk::Statistics::NeighborhoodSampler< TSample >::CenterType, itkExceptionMacro, and itk::Array< double >::Size().

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

Sets the radius of the kernel Definition at line 108 of file itkNeighborhoodSampler.h. References itk::Statistics::NeighborhoodSampler< TSample >::RadiusType.

---

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

• itkNeighborhoodSampler.h

---