Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel > Class Template Reference

An AttributesMapLabelObject with an optional class label. More...

#include <otbAttributesMapLabelObjectWithClassLabel.h>

+ Inheritance diagram for otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >:
+ Collaboration diagram for otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >:

Public Types

typedef TClassLabel ClassLabelType
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::WeakPointer
< const Self
ConstWeakPointer
 
typedef itk::LabelObject
< TLabel, VImageDimension > 
LabelObjectType
 
typedef itk::SmartPointer< SelfPointer
 
typedef
AttributesMapLabelObjectWithClassLabel 
Self
 
typedef
AttributesMapLabelObject
< TLabel, VImageDimension,
TAttributesValue > 
Superclass
 
- Public Types inherited from otb::AttributesMapLabelObject< TLabel, VImageDimension, TAttributesValue >
typedef
AttributesMapType::const_iterator 
AttributesMapConstIteratorType
 
typedef AttributesMapType::iterator AttributesMapIteratorType
 
typedef std::map< std::string,
AttributesValueType
AttributesMapType
 Map container typedefs. More...
 
typedef TAttributesValue AttributesValueType
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::WeakPointer
< const Self
ConstWeakPointer
 
typedef Superclass::IndexType IndexType
 
typedef itk::LabelMap< SelfLabelMapType
 Type of a label map using an AttributesMapLabelObject. More...
 
typedef Superclass::LabelObjectType LabelObjectType
 
typedef TLabel LabelType
 Template parameters typedef. More...
 
typedef Superclass::LengthType LengthType
 
typedef Superclass::LineType LineType
 
typedef itk::SmartPointer< SelfPointer
 
typedef PolygonType::Pointer PolygonPointerType
 
typedef Polygon< double > PolygonType
 
typedef AttributesMapLabelObject Self
 
typedef itk::LabelObject
< TLabel, VImageDimension > 
Superclass
 

Public Member Functions

virtual void CopyAttributesFrom (const LabelObjectType *lo)
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
const ClassLabelTypeGetClassLabel () const
 
virtual const char * GetNameOfClass () const
 
bool HasClassLabel () const
 
void RemoveClassLabel ()
 
void SetClassLabel (const ClassLabelType &label)
 
- Public Member Functions inherited from otb::AttributesMapLabelObject< TLabel, VImageDimension, TAttributesValue >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
AttributesValueType GetAttribute (const char *name) const
 
std::vector< std::string > GetAvailableAttributes () const
 
unsigned int GetNumberOfAttributes () const
 
const PolygonTypeGetPolygon () const
 
PolygonTypeGetPolygon ()
 
void SetAttribute (const char *name, AttributesValueType value)
 
void SetAttribute (const std::string &name, AttributesValueType value)
 
void SetPolygon (PolygonType *p)
 
- Public Member Functions inherited from itk::LabelObject< TLabel, VImageDimension >
virtual void CopyAttributesFrom (const Self *src)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::AttributesMapLabelObject< TLabel, VImageDimension, TAttributesValue >
static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = VImageDimension
 
- Static Public Attributes inherited from otb::AttributesMapLabelObject< TLabel, VImageDimension, TAttributesValue >
static const unsigned int ImageDimension = VImageDimension
 

Protected Member Functions

 AttributesMapLabelObjectWithClassLabel ()
 
virtual ~AttributesMapLabelObjectWithClassLabel ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
- Protected Member Functions inherited from otb::AttributesMapLabelObject< TLabel, VImageDimension, TAttributesValue >
 AttributesMapLabelObject ()
 
virtual ~AttributesMapLabelObject ()
 

Private Member Functions

 AttributesMapLabelObjectWithClassLabel (const Self &)
 
void operator= (const Self &)
 

Private Attributes

ClassLabelType m_ClassLabel
 
bool m_HasClassLabel
 

Detailed Description

template<class TLabel, unsigned int VImageDimension, class TAttributesValue, class TClassLabel>
class otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >

An AttributesMapLabelObject with an optional class label.

The label type is defined by the template parameter TClassLabel and accessible using the ClassLabelType typedef.

The HasClassLabel() method returns true if the LabelObject has a class label and false otherwise.

The SetClassLabel() method set the class label and set the internal flag m_HasClassLabel to true.

The GetClassLabel() method returns the class label or an exception if m_HasClassLabel is set to false.

