ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::Statistics::SampleClassifierFilter< TSample > Class Template Reference

#include <itkSampleClassifierFilter.h>

+ Inheritance diagram for itk::Statistics::SampleClassifierFilter< TSample >:
+ Collaboration diagram for itk::Statistics::SampleClassifierFilter< TSample >:

Detailed Description

template<typename TSample>
class itk::Statistics::SampleClassifierFilter< TSample >

Sample classification class.

This filter takes as input a Sample and produces as output a classification in the form of a MembershipSample object.

Examples:
Examples/Statistics/BayesianPluginClassifier.cxx, Examples/Statistics/KdTreeBasedKMeansClustering.cxx, WikiExamples/Statistics/KdTreeBasedKMeansClustering1D.cxx, and WikiExamples/Statistics/KdTreeBasedKMeansClustering3D.cxx.

Definition at line 44 of file itkSampleClassifierFilter.h.

Public Types

typedef IdentifierType ClassLabelType
 
typedef
ClassLabelVectorObjectType::Pointer 
ClassLabelVectorObjectPointer
 
typedef
SimpleDataObjectDecorator
< ClassLabelVectorType
ClassLabelVectorObjectType
 
typedef std::vector
< ClassLabelType
ClassLabelVectorType
 
typedef SmartPointer< const SelfConstPointer
 
typedef
DecisionRuleType::ConstPointer 
DecisionRulePointer
 
typedef DecisionRule DecisionRuleType
 
typedef SampleType::MeasurementType MeasurementType
 
typedef
SampleType::MeasurementVectorType 
MeasurementVectorType
 
typedef
MembershipFunctionType::ConstPointer 
MembershipFunctionPointer
 
typedef
SimpleDataObjectDecorator
< MembershipFunctionsWeightsArrayType
MembershipFunctionsWeightsArrayObjectType
 
typedef
MembershipFunctionsWeightsArrayObjectType::Pointer 
MembershipFunctionsWeightsArrayPointer
 
typedef Array< double > MembershipFunctionsWeightsArrayType
 
typedef MembershipFunctionBase
< MeasurementVectorType
MembershipFunctionType
 
typedef
MembershipFunctionVectorObjectType::Pointer 
MembershipFunctionVectorObjectPointer
 
typedef
SimpleDataObjectDecorator
< MembershipFunctionVectorType
MembershipFunctionVectorObjectType
 
typedef std::vector
< MembershipFunctionPointer
MembershipFunctionVectorType
 
typedef
MembershipSampleType::Pointer 
MembershipSampleObjectPointer
 
typedef MembershipSample
< SampleType
MembershipSampleType
 
typedef SmartPointer< SelfPointer
 
typedef TSample SampleType
 
typedef SampleClassifierFilter Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

const SampleTypeGetInput () const
 
const MembershipSampleTypeGetOutput () const
 
void SetClassLabels (const ClassLabelVectorObjectType *classLabels)
 
void SetInput (const SampleType *sample)
 
void SetMembershipFunctions (const MembershipFunctionVectorObjectType *membershipFunctions)
 
void SetMembershipFunctionsWeightsArray (const MembershipFunctionsWeightsArrayObjectType *weightsArray)
 
virtual void SetNumberOfClasses (unsigned int _arg)
 
virtual unsigned int GetNumberOfClasses () const
 
virtual void SetDecisionRule (const DecisionRuleType *_arg)
 
virtual const DecisionRuleTypeGetDecisionRule () const
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

virtual void GenerateData () override
 
void operator= (const Self &)
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 SampleClassifierFilter ()
 
 SampleClassifierFilter (const Self &)
 
virtual ~SampleClassifierFilter ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

DecisionRulePointer m_DecisionRule
 
unsigned int m_NumberOfClasses
 
virtual const char * GetNameOfClass () const
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
static Pointer New ()
 
typedef
ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TSample >
typedef IdentifierType itk::Statistics::SampleClassifierFilter< TSample >::ClassLabelType

Definition at line 87 of file itkSampleClassifierFilter.h.

Definition at line 91 of file itkSampleClassifierFilter.h.

Definition at line 90 of file itkSampleClassifierFilter.h.

template<typename TSample >
typedef std::vector< ClassLabelType > itk::Statistics::SampleClassifierFilter< TSample >::ClassLabelVectorType

Definition at line 88 of file itkSampleClassifierFilter.h.

template<typename TSample >
typedef SmartPointer< const Self > itk::Statistics::SampleClassifierFilter< TSample >::ConstPointer

Definition at line 52 of file itkSampleClassifierFilter.h.

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See Also
ProcessObject

Definition at line 148 of file itkSampleClassifierFilter.h.

Definition at line 95 of file itkSampleClassifierFilter.h.

template<typename TSample >
typedef DecisionRule itk::Statistics::SampleClassifierFilter< TSample >::DecisionRuleType

type of the decision rule

Definition at line 94 of file itkSampleClassifierFilter.h.

template<typename TSample >
typedef SampleType::MeasurementType itk::Statistics::SampleClassifierFilter< TSample >::MeasurementType

typedefs from SampleType object

Definition at line 67 of file itkSampleClassifierFilter.h.

template<typename TSample >
typedef SampleType::MeasurementVectorType itk::Statistics::SampleClassifierFilter< TSample >::MeasurementVectorType

Definition at line 68 of file itkSampleClassifierFilter.h.

Definition at line 72 of file itkSampleClassifierFilter.h.

Definition at line 83 of file itkSampleClassifierFilter.h.

Definition at line 85 of file itkSampleClassifierFilter.h.

template<typename TSample >
typedef Array< double > itk::Statistics::SampleClassifierFilter< TSample >::MembershipFunctionsWeightsArrayType

typedef for membership functions weight proprtion

