ITK
6.0.0
Insight Toolkit
|
#include <itkMembershipFunctionBase.h>
MembershipFunctionBase defines common interfaces for membership functions.
MembershipFunctionBase is a subclass of FunctionBase which restricts the function type to be a membership function. Membership functions provide a mapping from an arbitrary domain to a set of real numbers. Membership functions are typically used to model or approximate likelihood functions, \(p( x | i )\), i.e. the probability of the measurement \(x\) belonging to a class \(i\).
The Statistics framework models random variables \(x\) as vectors. Typical uses of MembershipFunctions include templating over a FixedArray, Array, Vector, or VariableLengthVector.
The Evaluate() method returns the membership rank or likelihood that the measurement belongs to the class represented by this membership function.
Evaluations of a single measurement across of set MembershipFunctions can then be passed to a DecisionRule in order to establish class (or group) assignment.
Definition at line 58 of file itkMembershipFunctionBase.h.
Public Types | |
using | ConstPointer = SmartPointer< const Self > |
using | MeasurementVectorSizeType = unsigned int |
using | MeasurementVectorType = TVector |
using | Pointer = SmartPointer< Self > |
using | Self = MembershipFunctionBase |
using | Superclass = FunctionBase< TVector, double > |
Public Types inherited from itk::FunctionBase< TVector, double > | |
using | ConstPointer = SmartPointer< const Self > |
using | InputType = TVector |
using | OutputType = double |
using | Pointer = SmartPointer< Self > |
using | Self = FunctionBase |
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 | |
double | Evaluate (const MeasurementVectorType &x) const override=0 |
virtual MeasurementVectorSizeType | GetMeasurementVectorSize () const |
const char * | GetNameOfClass () const override |
virtual void | SetMeasurementVectorSize (MeasurementVectorSizeType s) |
Public Member Functions inherited from itk::FunctionBase< TVector, double > | |
virtual OutputType | Evaluate (const InputType &input) const=0 |
const char * | GetNameOfClass () const override |
Public Member Functions inherited from itk::Object | |
unsigned long | AddObserver (const EventObject &event, Command *cmd) 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 |
Command * | GetCommand (unsigned long tag) |
bool | GetDebug () const |
MetaDataDictionary & | GetMetaDataDictionary () |
const MetaDataDictionary & | GetMetaDataDictionary () const |
virtual ModifiedTimeType | GetMTime () const |
const char * | GetNameOfClass () const override |
virtual const TimeStamp & | GetTimeStamp () 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) const |
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 Pointer | CreateAnother () const |
virtual void | Delete () |
virtual const char * | GetNameOfClass () const |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
virtual void | Register () const |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const noexcept |
Protected Member Functions | |
MembershipFunctionBase () | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
~MembershipFunctionBase () override=default | |
Protected Member Functions inherited from itk::FunctionBase< TVector, double > | |
FunctionBase ()=default | |
~FunctionBase () override=default | |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
void | PrintSelf (std::ostream &os, Indent indent) const override |
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 | PrintSelf (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Private Attributes | |
MeasurementVectorSizeType | m_MeasurementVectorSize {} |
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 () |
Protected Attributes inherited from itk::LightObject | |
std::atomic< int > | m_ReferenceCount {} |
using itk::Statistics::MembershipFunctionBase< TVector >::ConstPointer = SmartPointer<const Self> |
Definition at line 67 of file itkMembershipFunctionBase.h.
using itk::Statistics::MembershipFunctionBase< TVector >::MeasurementVectorSizeType = unsigned int |
Typedef for the length of each measurement vector
Definition at line 76 of file itkMembershipFunctionBase.h.
using itk::Statistics::MembershipFunctionBase< TVector >::MeasurementVectorType = TVector |
MeasurementVector type alias support
Definition at line 73 of file itkMembershipFunctionBase.h.
using itk::Statistics::MembershipFunctionBase< TVector >::Pointer = SmartPointer<Self> |
Definition at line 66 of file itkMembershipFunctionBase.h.
using itk::Statistics::MembershipFunctionBase< TVector >::Self = MembershipFunctionBase |
Standard class type aliases
Definition at line 64 of file itkMembershipFunctionBase.h.
using itk::Statistics::MembershipFunctionBase< TVector >::Superclass = FunctionBase<TVector, double> |
Definition at line 65 of file itkMembershipFunctionBase.h.
|
inlineprotected |
Definition at line 128 of file itkMembershipFunctionBase.h.
References itk::NumericTraits< T >::GetLength().
|
overrideprotecteddefault |
|
overridepure virtual |
Method to get membership score (discriminant score) of an entity or measurement. Evaluate() maps from a vector measurement type to a real number.
Implements itk::FunctionBase< TVector, double >.
Implemented in itk::Statistics::DistanceToCentroidMembershipFunction< TVector >, itk::Statistics::GaussianMembershipFunction< TMeasurementVector >, and itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >.
|
virtual |
Get the length of the measurement vector
|
overridevirtual |
Reimplemented from itk::Object.
|
inlineoverrideprotectedvirtual |
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::Object.
Definition at line 136 of file itkMembershipFunctionBase.h.
|
inlinevirtual |
Set the length of the measurement vector. If this membership function is templated over a vector type that can be resized, the new size is set. If the vector type has a fixed size and an attempt is made to change its size, an exception is thrown. Subclasses may have to override this method if a change in vector size requires invalidating other instance variables, e.g. covariance matrices, mean vectors, etc.
Reimplemented in itk::Statistics::DistanceToCentroidMembershipFunction< TVector >.
Definition at line 92 of file itkMembershipFunctionBase.h.
References itk::NumericTraits< T >::GetLength().
|
private |
Definition at line 143 of file itkMembershipFunctionBase.h.