OTB  9.0.0
Orfeo Toolbox
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 SelfConstPointer
 
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 SelfConstPointer
 
typedef itk::ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType
 
typedef GeometriesSet OutputGeometriesType
 

Public Member Functions

Standard ITK macros
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from otb::GeometriesSource
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual OutputGeometriesTypeGetOutput (void)
 
virtual OutputGeometriesTypeGetOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetOutput (OutputGeometriesType *output, DataObjectPointerArraySizeType idx=0)
 
void PrepareOutputs () override
 

Single input GeometriesSet property

virtual void SetInput (const InputGeometriesType *input)
 
const InputGeometriesTypeGetInput (void)
 
 GeometriesToGeometriesFilter ()
 
 ~GeometriesToGeometriesFilter () override
 
void GenerateData (void) override
 
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.

struct otb::internal::ProcessVisitor
 
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 ()
 

Additional Inherited Members

- Static Public Member Functions inherited from otb::GeometriesSource
static Pointer New ()
 
- Protected Member Functions inherited from otb::GeometriesSource
 GeometriesSource ()
 
 ~GeometriesSource () override
 
virtual void DoAllocateOutputs ()
 

Detailed Description

Root abstract class for all geometry to geometry filters.

Since
OTB v 3.14.0

Definition at line 58 of file otbGeometriesToGeometriesFilter.h.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer<const Self> otb::GeometriesToGeometriesFilter::ConstPointer

Definition at line 67 of file otbGeometriesToGeometriesFilter.h.

◆ InputGeometriesType

Definition at line 72 of file otbGeometriesToGeometriesFilter.h.

◆ OutputGeometriesType

Definition at line 73 of file otbGeometriesToGeometriesFilter.h.

◆ Pointer

Definition at line 66 of file otbGeometriesToGeometriesFilter.h.

◆ Self

Definition at line 64 of file otbGeometriesToGeometriesFilter.h.

◆ Superclass

Definition at line 65 of file otbGeometriesToGeometriesFilter.h.

Constructor & Destructor Documentation

◆ GeometriesToGeometriesFilter()

otb::GeometriesToGeometriesFilter::GeometriesToGeometriesFilter ( )
protected

Default constructor. Does nothing.

◆ ~GeometriesToGeometriesFilter()

otb::GeometriesToGeometriesFilter::~GeometriesToGeometriesFilter ( )
overrideprotected

Destructor. Does nothing.

Member Function Documentation

◆ DoDefineNewLayerFields()

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.

◆ DoDefineNewLayerGeometryType()

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.

◆ DoDefineNewLayerOptions()

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.

◆ DoDefineNewLayerSpatialReference()

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.

◆ DoFinalizeInitialization()

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 181 of file otbGeometriesToGeometriesFilter.h.

◆ DoProcessLayer()

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.

◆ GenerateData()

void otb::GeometriesToGeometriesFilter::GenerateData ( void  )
overrideprotected

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.

◆ GetInput()

const InputGeometriesType* otb::GeometriesToGeometriesFilter::GetInput ( void  )

Default constructor. Does nothing.

◆ GetNameOfClass()

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.

◆ Process() [1/2]

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.

◆ Process() [2/2]

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

◆ SetInput()

virtual void otb::GeometriesToGeometriesFilter::SetInput ( const InputGeometriesType input)
virtual

Default constructor. Does nothing.

Friends And Related Function Documentation

◆ otb::internal::ProcessVisitor

friend struct otb::internal::ProcessVisitor
friend

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.

Definition at line 186 of file otbGeometriesToGeometriesFilter.h.


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