ITK  5.2.0
Insight Toolkit
Public Types | 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 >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
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
 
using SampleType = TSample
 
using MembershipSampleType = MembershipSample< SampleType >
 
using MembershipSampleObjectPointer = typename MembershipSampleType::Pointer
 
using MeasurementType = typename SampleType::MeasurementType
 
using MeasurementVectorType = typename SampleType::MeasurementVectorType
 
using MembershipFunctionType = MembershipFunctionBase< MeasurementVectorType >
 
using MembershipFunctionPointer = typename MembershipFunctionType::ConstPointer
 
using MembershipFunctionVectorType = std::vector< MembershipFunctionPointer >
 
using MembershipFunctionVectorObjectType = SimpleDataObjectDecorator< MembershipFunctionVectorType >
 
using MembershipFunctionVectorObjectPointer = typename MembershipFunctionVectorObjectType::Pointer
 
using MembershipFunctionsWeightsArrayType = Array< double >
 
using MembershipFunctionsWeightsArrayObjectType = SimpleDataObjectDecorator< MembershipFunctionsWeightsArrayType >
 
using MembershipFunctionsWeightsArrayPointer = typename MembershipFunctionsWeightsArrayObjectType::Pointer
 
using ClassLabelType = IdentifierType
 
using ClassLabelVectorType = std::vector< ClassLabelType >
 
using ClassLabelVectorObjectType = SimpleDataObjectDecorator< ClassLabelVectorType >
 
using ClassLabelVectorObjectPointer = ClassLabelVectorObjectType::Pointer
 
using DecisionRuleType = DecisionRule
 
using DecisionRulePointer = DecisionRuleType::ConstPointer
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 
unsigned int m_NumberOfClasses
 
DecisionRulePointer m_DecisionRule
 
virtual const char * GetNameOfClass () const
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
void SetInput (const SampleType *sample)
 
const SampleTypeGetInput () const
 
const MembershipSampleTypeGetOutput () const
 
virtual void SetNumberOfClasses (unsigned int _arg)
 
virtual unsigned int GetNumberOfClasses () const
 
virtual void SetDecisionRule (const DecisionRuleType *_arg)
 
virtual const DecisionRuleTypeGetDecisionRule () const
 
void SetClassLabels (const ClassLabelVectorObjectType *classLabels)
 
void SetMembershipFunctions (const MembershipFunctionVectorObjectType *membershipFunctions)
 
void SetMembershipFunctionsWeightsArray (const MembershipFunctionsWeightsArrayObjectType *weightsArray)
 
static Pointer New ()
 
 SampleClassifierFilter ()
 
 ~SampleClassifierFilter () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void GenerateData () override
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 

Additional Inherited Members

- 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 ()
 
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)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
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)
 
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 SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- 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
 
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
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 
- 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 Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void GenerateOutputInformation ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- 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
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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.

Member Typedef Documentation

◆ ClassLabelType

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

Type of the input Sample

Definition at line 85 of file itkSampleClassifierFilter.h.

◆ ClassLabelVectorObjectPointer

Type of the input Sample

Definition at line 88 of file itkSampleClassifierFilter.h.

◆ ClassLabelVectorObjectType

Type of the input Sample

Definition at line 87 of file itkSampleClassifierFilter.h.

◆ ClassLabelVectorType

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

Type of the input Sample

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

Type of the input Sample

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

Type of the input Sample

Definition at line 70 of file itkSampleClassifierFilter.h.

◆ MembershipFunctionPointer

Type of the input Sample

Definition at line 74 of file itkSampleClassifierFilter.h.

◆ MembershipFunctionsWeightsArrayObjectType

Type of the input Sample

Definition at line 82 of file itkSampleClassifierFilter.h.

◆ MembershipFunctionsWeightsArrayPointer

Type of the input Sample

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 proprtion

Definition at line 80 of file itkSampleClassifierFilter.h.

◆ MembershipFunctionType

type alias for the MembershipFunction

Definition at line 73 of file itkSampleClassifierFilter.h.

◆ MembershipFunctionVectorObjectPointer

Type of the input Sample

Definition at line 77 of file itkSampleClassifierFilter.h.

◆ MembershipFunctionVectorObjectType

Type of the input Sample

Definition at line 76 of file itkSampleClassifierFilter.h.

◆ MembershipFunctionVectorType

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

Type of the input Sample

Definition at line 75 of file itkSampleClassifierFilter.h.

◆ MembershipSampleObjectPointer

Type of the input Sample

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

Type of the input Sample

◆ ~SampleClassifierFilter()

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

Type of the input Sample

Member Function Documentation

◆ CreateAnother()

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

Type of the input Sample

Reimplemented from itk::Object.

◆ 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

Type of the input Sample

◆ GetInput()

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

Type of the input Sample

◆ GetNameOfClass()

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

Standard macros

Reimplemented from itk::ProcessObject.

◆ GetNumberOfClasses()

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

Type of the input Sample

◆ GetOutput()

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

Returns the classification result

◆ MakeOutput()

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

Type of the input Sample

Reimplemented from itk::ProcessObject.

◆ New()

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

Type of the input Sample

◆ PrintSelf()

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

Type of the input Sample

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)

Type of the input 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

Type of the input Sample

Definition at line 157 of file itkSampleClassifierFilter.h.


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