The RemoveClassLabel() method set m_HasClassLabel to false and the class label value to a default value.

See Also
LabelObject, ShapeLabelObject, StatisticsLabelObject

Definition at line 49 of file otbAttributesMapLabelObjectWithClassLabel.h.

Member Typedef Documentation

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
typedef TClassLabel otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::ClassLabelType

Class label typedef

Definition at line 70 of file otbAttributesMapLabelObjectWithClassLabel.h.

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
typedef itk::SmartPointer<const Self> otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::ConstPointer

Definition at line 58 of file otbAttributesMapLabelObjectWithClassLabel.h.

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
typedef itk::WeakPointer<const Self> otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::ConstWeakPointer

Definition at line 59 of file otbAttributesMapLabelObjectWithClassLabel.h.

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
typedef itk::LabelObject<TLabel, VImageDimension> otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::LabelObjectType

Definition at line 56 of file otbAttributesMapLabelObjectWithClassLabel.h.

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
typedef itk::SmartPointer<Self> otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::Pointer

Definition at line 57 of file otbAttributesMapLabelObjectWithClassLabel.h.

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
typedef AttributesMapLabelObjectWithClassLabel otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::Self

Standard class typedefs

Definition at line 53 of file otbAttributesMapLabelObjectWithClassLabel.h.

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
typedef AttributesMapLabelObject<TLabel, VImageDimension, TAttributesValue> otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::Superclass

Definition at line 55 of file otbAttributesMapLabelObjectWithClassLabel.h.

Constructor & Destructor Documentation

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::AttributesMapLabelObjectWithClassLabel ( )
inlineprotected

Constructor

Definition at line 120 of file otbAttributesMapLabelObjectWithClassLabel.h.

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
virtual otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::~AttributesMapLabelObjectWithClassLabel ( )
inlineprotectedvirtual

Destructor

Definition at line 123 of file otbAttributesMapLabelObjectWithClassLabel.h.

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::AttributesMapLabelObjectWithClassLabel ( const Self )
private

Member Function Documentation

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
virtual void otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::CopyAttributesFrom ( const LabelObjectType lo)
inlinevirtual

This method is overloaded to add the copy of the attributes map.

Reimplemented from otb::AttributesMapLabelObject< TLabel, VImageDimension, TAttributesValue >.

Definition at line 103 of file otbAttributesMapLabelObjectWithClassLabel.h.

References NULL.

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
virtual::itk::LightObject::Pointer otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::CreateAnother ( void  ) const
template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
const ClassLabelType& otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::GetClassLabel ( ) const
inline

Get the class label. Throws an exception if no class label is available

Definition at line 81 of file otbAttributesMapLabelObjectWithClassLabel.h.

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
virtual const char* otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from otb::AttributesMapLabelObject< TLabel, VImageDimension, TAttributesValue >.

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
bool otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::HasClassLabel ( ) const
inline
Returns
true if a class label is available

Definition at line 91 of file otbAttributesMapLabelObjectWithClassLabel.h.

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
static Pointer otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::New ( )
static

Method for creation through the object factory.

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
void otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::operator= ( const Self )
private
template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
void otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
inlineprotectedvirtual
template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
void otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::RemoveClassLabel ( )
inline

Invalidate the class label if any

Definition at line 97 of file otbAttributesMapLabelObjectWithClassLabel.h.

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
void otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::SetClassLabel ( const ClassLabelType label)
inline

Set the class label

Definition at line 73 of file otbAttributesMapLabelObjectWithClassLabel.h.

Member Data Documentation

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
const unsigned int otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::ImageDimension = VImageDimension
static

Definition at line 67 of file otbAttributesMapLabelObjectWithClassLabel.h.

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
ClassLabelType otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::m_ClassLabel
private

The class label

Definition at line 144 of file otbAttributesMapLabelObjectWithClassLabel.h.

template<class TLabel , unsigned int VImageDimension, class TAttributesValue , class TClassLabel >
bool otb::AttributesMapLabelObjectWithClassLabel< TLabel, VImageDimension, TAttributesValue, TClassLabel >::m_HasClassLabel
private

Does the LabelObject have a class label ?

Definition at line 147 of file otbAttributesMapLabelObjectWithClassLabel.h.


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