OTB  7.2.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::SpatialisationFilter< TLabelMap > Class Template Reference

#include <otbSpatialisationFilter.h>

+ Inheritance diagram for otb::SpatialisationFilter< TLabelMap >:
+ Collaboration diagram for otb::SpatialisationFilter< TLabelMap >:

Public Types

typedef LabelObjectType::AttributesValueType AttributesValueType
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef OutputLabelMapType::IndexType IndexType
 
typedef OutputLabelMapType::LabelObjectType LabelObjectType
 
typedef OutputLabelMapType::LabelObjectType::LabelType LabelType
 
typedef std::vector< LabelTypeLabelVectorType
 
typedef OutputLabelMapType::ConstPointer OutputLabelMapConstPointer
 
typedef OutputLabelMapType::Pointer OutputLabelMapPointer
 
typedef TLabelMap OutputLabelMapType
 
typedef itk::SmartPointer< SelfPointer
 
typedef OutputLabelMapType::RegionType RegionType
 
typedef SpatialisationFilter Self
 
typedef itk::Size< 2 > SizeType
 
typedef LabelMapSource< TLabelMap > Superclass
 
typedef std::vector< AttributesValueTypeVectorType
 
- Public Types inherited from otb::LabelMapSource< TLabelMap >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType
 
typedef TLabelMap ::Pointer OutputLabelMapPointer
 
typedef TLabelMap OutputLabelMapType
 
typedef itk::SmartPointer< SelfPointer
 
typedef LabelMapSource Self
 
typedef itk::ProcessObject Superclass
 

Public Member Functions

virtual SizeType GetNumberOfObjects ()
 
void SetAreaVector (VectorType &v)
 
void SetLabels (LabelVectorType &v)
 
virtual void SetNumberOfObjects (SizeType _arg)
 
void SetPathVector (VectorType &v)
 
virtual void SetObjectSize (SizeType _arg)
 
virtual SizeType GetObjectSize ()
 
- Public Member Functions inherited from otb::LabelMapSource< TLabelMap >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual OutputLabelMapTypeGetOutput (void)
 
virtual OutputLabelMapTypeGetOutput (DataObjectPointerArraySizeType idx)
 

Protected Member Functions

void GenerateData () override
 
void GenerateOutputInformation () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
virtual void ProcessObject (unsigned int obj)
 
 SpatialisationFilter ()
 
 ~SpatialisationFilter () override
 
- Protected Member Functions inherited from otb::LabelMapSource< TLabelMap >
virtual void AllocateOutputs ()
 
 LabelMapSource ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~LabelMapSource () override
 

Private Member Functions

void operator= (const Self &)=delete
 
 SpatialisationFilter (const Self &)=delete
 

Private Attributes

VectorType m_AreaVector
 
LabelVectorType m_Labels
 
SizeType m_NumberOfObjects
 
SizeType m_ObjectSize
 
VectorType m_PathVector
 
virtual const char * GetNameOfClass () const
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
static Pointer New ()
 

Additional Inherited Members

- Static Public Member Functions inherited from otb::LabelMapSource< TLabelMap >
static Pointer New ()
 

Detailed Description

template<class TLabelMap>
class otb::SpatialisationFilter< TLabelMap >

Create a label map from objects description.

Objects are described by:

SpatialisationFilter creates a labelMap containing NumberOfObjects[0]*NumberOfObject[1] objects (number of objects by line, number of objects by column). Each object is rectangular of size ObjectSize. Two attributes "path" and "area" are added to each object using SetPathVector and SetAreaVector. The Label of each object is set using SetLabels.

See also
LabelMapSource

Definition at line 53 of file otbSpatialisationFilter.h.

Member Typedef Documentation

◆ AttributesValueType

template<class TLabelMap >
typedef LabelObjectType::AttributesValueType otb::SpatialisationFilter< TLabelMap >::AttributesValueType

Definition at line 73 of file otbSpatialisationFilter.h.

◆ ConstPointer

template<class TLabelMap >
typedef itk::SmartPointer<const Self> otb::SpatialisationFilter< TLabelMap >::ConstPointer

