OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
otb::FuzzyVariable< TLabel, TPrecision > Class Template Reference

#include <otbFuzzyVariable.h>

+ Inheritance diagram for otb::FuzzyVariable< TLabel, TPrecision >:
+ Collaboration diagram for otb::FuzzyVariable< TLabel, TPrecision >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef TLabel LabelType
 
typedef std::map< LabelType,
PrecisionType
MembershipValueType
 
typedef std::map< LabelType,
ParametersType
ParametersMapType
 
typedef itk::FixedArray
< PrecisionType, 6 > 
ParametersType
 
typedef itk::SmartPointer< SelfPointer
 
typedef TPrecision PrecisionType
 
typedef FuzzyVariable Self
 
typedef itk::DataObject Superclass
 
- Public Types inherited from itk::DataObject
typedef SmartPointer< const SelfConstPointer
 
typedef std::string DataObjectIdentifierType
 
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
 
typedef SmartPointer< SelfPointer
 
typedef DataObject 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

void Clear ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
LabelType GetMaxVar (const PrecisionType &value) const
 
PrecisionType GetMembership (const LabelType &var, const PrecisionType &value) const
 
MembershipValueType GetMembership (const PrecisionType &value) const
 
virtual const char * GetNameOfClass () const
 
void RemoveMembership (const LabelType &var)
 
void SetMembership (const LabelType &var, const PrecisionType &v1, const PrecisionType &v2, const PrecisionType &v3, const PrecisionType &v4)
 
void SetMembership (const LabelType &var, const PrecisionType &v1, const PrecisionType &v2, const PrecisionType &v3, const PrecisionType &v4, const PrecisionType &min, const PrecisionType &max)
 
- Public Member Functions inherited from itk::DataObject
virtual void CopyInformation (const DataObject *)
 
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual const RealTimeStampGetRealTimeStamp () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointerForwardReference
< ProcessObject
GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void Graft (const DataObject *)
 
virtual void Initialize ()
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
 
virtual void ResetPipeline ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
void SetReleaseDataFlag (bool flag)
 
virtual void SetRequestedRegion (const DataObject *)
 
virtual void SetRequestedRegionToLargestPossibleRegion ()
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
virtual void UpdateOutputInformation ()
 
virtual bool VerifyRequestedRegion ()
 
- 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
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () 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 SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- 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

static Pointer New ()
 
static std::ostream & PrintMembershipValueType (std::ostream &out, const MembershipValueType &membership)
 
- Static Public Member Functions inherited from itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- 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

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

ParametersMapType m_MembershipFunctions
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

template<class TLabel = unsigned short, class TPrecision = double>
class otb::FuzzyVariable< TLabel, TPrecision >

Class to represent a fuzzy N-valued variable.

A fuzzy variable is defined as a set of qualitative values for a magnitude. These values are ordered, as for instance Low, Medium, High. The semantics are not used here. This class holds a vector where each component is the membership value for each one of the qualitative values of the variable (MEDIUM = 0.9). Each membership function is modeled by a trapezoidal function for which 4 values have to be provided. In addition, 2 more values can be provided to define the min and the max. By default, they are 0 and 1 respectively.

Definition at line 47 of file otbFuzzyVariable.h.

Member Typedef Documentation

template<class TLabel = unsigned short, class TPrecision = double>
typedef itk::SmartPointer<const Self> otb::FuzzyVariable< TLabel, TPrecision >::ConstPointer

Definition at line 54 of file otbFuzzyVariable.h.

template<class TLabel = unsigned short, class TPrecision = double>
typedef TLabel otb::FuzzyVariable< TLabel, TPrecision >::LabelType

Label typedef

Definition at line 60 of file otbFuzzyVariable.h.

template<class TLabel = unsigned short, class TPrecision = double>
typedef std::map<LabelType, PrecisionType> otb::FuzzyVariable< TLabel, TPrecision >::MembershipValueType

Type to hold the membership values

Definition at line 69 of file otbFuzzyVariable.h.

template<class TLabel = unsigned short, class TPrecision = double>
typedef std::map<LabelType, ParametersType> otb::FuzzyVariable< TLabel, TPrecision >::ParametersMapType

Definition at line 71 of file otbFuzzyVariable.h.

template<class TLabel = unsigned short, class TPrecision = double>
typedef itk::FixedArray< PrecisionType, 6> otb::FuzzyVariable< TLabel, TPrecision >::ParametersType

Definition at line 70 of file otbFuzzyVariable.h.

template<class TLabel = unsigned short, class TPrecision = double>
typedef itk::SmartPointer<Self> otb::FuzzyVariable< TLabel, TPrecision >::Pointer

Definition at line 53 of file otbFuzzyVariable.h.

