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

#include <otbSOMClassifier.h>

+ Inheritance diagram for otb::SOMClassifier< TSample, TSOMMap, TLabel >:
+ Collaboration diagram for otb::SOMClassifier< TSample, TSOMMap, TLabel >:

Public Types

typedef TLabel ClassLabelType
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
SampleType::MeasurementVectorType::ValueType 
InputPixelType
 
typedef SampleType::MeasurementType MeasurementType
 
typedef
SampleType::MeasurementVectorType 
MeasurementVectorType
 
typedef OutputType::Pointer OutputPointerType
 
typedef
itk::Statistics::MembershipSample
< SampleType
OutputType
 
typedef itk::SmartPointer< SelfPointer
 
typedef SampleType::Pointer SamplePointerType
 
typedef TSample SampleType
 
typedef SOMClassifier Self
 
typedef SOMMapType::Pointer SOMMapPointerType
 
typedef TSOMMap SOMMapType
 
typedef itk::ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject 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

 itkGetObjectMacro (Sample, SampleType)
 
virtual void SetSample (SampleType *_arg)
 
- 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 ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual bool GetReleaseDataFlag () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
void ReleaseDataFlagOff ()
 
void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
- 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
 

Protected Member Functions

 ~SOMClassifier () override
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual const char * GetPrimaryOutputName (void) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
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 num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
- 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

SamplePointerType m_Sample
 
virtual const char * GetNameOfClass () const
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
static Pointer New ()
 
void SetMap (SOMMapType *sommap)
 
SOMMapTypeGetMap (void)
 
OutputTypeGetOutput ()
 
 SOMClassifier ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void GenerateData () 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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

template<class TSample, class TSOMMap, class TLabel>
class otb::SOMClassifier< TSample, TSOMMap, TLabel >

This class implements a SOM-Based classifier.

The classifier iterates on the input list sample, feeding the output membership sample with the one-dimensionnal index of the winner neuron.

Since this classifier differs from the base framework of itk in that it does not use DecisionRule and Memberships function, it derives from itk::ProcessObject instead of itk::SampleClassifierBase.

See Also
SOM, SOMMap, SOMActivationBuilder.

Definition at line 47 of file otbSOMClassifier.h.

Member Typedef Documentation

template<class TSample , class TSOMMap , class TLabel >
typedef TLabel otb::SOMClassifier< TSample, TSOMMap, TLabel >::ClassLabelType

Label type typedef

Definition at line 78 of file otbSOMClassifier.h.

template<class TSample , class TSOMMap , class TLabel >
typedef itk::SmartPointer<const Self> otb::SOMClassifier< TSample, TSOMMap, TLabel >::ConstPointer

Definition at line 55 of file otbSOMClassifier.h.

template<class TSample , class TSOMMap , class TLabel >
typedef SampleType::MeasurementVectorType::ValueType otb::SOMClassifier< TSample, TSOMMap, TLabel >::InputPixelType

Definition at line 67 of file otbSOMClassifier.h.

template<class TSample , class TSOMMap , class TLabel >
typedef SampleType::MeasurementType otb::SOMClassifier< TSample, TSOMMap, TLabel >::MeasurementType

Definition at line 65 of file otbSOMClassifier.h.

template<class TSample , class TSOMMap , class TLabel >
typedef SampleType::MeasurementVectorType otb::SOMClassifier< TSample, TSOMMap, TLabel >::MeasurementVectorType

Definition at line 66 of file otbSOMClassifier.h.

template<class TSample , class TSOMMap , class TLabel >
typedef OutputType::Pointer otb::SOMClassifier< TSample, TSOMMap, TLabel >::OutputPointerType

Definition at line 75 of file otbSOMClassifier.h.

template<class TSample , class TSOMMap , class TLabel >
typedef itk::Statistics::MembershipSample<SampleType> otb::SOMClassifier< TSample, TSOMMap, TLabel >::OutputType

Output typedefs

Definition at line 74 of file otbSOMClassifier.h.

template<class TSample , class TSOMMap , class TLabel >
typedef itk::SmartPointer<Self> otb::SOMClassifier< TSample, TSOMMap, TLabel >::Pointer

Definition at line 54 of file otbSOMClassifier.h.

template<class TSample , class TSOMMap , class TLabel >
typedef SampleType::Pointer otb::SOMClassifier< TSample, TSOMMap, TLabel >::SamplePointerType

Definition at line 64 of file otbSOMClassifier.h.

template<class TSample , class TSOMMap , class TLabel >
typedef TSample otb::SOMClassifier< TSample, TSOMMap, TLabel >::SampleType

typedefs from TSample object

