ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | List of all members
itk::Statistics::DecisionRule Class Referenceabstract

#include <itkDecisionRule.h>

+ Inheritance diagram for itk::Statistics::DecisionRule:
+ Collaboration diagram for itk::Statistics::DecisionRule:

Public Types

using ClassIdentifierType = MembershipVectorType::size_type
 
using ConstPointer = SmartPointer< const Self >
 
using MembershipValueType = double
 
using MembershipVectorType = std::vector< MembershipValueType >
 
using Pointer = SmartPointer< Self >
 
using Self = DecisionRule
 
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

virtual ClassIdentifierType Evaluate (const MembershipVectorType &discriminantScores) const =0
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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
 
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
 

Protected Member Functions

 DecisionRule ()
 
 ~DecisionRule () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
void PrintSelf (std::ostream &os, Indent indent) const 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 ()
 

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::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

Base class for decision rules that return a class label based on a set of discriminant scores.

DecisionRule is the base class for decision rules used in classification. Subclasses of DecisionRule include MaximumDecisionRule, MinimumDecisionRule, and MaximumRationDecisionRule, This class has a pure virtual function, Evaluate(), which implements the particular decision rule, given a set of discriminant scores. Concrete subclasses of DecisionRule must implement this method.

Definition at line 48 of file itkDecisionRule.h.

Member Typedef Documentation

◆ ClassIdentifierType

using itk::Statistics::DecisionRule::ClassIdentifierType = MembershipVectorType::size_type

Types for class identifiers.

Definition at line 67 of file itkDecisionRule.h.

◆ ConstPointer

Definition at line 57 of file itkDecisionRule.h.

◆ MembershipValueType

Types for discriminant values and vectors.

Definition at line 63 of file itkDecisionRule.h.

◆ MembershipVectorType

Definition at line 64 of file itkDecisionRule.h.

◆ Pointer

◆ Self

Standard class type aliases

Definition at line 54 of file itkDecisionRule.h.

◆ Superclass

Definition at line 55 of file itkDecisionRule.h.

Constructor & Destructor Documentation

◆ DecisionRule()

itk::Statistics::DecisionRule::DecisionRule ( )
protected

◆ ~DecisionRule()

itk::Statistics::DecisionRule::~DecisionRule ( )
overrideprotected

Member Function Documentation

◆ Evaluate()

virtual ClassIdentifierType itk::Statistics::DecisionRule::Evaluate ( const MembershipVectorType discriminantScores) const
pure virtual

Evaluate the decision rule. The return value of this function is a class label. Functions returns the best label given the discriminant scores using its internal logic.

Implemented in itk::Statistics::MaximumRatioDecisionRule, itk::Statistics::MaximumDecisionRule, and itk::Statistics::MinimumDecisionRule.

◆ GetNameOfClass()

virtual const char* itk::Statistics::DecisionRule::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods)

Reimplemented from itk::Object.

Reimplemented in itk::Statistics::MaximumRatioDecisionRule, itk::Statistics::MaximumDecisionRule, and itk::Statistics::MinimumDecisionRule.


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