Definition at line 63 of file otbSpatialisationFilter.h.

◆ IndexType

template<class TLabelMap >
typedef OutputLabelMapType::IndexType otb::SpatialisationFilter< TLabelMap >::IndexType

Definition at line 69 of file otbSpatialisationFilter.h.

◆ LabelObjectType

template<class TLabelMap >
typedef OutputLabelMapType::LabelObjectType otb::SpatialisationFilter< TLabelMap >::LabelObjectType

Definition at line 72 of file otbSpatialisationFilter.h.

◆ LabelType

template<class TLabelMap >
typedef OutputLabelMapType::LabelObjectType::LabelType otb::SpatialisationFilter< TLabelMap >::LabelType

Definition at line 71 of file otbSpatialisationFilter.h.

◆ LabelVectorType

template<class TLabelMap >
typedef std::vector<LabelType> otb::SpatialisationFilter< TLabelMap >::LabelVectorType

Definition at line 77 of file otbSpatialisationFilter.h.

◆ OutputLabelMapConstPointer

template<class TLabelMap >
typedef OutputLabelMapType::ConstPointer otb::SpatialisationFilter< TLabelMap >::OutputLabelMapConstPointer

Definition at line 68 of file otbSpatialisationFilter.h.

◆ OutputLabelMapPointer

template<class TLabelMap >
typedef OutputLabelMapType::Pointer otb::SpatialisationFilter< TLabelMap >::OutputLabelMapPointer

Definition at line 67 of file otbSpatialisationFilter.h.

◆ OutputLabelMapType

template<class TLabelMap >
typedef TLabelMap otb::SpatialisationFilter< TLabelMap >::OutputLabelMapType

Some convenient typedefs.

Definition at line 66 of file otbSpatialisationFilter.h.

◆ Pointer

template<class TLabelMap >
typedef itk::SmartPointer<Self> otb::SpatialisationFilter< TLabelMap >::Pointer

Definition at line 62 of file otbSpatialisationFilter.h.

◆ RegionType

template<class TLabelMap >
typedef OutputLabelMapType::RegionType otb::SpatialisationFilter< TLabelMap >::RegionType

Definition at line 70 of file otbSpatialisationFilter.h.

◆ Self

template<class TLabelMap >
typedef SpatialisationFilter otb::SpatialisationFilter< TLabelMap >::Self

Standard "Self" & Superclass typedef.

Definition at line 60 of file otbSpatialisationFilter.h.

◆ SizeType

template<class TLabelMap >
typedef itk::Size<2> otb::SpatialisationFilter< TLabelMap >::SizeType

Definition at line 75 of file otbSpatialisationFilter.h.

◆ Superclass

template<class TLabelMap >
typedef LabelMapSource<TLabelMap> otb::SpatialisationFilter< TLabelMap >::Superclass

Definition at line 61 of file otbSpatialisationFilter.h.

◆ VectorType

template<class TLabelMap >
typedef std::vector<AttributesValueType> otb::SpatialisationFilter< TLabelMap >::VectorType

Definition at line 76 of file otbSpatialisationFilter.h.

Constructor & Destructor Documentation

◆ SpatialisationFilter() [1/2]

template<class TLabelMap >
otb::SpatialisationFilter< TLabelMap >::SpatialisationFilter ( )
protected

Definition at line 32 of file otbSpatialisationFilter.hxx.

◆ ~SpatialisationFilter()

template<class TLabelMap >
otb::SpatialisationFilter< TLabelMap >::~SpatialisationFilter ( )
inlineoverrideprotected

Definition at line 116 of file otbSpatialisationFilter.h.

◆ SpatialisationFilter() [2/2]

template<class TLabelMap >
otb::SpatialisationFilter< TLabelMap >::SpatialisationFilter ( const Self )
privatedelete

Member Function Documentation

◆ CreateAnother()

template<class TLabelMap >
virtual::itk::LightObject::Pointer otb::SpatialisationFilter< TLabelMap >::CreateAnother ( void  ) const

Standard Macro

◆ GenerateData()

template<class TLabelMap >
void otb::SpatialisationFilter< TLabelMap >::GenerateData ( void  )
overrideprotected

