Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

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

Container for storing the instance-identifiers of other sample with their associated class labels. More...

#include <itkMembershipSample.h>

Inheritance diagram for itk::Statistics::MembershipSample:

Inheritance graph
[legend]
Collaboration diagram for itk::Statistics::MembershipSample< TSample >:

Collaboration graph
[legend]
List of all members.

[NOHEADER]

virtual const char * GetClassName () const
Pointer New ()

Public Types

typedef MembershipSample Self
typedef Sample< typename TSample::MeasurementVectorType > Superclass
typedef SmartPointer< SelfPointer
typedef TSample::MeasurementVectorType MeasurementVectorType
typedef TSample::MeasurementType MeasurementType
typedef TSample::InstanceIdentifier InstanceIdentifier
typedef TSample::FrequencyType FrequencyType
typedef std::vector< unsigned
int > 
UniqueClassLabelsType
typedef itk::hash_map< InstanceIdentifier,
unsigned int > 
ClassLabelHolderType
typedef Subsample< TSample > ClassSampleType

Public Methods

 itkStaticConstMacro (MeasurementVectorSize, unsigned int, TSample::MeasurementVectorSize)
void SetSample (TSample *sample)
TSample * GetSample ()
void SetNumberOfClasses (unsigned int numberOfClasses)
unsigned int GetNumberOfClasses () const
unsigned int GetNumberOfInstances () const
void AddInstance (const unsigned int &classLabel, const InstanceIdentifier &id)
unsigned int GetClassLabel (const InstanceIdentifier &id) const
int GetInternalClassLabel (const unsigned int classLabel) const
unsigned int GetClassSampleSize (const unsigned int &classLabel) const
ClassSampleTypeGetClassSample (const unsigned int &classLabel)
ClassLabelHolderTypeGetClassLabels ()
unsigned int Size (void) const
unsigned int Size (const unsigned int &dimension) const
MeasurementVectorTypeGetMeasurementVector (const InstanceIdentifier &id)
MeasurementTypeGetMeasurement (const InstanceIdentifier &id, const unsigned int &dimension)
FrequencyType GetFrequency (const InstanceIdentifier &id) const
FrequencyType GetTotalFrequency (const unsigned int &d) const
void Resize (unsigned int n)
Iterator Begin ()
Iterator End ()

Protected Methods

 MembershipSample ()
virtual ~MembershipSample ()
void PrintSelf (std::ostream &os, Indent indent) const

Friends

class Iterator

Detailed Description

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

Container for storing the instance-identifiers of other sample with their associated class labels.

This class does not store any measurement data. In a sense, you can think it as an additional information to basic samples (such as Histogram, PointSetListSampleAdaptor, and ImageToListAdaptor). The additional information is a class label for a measurement vector. Obviously without such basic types of sample, this one is meaningless. You can call any basic methods that has been defined in the Sample class such as GetMeasurementVector and GetFrequency. You can query the class label for an instance using an instance-identifier. Another new and important method is the GetClassSample method. With a given class label, it returns a pointer to the Subsample object that has all the instance-identifiers of instances that belong to the class.

This class is templated over the type of the basic sample. To use all the method, you should first plug in a basic type sample using the SetSample method

Definition at line 51 of file itkMembershipSample.h.


Member Typedef Documentation

template<class TSample>
typedef itk::hash_map< InstanceIdentifier, unsigned int> itk::Statistics::MembershipSample< TSample >::ClassLabelHolderType
 

Typedef for the storage that holds a class label for each instance. The relationship between instances and class label is one-to-one

Definition at line 84 of file itkMembershipSample.h.

template<class TSample>
typedef Subsample< TSample > itk::Statistics::MembershipSample< TSample >::ClassSampleType
 

Typedef for each subsample that stores instance identifers of instances that belong to a class

Definition at line 88 of file itkMembershipSample.h.

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

Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >.

Definition at line 70 of file itkMembershipSample.h.

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

Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >.

Definition at line 69 of file itkMembershipSample.h.

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

Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >.

Definition at line 68 of file itkMembershipSample.h.

template<class TSample>
typedef TSample::MeasurementVectorType itk::Statistics::MembershipSample< 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 67 of file itkMembershipSample.h.

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

Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >.

Definition at line 58 of file itkMembershipSample.h.

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

Standard class typedefs.

Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >.

Definition at line 56 of file itkMembershipSample.h.

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

Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >.

Definition at line 57 of file itkMembershipSample.h.

template<class TSample>
typedef std::vector< unsigned int > itk::Statistics::MembershipSample< TSample >::UniqueClassLabelsType
 

vector of unique class labels that will be used for mapping internal continuous class label with real class labels

Definition at line 80 of file itkMembershipSample.h.


Constructor & Destructor Documentation

template<class TSample>
itk::Statistics::MembershipSample< TSample >::MembershipSample   [protected]
 

