OTB  6.7.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 Self
ConstPointer
 
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
< AttributesValueType
VectorType
 
- Public Types inherited from otb::LabelMapSource< TLabelMap >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
itk::ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef TLabelMap::Pointer OutputLabelMapPointer
 
typedef TLabelMap OutputLabelMapType
 
typedef itk::SmartPointer< SelfPointer
 
typedef LabelMapSource Self
 
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

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)
 
- 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

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
 
- 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 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 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 ()
 
- 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 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

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

Definition at line 74 of file otbSpatialisationFilter.h.

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

Definition at line 64 of file otbSpatialisationFilter.h.

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

Definition at line 70 of file otbSpatialisationFilter.h.

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

Definition at line 73 of file otbSpatialisationFilter.h.

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

Definition at line 72 of file otbSpatialisationFilter.h.

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

Definition at line 78 of file otbSpatialisationFilter.h.

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

Definition at line 69 of file otbSpatialisationFilter.h.

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

Definition at line 68 of file otbSpatialisationFilter.h.

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

Some convenient typedefs.

Definition at line 67 of file otbSpatialisationFilter.h.

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

Definition at line 63 of file otbSpatialisationFilter.h.

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

Definition at line 71 of file otbSpatialisationFilter.h.

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

Standard "Self" & Superclass typedef.

Definition at line 61 of file otbSpatialisationFilter.h.

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

Definition at line 76 of file otbSpatialisationFilter.h.

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

Definition at line 62 of file otbSpatialisationFilter.h.

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

Definition at line 77 of file otbSpatialisationFilter.h.

Constructor & Destructor Documentation

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

Definition at line 33 of file otbSpatialisationFilter.hxx.

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

Definition at line 117 of file otbSpatialisationFilter.h.

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

Member Function Documentation

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

Standard Macro

Reimplemented from itk::Object.

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

Reimplemented from itk::ProcessObject.

Definition at line 42 of file otbSpatialisationFilter.hxx.

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

Standard Macro

Reimplemented from otb::LabelMapSource< TLabelMap >.

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

Set input vector data

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

Standard Macro

template<class TLabelMap >
void otb::SpatialisationFilter< TLabelMap >::operator= ( const Self )
privatedelete
template<class TLabelMap >
void otb::SpatialisationFilter< TLabelMap >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

Reimplemented from itk::ProcessObject.

Definition at line 119 of file otbSpatialisationFilter.hxx.

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

Definition at line 69 of file otbSpatialisationFilter.hxx.

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

Definition at line 104 of file otbSpatialisationFilter.h.

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

Definition at line 109 of file otbSpatialisationFilter.h.

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

Set input vector data

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

Definition at line 99 of file otbSpatialisationFilter.h.

Member Data Documentation

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

Vector containing the spectral type of each object.

Definition at line 140 of file otbSpatialisationFilter.h.

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 143 of file otbSpatialisationFilter.h.

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 132 of file otbSpatialisationFilter.h.

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 129 of file otbSpatialisationFilter.h.

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 137 of file otbSpatialisationFilter.h.


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