Definition at line 39 of file otbSpatialisationFilter.hxx.

◆ GenerateOutputInformation()

template<class TLabelMap >
void otb::SpatialisationFilter< TLabelMap >::GenerateOutputInformation ( void  )
overrideprotected

Definition at line 86 of file otbSpatialisationFilter.hxx.

◆ GetNameOfClass()

template<class TLabelMap >
virtual const char* otb::SpatialisationFilter< TLabelMap >::GetNameOfClass ( ) const
virtual

Standard Macro

Reimplemented from otb::LabelMapSource< TLabelMap >.

◆ GetNumberOfObjects()

template<class TLabelMap >
virtual SizeType otb::SpatialisationFilter< TLabelMap >::GetNumberOfObjects ( )
virtual

◆ GetObjectSize()

template<class TLabelMap >
virtual SizeType otb::SpatialisationFilter< TLabelMap >::GetObjectSize ( )
virtual

Set input vector data

◆ New()

template<class TLabelMap >
static Pointer otb::SpatialisationFilter< TLabelMap >::New ( )
static

Standard Macro

◆ operator=()

template<class TLabelMap >
void otb::SpatialisationFilter< TLabelMap >::operator= ( const Self )
privatedelete

◆ PrintSelf()

template<class TLabelMap >
void otb::SpatialisationFilter< TLabelMap >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Definition at line 111 of file otbSpatialisationFilter.hxx.

◆ ProcessObject()

template<class TLabelMap >
void otb::SpatialisationFilter< TLabelMap >::ProcessObject ( unsigned int  obj)
protectedvirtual

Definition at line 64 of file otbSpatialisationFilter.hxx.

◆ SetAreaVector()

template<class TLabelMap >
void otb::SpatialisationFilter< TLabelMap >::SetAreaVector ( VectorType v)
inline

Definition at line 103 of file otbSpatialisationFilter.h.

◆ SetLabels()

template<class TLabelMap >
void otb::SpatialisationFilter< TLabelMap >::SetLabels ( LabelVectorType v)
inline

Definition at line 108 of file otbSpatialisationFilter.h.

◆ SetNumberOfObjects()

template<class TLabelMap >
virtual void otb::SpatialisationFilter< TLabelMap >::SetNumberOfObjects ( SizeType  _arg)
virtual

◆ SetObjectSize()

template<class TLabelMap >
virtual void otb::SpatialisationFilter< TLabelMap >::SetObjectSize ( SizeType  _arg)
virtual

Set input vector data

◆ SetPathVector()

template<class TLabelMap >
void otb::SpatialisationFilter< TLabelMap >::SetPathVector ( VectorType v)
inline

Definition at line 98 of file otbSpatialisationFilter.h.

Member Data Documentation

◆ m_AreaVector

template<class TLabelMap >
VectorType otb::SpatialisationFilter< TLabelMap >::m_AreaVector
private

Vector containing the spectral type of each object.

Definition at line 141 of file otbSpatialisationFilter.h.

◆ m_Labels

template<class TLabelMap >
LabelVectorType otb::SpatialisationFilter< TLabelMap >::m_Labels
private

Vector containing the label of each object (ex.: 1, 2, 25, etc.).

Definition at line 144 of file otbSpatialisationFilter.h.

◆ m_NumberOfObjects

template<class TLabelMap >
SizeType otb::SpatialisationFilter< TLabelMap >::m_NumberOfObjects
private

Number of objects contained in the image (number of objects by line, number of objects by column).

Definition at line 133 of file otbSpatialisationFilter.h.

◆ m_ObjectSize

template<class TLabelMap >
SizeType otb::SpatialisationFilter< TLabelMap >::m_ObjectSize
private

Common size for all objects in number of pixels (number of rows, number of columns).

Definition at line 130 of file otbSpatialisationFilter.h.

◆ m_PathVector

template<class TLabelMap >
VectorType otb::SpatialisationFilter< TLabelMap >::m_PathVector
private

Vector containing the path for spectra files (if any) for each object. If no path is given (empty path: "") spectrum is simulated from default parameters.

Definition at line 138 of file otbSpatialisationFilter.h.


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