template<class TLabel = unsigned short, class TPrecision = double>
typedef TPrecision otb::FuzzyVariable< TLabel, TPrecision >::PrecisionType

Precision typedef

Definition at line 66 of file otbFuzzyVariable.h.

template<class TLabel = unsigned short, class TPrecision = double>
typedef FuzzyVariable otb::FuzzyVariable< TLabel, TPrecision >::Self

Standard class typedefs

Definition at line 51 of file otbFuzzyVariable.h.

template<class TLabel = unsigned short, class TPrecision = double>
typedef itk::DataObject otb::FuzzyVariable< TLabel, TPrecision >::Superclass

Definition at line 52 of file otbFuzzyVariable.h.

Constructor & Destructor Documentation

template<class TLabel , class TPrecision >
otb::FuzzyVariable< TLabel, TPrecision >::FuzzyVariable ( )
protected

Constructor

Definition at line 32 of file otbFuzzyVariable.hxx.

template<class TLabel = unsigned short, class TPrecision = double>
otb::FuzzyVariable< TLabel, TPrecision >::~FuzzyVariable ( )
inlineoverrideprotected

Destructor

Definition at line 113 of file otbFuzzyVariable.h.

Member Function Documentation

template<class TLabel , class TPrecision >
void otb::FuzzyVariable< TLabel, TPrecision >::Clear ( void  )

Clear all memberships

Definition at line 110 of file otbFuzzyVariable.hxx.

template<class TLabel = unsigned short, class TPrecision = double>
virtual::itk::LightObject::Pointer otb::FuzzyVariable< TLabel, TPrecision >::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

template<class TLabel , class TPrecision >
FuzzyVariable< TLabel, TPrecision >::LabelType otb::FuzzyVariable< TLabel, TPrecision >::GetMaxVar ( const PrecisionType value) const

Get the label with the highest membership

Definition at line 210 of file otbFuzzyVariable.hxx.

template<class TLabel , class TPrecision >
FuzzyVariable< TLabel, TPrecision >::PrecisionType otb::FuzzyVariable< TLabel, TPrecision >::GetMembership ( const LabelType var,
const PrecisionType value 
) const

Get the membership related to one label

Definition at line 124 of file otbFuzzyVariable.hxx.

template<class TLabel , class TPrecision >
FuzzyVariable< TLabel, TPrecision >::MembershipValueType otb::FuzzyVariable< TLabel, TPrecision >::GetMembership ( const PrecisionType value) const

Get all the memberships

Definition at line 189 of file otbFuzzyVariable.hxx.

template<class TLabel = unsigned short, class TPrecision = double>
virtual const char* otb::FuzzyVariable< TLabel, TPrecision >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::DataObject.

template<class TLabel = unsigned short, class TPrecision = double>
static Pointer otb::FuzzyVariable< TLabel, TPrecision >::New ( )
static

Method for creation through the object factory.

Referenced by otb::Functor::LandsatTM::LinguisticVariables< TInput >::LinguisticVariables().

template<class TLabel , class TPrecision >
std::ostream & otb::FuzzyVariable< TLabel, TPrecision >::PrintMembershipValueType ( std::ostream &  out,
const MembershipValueType membership 
)
static

Print a MembershipValueType

Definition at line 254 of file otbFuzzyVariable.hxx.

template<class TLabel , class TPrecision >
void otb::FuzzyVariable< TLabel, TPrecision >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

PrintSelf method

Reimplemented from itk::DataObject.

Definition at line 246 of file otbFuzzyVariable.hxx.

template<class TLabel , class TPrecision >
void otb::FuzzyVariable< TLabel, TPrecision >::RemoveMembership ( const LabelType var)

Remove a given label from the membership table

Definition at line 98 of file otbFuzzyVariable.hxx.

template<class TLabel , class TPrecision >
void otb::FuzzyVariable< TLabel, TPrecision >::SetMembership ( const LabelType var,
const PrecisionType v1,
const PrecisionType v2,
const PrecisionType v3,
const PrecisionType v4 
)

Set the membership for a given Label

Definition at line 37 of file otbFuzzyVariable.hxx.

template<class TLabel , class TPrecision >
void otb::FuzzyVariable< TLabel, TPrecision >::SetMembership ( const LabelType var,
const PrecisionType v1,
const PrecisionType v2,
const PrecisionType v3,
const PrecisionType v4,
const PrecisionType min,
const PrecisionType max 
)

Definition at line 65 of file otbFuzzyVariable.hxx.

Member Data Documentation

template<class TLabel = unsigned short, class TPrecision = double>
ParametersMapType otb::FuzzyVariable< TLabel, TPrecision >::m_MembershipFunctions
private

Map containing the membership functions

Definition at line 120 of file otbFuzzyVariable.h.


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