Definition at line 59 of file otbSOMClassifier.h.

template<class TSample , class TSOMMap , class TLabel >
typedef SOMClassifier otb::SOMClassifier< TSample, TSOMMap, TLabel >::Self

Standard class typedef

Definition at line 52 of file otbSOMClassifier.h.

template<class TSample , class TSOMMap , class TLabel >
typedef SOMMapType::Pointer otb::SOMClassifier< TSample, TSOMMap, TLabel >::SOMMapPointerType

Definition at line 71 of file otbSOMClassifier.h.

template<class TSample , class TSOMMap , class TLabel >
typedef TSOMMap otb::SOMClassifier< TSample, TSOMMap, TLabel >::SOMMapType

SOM Map typedefs

Definition at line 70 of file otbSOMClassifier.h.

template<class TSample , class TSOMMap , class TLabel >
typedef itk::ProcessObject otb::SOMClassifier< TSample, TSOMMap, TLabel >::Superclass

Definition at line 53 of file otbSOMClassifier.h.

Constructor & Destructor Documentation

template<class TSample , class TSOMMap , class TLabel >
otb::SOMClassifier< TSample, TSOMMap, TLabel >::SOMClassifier ( )
protected

Constructor

Definition at line 34 of file otbSOMClassifier.hxx.

References itk::SmartPointer< TObjectType >::GetPointer().

template<class TSample , class TSOMMap , class TLabel >
otb::SOMClassifier< TSample, TSOMMap, TLabel >::~SOMClassifier ( )
inlineoverrideprotected

Destructor

Definition at line 93 of file otbSOMClassifier.h.

Member Function Documentation

template<class TSample , class TSOMMap , class TLabel >
virtual::itk::LightObject::Pointer otb::SOMClassifier< TSample, TSOMMap, TLabel >::CreateAnother ( void  ) const
virtual

Standard macros

Reimplemented from itk::Object.

template<class TSample , class TSOMMap , class TLabel >
void otb::SOMClassifier< TSample, TSOMMap, TLabel >::GenerateData ( void  )
overrideprotectedvirtual

Starts the classification process

Main computation class.

Reimplemented from itk::ProcessObject.

Definition at line 95 of file otbSOMClassifier.hxx.

References itk::Statistics::MembershipSample< class >::ConstIterator::GetInstanceIdentifier(), itk::Size< VDimension >::GetSize(), and otbMsgDebugMacro.

template<class TSample , class TSOMMap , class TLabel >
SOMClassifier< TSample, TSOMMap, TLabel >::SOMMapType * otb::SOMClassifier< TSample, TSOMMap, TLabel >::GetMap ( void  )

SOMMap getter.

Definition at line 62 of file otbSOMClassifier.hxx.

References itk::ProcessObject::GetInput().

template<class TSample , class TSOMMap , class TLabel >
virtual const char* otb::SOMClassifier< TSample, TSOMMap, TLabel >::GetNameOfClass ( ) const
virtual

Standard macros

Reimplemented from itk::ProcessObject.

template<class TSample , class TSOMMap , class TLabel >
SOMClassifier< TSample, TSOMMap, TLabel >::OutputType * otb::SOMClassifier< TSample, TSOMMap, TLabel >::GetOutput ( void  )

Accessors.

SOMMap Setter.

Definition at line 50 of file otbSOMClassifier.hxx.

References itk::ProcessObject::GetOutput().

template<class TSample , class TSOMMap , class TLabel >
otb::SOMClassifier< TSample, TSOMMap, TLabel >::itkGetObjectMacro ( Sample  ,
SampleType   
)
template<class TSample , class TSOMMap , class TLabel >
static Pointer otb::SOMClassifier< TSample, TSOMMap, TLabel >::New ( )
static

Standard macros

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

PrintSelf method

Reimplemented from itk::ProcessObject.

Definition at line 84 of file otbSOMClassifier.hxx.

template<class TSample , class TSOMMap , class TLabel >
void otb::SOMClassifier< TSample, TSOMMap, TLabel >::SetMap ( SOMMapType sommap)

Accessors.

SOMMap Setter.

Definition at line 73 of file otbSOMClassifier.hxx.

References itk::ProcessObject::SetNthInput().

template<class TSample , class TSOMMap , class TLabel >
virtual void otb::SOMClassifier< TSample, TSOMMap, TLabel >::SetSample ( SampleType _arg)
virtual

Member Data Documentation

template<class TSample , class TSOMMap , class TLabel >
SamplePointerType otb::SOMClassifier< TSample, TSOMMap, TLabel >::m_Sample
private

The input sample.

Definition at line 103 of file otbSOMClassifier.h.


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