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

MembershipSampleGenerator generates a MembershipSample object using a class mask sample. More...

#include <itkMembershipSampleGenerator.h>

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

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

[legend]List of all members.

[NOHEADER]
virtual const char *	GetNameOfClass () const
Pointer	New ()
Public Types
typedef MembershipSampleGenerator	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputSample::MeasurementVectorType	MeasurementVectorType
typedef MembershipSample< TInputSample >	OutputType
typedef OutputType::Pointer	OutputPointer
Public Member Functions
void	SetInput (const TInputSample *sample)
const TInputSample *	GetInput () const
void	SetClassMask (const TClassMaskSample *classMask)
const TClassMaskSample *	GetClassMask () const
void	SetNumberOfClasses (int numberOfClasses)
int	GetNumberOfClasses ()
const OutputType *	GetOutput () const
void	GenerateData ()
Protected Member Functions
	MembershipSampleGenerator ()
virtual	~MembershipSampleGenerator ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

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

MembershipSampleGenerator generates a MembershipSample object using a class mask sample.

You can see it as a filter that takes two samples as input and generates a MembershipSample. There are two class template arguments first one is the type of basic sample that has measurement vectors in it, and the second one is the type of sample that its measurement vectors has only one component - class label. What it does is that it merges measurement vectors and class labels in a single MembershipSample object.

To get the MembershipSample object you should plug in the input sample and the class mask sample using SetInput and SetClassMask methods respectively.

NOTE: This generator expects the class labels in the class mask sample to be integer value where the value starts 0 and increases without any missing value between 0 to the last class label value.

See also:

MembershipSample

Definition at line 51 of file itkMembershipSampleGenerator.h.

---

Member Typedef Documentation

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

Reimplemented from itk::Object. Definition at line 59 of file itkMembershipSampleGenerator.h.

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

Input sample types alias Definition at line 67 of file itkMembershipSampleGenerator.h.

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

Definition at line 71 of file itkMembershipSampleGenerator.h. Referenced by itk::Statistics::MembershipSampleGenerator< TInputSample, TClassMaskSample >::~MembershipSampleGenerator().

template<class TInputSample, class TClassMaskSample> typedef MembershipSample< TInputSample > itk::Statistics::MembershipSampleGenerator< TInputSample, TClassMaskSample >::OutputType

Output: MembershipSample types Definition at line 70 of file itkMembershipSampleGenerator.h.

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

Reimplemented from itk::Object. Definition at line 58 of file itkMembershipSampleGenerator.h.

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

Standard class typedefs. Reimplemented from itk::Object. Definition at line 56 of file itkMembershipSampleGenerator.h.

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

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

---

Constructor & Destructor Documentation

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

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

Definition at line 98 of file itkMembershipSampleGenerator.h. References itk::Statistics::MembershipSampleGenerator< TInputSample, TClassMaskSample >::OutputPointer.

---

Member Function Documentation

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

The actual output generation procedure.

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

Returns the class mask sample pointer

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

Returns the input sample pointer

template<class TInputSample, class TClassMaskSample> virtual const char* itk::Statistics::MembershipSampleGenerator< TInputSample, TClassMaskSample >::GetNameOfClass (   )  const [virtual]

Standard Macros Reimplemented from itk::Object.

template<class TInputSample, class TClassMaskSample> int itk::Statistics::MembershipSampleGenerator< TInputSample, TClassMaskSample >::GetNumberOfClasses (   )

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

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

template<class TInputSample, class TClassMaskSample> Pointer itk::Statistics::MembershipSampleGenerator< TInputSample, TClassMaskSample >::New (   )  [static]

Standard Macros Reimplemented from itk::Object.

template<class TInputSample, class TClassMaskSample> void itk::Statistics::MembershipSampleGenerator< 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.

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

Stores the class mask sample

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

Stores the input sample

template<class TInputSample, class TClassMaskSample> void itk::Statistics::MembershipSampleGenerator< TInputSample, TClassMaskSample >::SetNumberOfClasses (  int  numberOfClasses  )

---

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

• itkMembershipSampleGenerator.h

---