Definition at line 80 of file itkSampleClassifierFilter.h.

typedef for the MembershipFunction

Definition at line 71 of file itkSampleClassifierFilter.h.

Definition at line 77 of file itkSampleClassifierFilter.h.

Definition at line 75 of file itkSampleClassifierFilter.h.

template<typename TSample >
typedef std::vector< MembershipFunctionPointer > itk::Statistics::SampleClassifierFilter< TSample >::MembershipFunctionVectorType

Definition at line 73 of file itkSampleClassifierFilter.h.

Definition at line 64 of file itkSampleClassifierFilter.h.

typedefs Output type

Definition at line 63 of file itkSampleClassifierFilter.h.

template<typename TSample >
typedef SmartPointer< Self > itk::Statistics::SampleClassifierFilter< TSample >::Pointer

Definition at line 51 of file itkSampleClassifierFilter.h.

template<typename TSample >
typedef TSample itk::Statistics::SampleClassifierFilter< TSample >::SampleType

Type of the input Sample

Definition at line 56 of file itkSampleClassifierFilter.h.

template<typename TSample >
typedef SampleClassifierFilter itk::Statistics::SampleClassifierFilter< TSample >::Self

Standard class typedef

Definition at line 49 of file itkSampleClassifierFilter.h.

template<typename TSample >
typedef ProcessObject itk::Statistics::SampleClassifierFilter< TSample >::Superclass

Definition at line 50 of file itkSampleClassifierFilter.h.

Constructor & Destructor Documentation

template<typename TSample >
itk::Statistics::SampleClassifierFilter< TSample >::SampleClassifierFilter ( )
protected
template<typename TSample >
virtual itk::Statistics::SampleClassifierFilter< TSample >::~SampleClassifierFilter ( )
inlineprotectedvirtual

Definition at line 133 of file itkSampleClassifierFilter.h.

template<typename TSample >
itk::Statistics::SampleClassifierFilter< TSample >::SampleClassifierFilter ( const Self )
protected

Member Function Documentation

template<typename TSample >
virtual::itk::LightObject::Pointer itk::Statistics::SampleClassifierFilter< TSample >::CreateAnother ( ) const
virtual

Standard macros

Reimplemented from itk::Object.

template<typename TSample >
virtual void itk::Statistics::SampleClassifierFilter< TSample >::GenerateData ( )
overrideprotectedvirtual

Starts the classification process

Reimplemented from itk::ProcessObject.

template<typename TSample >
virtual const DecisionRuleType* itk::Statistics::SampleClassifierFilter< TSample >::GetDecisionRule ( ) const
virtual

Set/Get the decision rule.

template<typename TSample >
const SampleType* itk::Statistics::SampleClassifierFilter< TSample >::GetInput ( ) const
template<typename TSample >
virtual const char* itk::Statistics::SampleClassifierFilter< TSample >::GetNameOfClass ( ) const
virtual

Standard macros

Reimplemented from itk::ProcessObject.

template<typename TSample >
virtual unsigned int itk::Statistics::SampleClassifierFilter< TSample >::GetNumberOfClasses ( ) const
virtual

Number of classes. This must match the number of labels and membership functions provided by the user, otherwise an exception will be thrown at

template<typename TSample >
const MembershipSampleType* itk::Statistics::SampleClassifierFilter< TSample >::GetOutput ( ) const

Returns the classification result

template<typename TSample >
virtual DataObjectPointer itk::Statistics::SampleClassifierFilter< TSample >::MakeOutput ( DataObjectPointerArraySizeType  idx)
overrideprotectedvirtual

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See Also
ProcessObject

Reimplemented from itk::ProcessObject.

template<typename TSample >
static Pointer itk::Statistics::SampleClassifierFilter< TSample >::New ( )
static

Standard macros

template<typename TSample >
void itk::Statistics::SampleClassifierFilter< TSample >::operator= ( const Self )
protected
template<typename TSample >
virtual void itk::Statistics::SampleClassifierFilter< TSample >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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

template<typename TSample >
void itk::Statistics::SampleClassifierFilter< TSample >::SetClassLabels ( const ClassLabelVectorObjectType classLabels)

Sets input vector of class labels. The length of this vector must match the number of classes, otherwise an exception will be thrown at run time.

template<typename TSample >
virtual void itk::Statistics::SampleClassifierFilter< TSample >::SetDecisionRule ( const DecisionRuleType _arg)
virtual

Set/Get the decision rule.

template<typename TSample >
void itk::Statistics::SampleClassifierFilter< TSample >::SetInput ( const SampleType sample)
template<typename TSample >
void itk::Statistics::SampleClassifierFilter< TSample >::SetMembershipFunctions ( const MembershipFunctionVectorObjectType membershipFunctions)

Sets input vector of membership functions. The length of this vector must match the number of classes, otherwise an exception will be thrown at run time.

template<typename TSample >
void itk::Statistics::SampleClassifierFilter< TSample >::SetMembershipFunctionsWeightsArray ( const MembershipFunctionsWeightsArrayObjectType weightsArray)

Sets array of weights for the membership functions

template<typename TSample >
virtual void itk::Statistics::SampleClassifierFilter< TSample >::SetNumberOfClasses ( unsigned int  _arg)
virtual

Number of classes. This must match the number of labels and membership functions provided by the user, otherwise an exception will be thrown at

Member Data Documentation

template<typename TSample >
DecisionRulePointer itk::Statistics::SampleClassifierFilter< TSample >::m_DecisionRule
private

Decision Rule

Definition at line 158 of file itkSampleClassifierFilter.h.

template<typename TSample >
unsigned int itk::Statistics::SampleClassifierFilter< TSample >::m_NumberOfClasses
private

Definition at line 155 of file itkSampleClassifierFilter.h.


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