OTB  6.7.0
Orfeo Toolbox
Protected Member Functions | Private Member Functions | Friends | List of all members
otb::GeometriesToGeometriesFilter Class Referenceabstract

#include <otbGeometriesToGeometriesFilter.h>

+ Inheritance diagram for otb::GeometriesToGeometriesFilter:
+ Collaboration diagram for otb::GeometriesToGeometriesFilter:

Public Types

Standard ITK typedefs
typedef
GeometriesToGeometriesFilter 
Self
 
typedef itk::ProcessObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
I/O typedefs
typedef GeometriesSet InputGeometriesType
 
typedef GeometriesSet OutputGeometriesType
 
- Public Types inherited from otb::GeometriesSource
typedef GeometriesSource Self
 
typedef itk::ProcessObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
itk::ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef GeometriesSet OutputGeometriesType
 
- 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

Standard ITK macros
virtual const char * GetNameOfClass () const
 
Single input GeometriesSet property
virtual void SetInput (const InputGeometriesType *input)
 
const InputGeometriesTypeGetInput (void)
 
- Public Member Functions inherited from otb::GeometriesSource
void PrepareOutputs () override
 
virtual OutputGeometriesTypeGetOutput (void)
 
virtual OutputGeometriesTypeGetOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetOutput (OutputGeometriesType *output, DataObjectPointerArraySizeType idx=0)
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
- 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 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 (void) override
 
 GeometriesToGeometriesFilter ()
 
 ~GeometriesToGeometriesFilter () override
 
- Protected Member Functions inherited from otb::GeometriesSource
 GeometriesSource ()
 
 ~GeometriesSource () override
 
virtual void DoAllocateOutputs ()
 
- 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 ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 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 Process (OutputGeometriesType &inout)
 
void Process (InputGeometriesType const &source, OutputGeometriesType &destination)
 
Filter specialization hooks.

Filter specialization hooks. These functions are meant to be specialized by the actual filter.

virtual void DoProcessLayer (ogr::Layer const &source, ogr::Layer &destination) const =0
 
virtual OGRSpatialReference * DoDefineNewLayerSpatialReference (ogr::Layer const &source) const
 
virtual OGRwkbGeometryType DoDefineNewLayerGeometryType (ogr::Layer const &source) const
 
virtual std::vector< std::string > DoDefineNewLayerOptions (ogr::Layer const &source) const
 
virtual void DoDefineNewLayerFields (ogr::Layer const &source, ogr::Layer &dest) const =0
 
virtual void DoFinalizeInitialization ()
 

Friends

struct otb::internal::ProcessVisitor
 

Additional Inherited Members

- Static Public Member Functions inherited from otb::GeometriesSource
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

Root abstract class for all geometry to geometry filters.

Since
OTB v 3.14.0

Definition at line 54 of file otbGeometriesToGeometriesFilter.h.

Member Typedef Documentation

Definition at line 63 of file otbGeometriesToGeometriesFilter.h.

Definition at line 68 of file otbGeometriesToGeometriesFilter.h.

Definition at line 69 of file otbGeometriesToGeometriesFilter.h.

Definition at line 62 of file otbGeometriesToGeometriesFilter.h.

Definition at line 60 of file otbGeometriesToGeometriesFilter.h.

Definition at line 61 of file otbGeometriesToGeometriesFilter.h.

Constructor & Destructor Documentation

otb::GeometriesToGeometriesFilter::GeometriesToGeometriesFilter ( )
protected

Default constructor. Does nothing.

otb::GeometriesToGeometriesFilter::~GeometriesToGeometriesFilter ( )
overrideprotected

Destructor. Does nothing.

Member Function Documentation

virtual void otb::GeometriesToGeometriesFilter::DoDefineNewLayerFields ( ogr::Layer const &  source,
ogr::Layer dest 
) const
privatepure virtual

Hook used to define the fields of the new layer.

Parameters
[in]sourcesource Layer – for reference
[in,out]destdestination Layer

Implemented in otb::DefaultGeometriesToGeometriesFilter< TransformationFunctor, FieldTransformationPolicy >, and otb::GeometriesProjectionFilter.

virtual OGRwkbGeometryType otb::GeometriesToGeometriesFilter::DoDefineNewLayerGeometryType ( ogr::Layer const &  source) const
privatevirtual

Hook used to determine the type of the new layer.

Parameters
[in]sourcesource Layer.
Returns
by default the same type as the one from the source Layer.
virtual std::vector<std::string> otb::GeometriesToGeometriesFilter::DoDefineNewLayerOptions ( ogr::Layer const &  source) const
privatevirtual

Hook used to determine the options for creating a new layer.

Parameters
[in]sourcesource Layer for reference (in case it has relevant information).
Returns
nothing by default.
virtual OGRSpatialReference* otb::GeometriesToGeometriesFilter::DoDefineNewLayerSpatialReference ( ogr::Layer const &  source) const
privatevirtual

Hook used to determine the OGRSpatialReference when creating a new layer.

Parameters
[in]sourcesource Layer for reference (in case it has relevant information).
Returns
a new OGRSpatialReference that the client code shall release with the appropriate OGR function.
0 by default.
Todo:
Return a unique_ptr<OGRSpatialReference>.

Reimplemented in otb::GeometriesProjectionFilter.

virtual void otb::GeometriesToGeometriesFilter::DoFinalizeInitialization ( )
inlineprivatevirtual

Hook used to conclude the initialization phase. As ITK doesn't follow a the constructor set the object in a final, and ready to be used, state, this step is required to do that once all filter attributes have been set.

The default implementation does nothing.

Reimplemented in otb::GeometriesProjectionFilter.

Definition at line 177 of file otbGeometriesToGeometriesFilter.h.

virtual void otb::GeometriesToGeometriesFilter::DoProcessLayer ( ogr::Layer const &  source,
ogr::Layer destination 
) const
privatepure virtual

Hook that actually filters an OGR Layer.

Parameters
[in]sourceInput layer
[in,out]destinationOutput layer
Note
When source == destination, it means this is an inplace filter.

Implemented in otb::DefaultGeometriesToGeometriesFilter< TransformationFunctor, FieldTransformationPolicy >, and otb::GeometriesProjectionFilter.

void otb::GeometriesToGeometriesFilter::GenerateData ( void  )
overrideprotectedvirtual

Processes the input to fill the output. This is the main processing function. It either works in-place or by copying the transformed input Feature s into the output.

Reimplemented from itk::ProcessObject.

const InputGeometriesType* otb::GeometriesToGeometriesFilter::GetInput ( void  )
virtual const char* otb::GeometriesToGeometriesFilter::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from otb::GeometriesSource.

Reimplemented in otb::DefaultGeometriesToGeometriesFilter< TransformationFunctor, FieldTransformationPolicy >, and otb::GeometriesProjectionFilter.

void otb::GeometriesToGeometriesFilter::Process ( OutputGeometriesType inout)
private

In-place processing function.

Parameters
[in,out]inoutthe geometries set that'll be modified by the filter.
Precondition
The filter must have been initialized
void otb::GeometriesToGeometriesFilter::Process ( InputGeometriesType const &  source,
OutputGeometriesType destination 
)
private

By-copy processing function.

Parameters
[in]sourcethe geometries set to transform
[out]destinationthe resulting geometries set.
Precondition
The filter must have been initialized
The destination must be ready to receive a result.
virtual void otb::GeometriesToGeometriesFilter::SetInput ( const InputGeometriesType input)
virtual

Friends And Related Function Documentation

friend struct otb::internal::ProcessVisitor
friend

Definition at line 180 of file otbGeometriesToGeometriesFilter.h.


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