ITK  5.4.0
Insight 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>

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, SphinxExamples/src/Numerics/Statistics/DistributionOfPixelsUsingGMM/Code.cxx, and SphinxExamples/src/Segmentation/Classifiers/KMeansClusterOfPixelsInImage/Code.cxx.

Definition at line 45 of file itkSampleClassifierFilter.h.

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

Public Types

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

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 AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
 itkOverrideGetNameOfClassMacro (ProcessObject)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
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
 
 itkOverrideGetNameOfClassMacro (Object)
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

void GenerateData () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 SampleClassifierFilter ()
 
 ~SampleClassifierFilter () override=default
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
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 DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
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 idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- 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 {}
 
 itkOverrideGetNameOfClassMacro (SampleClassifierFilter)
 
static Pointer New ()
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 
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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ClassLabelType

template<typename TSample >
using itk::Statistics::SampleClassifierFilter< TSample >::ClassLabelType = IdentifierType

Definition at line 85 of file itkSampleClassifierFilter.h.

◆ ClassLabelVectorObjectPointer

Definition at line 88 of file itkSampleClassifierFilter.h.

◆ ClassLabelVectorObjectType

Definition at line 87 of file itkSampleClassifierFilter.h.

◆ ClassLabelVectorType

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

Definition at line 86 of file itkSampleClassifierFilter.h.

◆ ConstPointer

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

Definition at line 54 of file itkSampleClassifierFilter.h.

◆ DataObjectPointerArraySizeType

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 150 of file itkSampleClassifierFilter.h.

◆ DecisionRulePointer

Definition at line 92 of file itkSampleClassifierFilter.h.

◆ DecisionRuleType

template<typename TSample >
using itk::Statistics::SampleClassifierFilter< TSample >::DecisionRuleType = DecisionRule

type of the decision rule

Definition at line 91 of file itkSampleClassifierFilter.h.

◆ MeasurementType

template<typename TSample >
using itk::Statistics::SampleClassifierFilter< TSample >::MeasurementType = typename SampleType::MeasurementType

type alias from SampleType object

Definition at line 69 of file itkSampleClassifierFilter.h.

◆ MeasurementVectorType

template<typename TSample >
using itk::Statistics::SampleClassifierFilter< TSample >::MeasurementVectorType = typename SampleType::MeasurementVectorType

Definition at line 70 of file itkSampleClassifierFilter.h.

◆ MembershipFunctionPointer

Definition at line 74 of file itkSampleClassifierFilter.h.

◆ MembershipFunctionsWeightsArrayObjectType

Definition at line 82 of file itkSampleClassifierFilter.h.

◆ MembershipFunctionsWeightsArrayPointer

Definition at line 83 of file itkSampleClassifierFilter.h.

◆ MembershipFunctionsWeightsArrayType

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

type alias for membership functions weight proportion

Definition at line 80 of file itkSampleClassifierFilter.h.

◆ MembershipFunctionType

type alias for the MembershipFunction

Definition at line 73 of file itkSampleClassifierFilter.h.

◆ MembershipFunctionVectorObjectPointer

Definition at line 77 of file itkSampleClassifierFilter.h.

◆ MembershipFunctionVectorObjectType

Definition at line 76 of file itkSampleClassifierFilter.h.

◆ MembershipFunctionVectorType

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

Definition at line 75 of file itkSampleClassifierFilter.h.

◆ MembershipSampleObjectPointer

Definition at line 66 of file itkSampleClassifierFilter.h.

◆ MembershipSampleType

type alias Output type

Definition at line 65 of file itkSampleClassifierFilter.h.

◆ Pointer

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

Definition at line 53 of file itkSampleClassifierFilter.h.

◆ SampleType

template<typename TSample >
using itk::Statistics::SampleClassifierFilter< TSample >::SampleType = TSample

Type of the input Sample

Definition at line 62 of file itkSampleClassifierFilter.h.

◆ Self

template<typename TSample >
using itk::Statistics::SampleClassifierFilter< TSample >::Self = SampleClassifierFilter

Standard class type alias

Definition at line 51 of file itkSampleClassifierFilter.h.

◆ Superclass

template<typename TSample >
using itk::Statistics::SampleClassifierFilter< TSample >::Superclass = ProcessObject

Definition at line 52 of file itkSampleClassifierFilter.h.

Constructor & Destructor Documentation

◆ SampleClassifierFilter()

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

◆ ~SampleClassifierFilter()

template<typename TSample >
itk::Statistics::SampleClassifierFilter< TSample >::~SampleClassifierFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ GenerateData()

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

Starts the classification process

Reimplemented from itk::ProcessObject.

◆ GetDecisionRule()

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

Set/Get the decision rule.

◆ GetInput()

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

◆ GetNumberOfClasses()

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

◆ GetOutput()

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

Returns the classification result

◆ itkOverrideGetNameOfClassMacro()

template<typename TSample >
itk::Statistics::SampleClassifierFilter< TSample >::itkOverrideGetNameOfClassMacro ( SampleClassifierFilter< TSample >  )

Standard macros

◆ MakeOutput()

template<typename TSample >
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.

◆ New()

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

Standard macros

◆ PrintSelf()

template<typename TSample >
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.

◆ SetClassLabels()

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.

◆ SetDecisionRule()

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

Set/Get the decision rule.

◆ SetInput()

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

◆ SetMembershipFunctions()

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.

◆ SetMembershipFunctionsWeightsArray()

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

Sets array of weights for the membership functions

◆ SetNumberOfClasses()

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

◆ m_DecisionRule

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

Decision Rule

Definition at line 160 of file itkSampleClassifierFilter.h.

◆ m_NumberOfClasses

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

Definition at line 157 of file itkSampleClassifierFilter.h.


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