template<class TSample>
virtual itk::Statistics::MembershipSample< TSample >::~MembershipSample   [inline, protected, virtual]
 

Definition at line 234 of file itkMembershipSample.h.

References HardConnectedComponentImageFilter::PrintSelf().


Member Function Documentation

template<class TSample>
void itk::Statistics::MembershipSample< TSample >::AddInstance const unsigned int &    classLabel,
const InstanceIdentifier   id
 

template<class TSample>
Iterator itk::Statistics::MembershipSample< TSample >::Begin void    [inline]
 

Definition at line 143 of file itkMembershipSample.h.

template<class TSample>
Iterator itk::Statistics::MembershipSample< TSample >::End void    [inline]
 

Definition at line 149 of file itkMembershipSample.h.

template<class TSample>
unsigned int itk::Statistics::MembershipSample< TSample >::GetClassLabel const InstanceIdentifier   id const
 

template<class TSample>
ClassLabelHolderType* itk::Statistics::MembershipSample< TSample >::GetClassLabels   [inline]
 

Definition at line 111 of file itkMembershipSample.h.

template<class TSample>
virtual const char* itk::Statistics::MembershipSample< TSample >::GetClassName   const [virtual]
 

Standard macros

Reimplemented from itk::Statistics::Sample< TSample::MeasurementVectorType >.

template<class TSample>
ClassSampleType* itk::Statistics::MembershipSample< TSample >::GetClassSample const unsigned int &    classLabel
 

template<class TSample>
unsigned int itk::Statistics::MembershipSample< TSample >::GetClassSampleSize const unsigned int &    classLabel const
 

template<class TSample>
FrequencyType itk::Statistics::MembershipSample< TSample >::GetFrequency const InstanceIdentifier   id const [virtual]
 

returns the frequency of the instance which is identified by the 'id'

Implements itk::Statistics::Sample< TSample::MeasurementVectorType >.

template<class TSample>
int itk::Statistics::MembershipSample< TSample >::GetInternalClassLabel const unsigned int    classLabel const
 

template<class TSample>
MeasurementType& itk::Statistics::MembershipSample< TSample >::GetMeasurement const InstanceIdentifier   id,
const unsigned int &    dimension
 

returns the measurement element which is the 'n'-th element in the 'd' dimension of the measurement vector

template<class TSample>
MeasurementVectorType& itk::Statistics::MembershipSample< TSample >::GetMeasurementVector const InstanceIdentifier   id [virtual]
 

retunrs the measurement of the instance which is identified by the 'id'

Implements itk::Statistics::Sample< TSample::MeasurementVectorType >.

template<class TSample>
unsigned int itk::Statistics::MembershipSample< TSample >::GetNumberOfClasses   const
 

template<class TSample>
unsigned int itk::Statistics::MembershipSample< TSample >::GetNumberOfInstances   const [virtual]
 

Implements itk::Statistics::Sample< TSample::MeasurementVectorType >.

template<class TSample>
TSample* itk::Statistics::MembershipSample< TSample >::GetSample  
 

template<class TSample>
FrequencyType itk::Statistics::MembershipSample< TSample >::GetTotalFrequency const unsigned int &    d const [virtual]
 

returns the total frequency for the 'd' dimension

Implements itk::Statistics::Sample< TSample::MeasurementVectorType >.

template<class TSample>
itk::Statistics::MembershipSample< TSample >::itkStaticConstMacro MeasurementVectorSize   ,
unsigned    int,
TSample::MeasurementVectorSize   
 

MeasurementVectorSize enum from super class

template<class TSample>
Pointer itk::Statistics::MembershipSample< TSample >::New   [static]
 

Standard macros

Reimplemented from itk::Object.

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

template<class TSample>
void itk::Statistics::MembershipSample< TSample >::Resize unsigned int    n [inline]
 

Definition at line 135 of file itkMembershipSample.h.

template<class TSample>
void itk::Statistics::MembershipSample< TSample >::SetNumberOfClasses unsigned int    numberOfClasses
 

template<class TSample>
void itk::Statistics::MembershipSample< TSample >::SetSample TSample *    sample
 

Plug in the actual sample data

template<class TSample>
unsigned int itk::Statistics::MembershipSample< TSample >::Size const unsigned int &    dimension const [virtual]
 

returns the number of elements in the 'dimension' dimension.

Implements itk::Statistics::Sample< TSample::MeasurementVectorType >.

template<class TSample>
unsigned int itk::Statistics::MembershipSample< TSample >::Size void    const [virtual]
 

returns the number of elements in each dimension

Implements itk::Statistics::Sample< TSample::MeasurementVectorType >.


Friends And Related Function Documentation

template<class TSample>
friend class Iterator [friend]
 

Definition at line 141 of file itkMembershipSample.h.


The documentation for this class was generated from the following file:
Generated at Wed Mar 12 01:22:47 2003 for ITK by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2000