Public Member Functions | Public Attributes | Protected Attributes | List of all members
te::rp::TiePointsLocatorInputParameters Class Reference

TiePointsLocator input parameters. More...

#include <TiePointsLocatorInputParameters.h>

Inheritance diagram for te::rp::TiePointsLocatorInputParameters:
te::rp::AlgorithmInputParameters te::common::AbstractParameters

Public Member Functions

AbstractParameters * clone () const
 Create a clone copy of this instance. More...
 
TiePointsLocatorStrategyParameters * getSpecStrategyParams ()
 Returns a pointer to the internal specific tie-points locator strategy parameters. More...
 
TiePointsLocatorStrategyParameters const * getSpecStrategyParams () const
 Returns a pointer to the internal specific tie-points locator strategy parameters. More...
 
const TiePointsLocatorInputParameters & operator= (const TiePointsLocatorInputParameters &params)
 
void reset ()
 Clear all internal allocated resources and reset the parameters instance to its initial state. More...
 
bool serialize (AlgorithmParametersSerializer &serializer) const
 Returns a parameter serialization object. More...
 
void setSpecStrategyParams (const TiePointsLocatorStrategyParameters &specStratParams)
 Set specific tie-points locator strategy parameters. More...
 
 TiePointsLocatorInputParameters ()
 
 TiePointsLocatorInputParameters (const TiePointsLocatorInputParameters &)
 
 ~TiePointsLocatorInputParameters ()
 

Public Attributes

bool m_enableGeometryFilter
 Enable/disable the geometry filter/outliers remotion (default:true). More...
 
bool m_enableMultiThread
 Enable/Disable the use of multi-threads (default:true). More...
 
bool m_enableProgress
 Enable/Disable the progress interface (default:false). More...
 
double m_geomTransfMaxError
 The maximum allowed transformation error (pixel units, default:2). More...
 
std::string m_geomTransfName
 The name of the geometric transformation used to ensure tie-points consistency (see each te::gm::GTFactory inherited classes to find each factory key/name, default:Affine). More...
 
te::rst::Raster const * m_inMaskRaster1Ptr
 Optional one band input mask raster 1 (tie-points will not be generated inside mask image areas marked with zeroes). More...
 
te::rst::Raster const * m_inMaskRaster2Ptr
 Optional one band input mask raster 2 (tie-points will not be generated inside mask image areas marked with zeroes). More...
 
std::vector< unsigned int > m_inRaster1Bands
 Bands to be used from the input raster 1. More...
 
te::rst::Raster const * m_inRaster1Ptr
 Input raster 1. More...
 
std::vector< unsigned int > m_inRaster2Bands
 Bands to be used from the input raster 2. More...
 
te::rst::Raster const * m_inRaster2Ptr
 Input raster 2. More...
 
std::string m_interesPointsLocationStrategyName
 The strategy used to locate interest points (default:Moravec). More...
 
te::rst::Interpolator::Method m_interpMethod
 The raster interpolator method (default:NearestNeighbor). More...
 
unsigned int m_maxTiePoints
 The maximum number of tie-points to generate (0:Automatically calculated, default:2500). More...
 
double m_pixelSizeXRelation
 The pixel resolution relation m_pixelSizeXRelation = raster1_pixel_res_x / raster2_pixel_res_x (default=1.0). More...
 
double m_pixelSizeYRelation
 The pixel resolution relation m_pixelSizeYRelation = raster1_pixel_res_y / raster2_pixel_res_y (default=1.0). More...
 
unsigned int m_raster1TargetAreaColStart
 The first column of the raster 2 target area to process (default:0 - The entire raster will be considered). More...
 
unsigned int m_raster1TargetAreaHeight
 The raster 1 target area height (default:0 - The entire raster will be considered). More...
 
unsigned int m_raster1TargetAreaLineStart
 The first line of the raster 1 target area to process (default:0 - The entire raster will be considered). More...
 
unsigned int m_raster1TargetAreaWidth
 The raster 1 target area width (default:0 - The entire raster will be considered). More...
 
unsigned int m_raster2TargetAreaColStart
 The first column of the raster 2 target area to process (default:0 - The entire raster will be considered). More...
 
unsigned int m_raster2TargetAreaHeight
 The raster 2 target area height (default:0 - The entire raster will be considered). More...
 
unsigned int m_raster2TargetAreaLineStart
 The first line of the raster 2 target area to process (default:0 - The entire raster will be considered). More...
 
unsigned int m_raster2TargetAreaWidth
 The raster 2 target area width (default:0 - The entire raster will be considered). More...
 
double m_subSampleOptimizationMinTPAreaCoverage
 Sub-sampled optimization - mininumum required tie-points covered area percent of each raster area - valid range [0,100] (default:25). More...
 
double m_subSampleOptimizationRescaleFactor
 Sub-sampled optimization tie-points search rescale factor (Tie-ponts will be searched into a subsabmpled image and refined before using the original image - Defaul: 1 - subsample optimization disabled, valid range: non-zero positive values). More...
 
unsigned int m_tiePointsSubSectorsSplitFactor
 The algorithm will try to generate tie-points distributed over image sectors ( Default: 3 - 3x3 sub-sectors, minimum: 1). More...
 

Protected Attributes

std::unique_ptr< TiePointsLocatorStrategyParameters > m_specStratParamsPtr
 A pointer to the internal specific segmenter strategy parameters or NULL if no parameters are present. More...
 

Detailed Description

TiePointsLocator input parameters.

Definition at line 48 of file TiePointsLocatorInputParameters.h.

Constructor & Destructor Documentation

◆ TiePointsLocatorInputParameters() [1/2]

te::rp::TiePointsLocatorInputParameters::TiePointsLocatorInputParameters ( )

◆ TiePointsLocatorInputParameters() [2/2]

te::rp::TiePointsLocatorInputParameters::TiePointsLocatorInputParameters ( const TiePointsLocatorInputParameters &  )

◆ ~TiePointsLocatorInputParameters()

te::rp::TiePointsLocatorInputParameters::~TiePointsLocatorInputParameters ( )

Member Function Documentation

◆ clone()

AbstractParameters* te::rp::TiePointsLocatorInputParameters::clone ( ) const
virtual

Create a clone copy of this instance.

Returns
A clone copy of this instance.
Note
The caller will take the ownership of the returned pointer.

Implements te::common::AbstractParameters.

◆ getSpecStrategyParams() [1/2]

TiePointsLocatorStrategyParameters* te::rp::TiePointsLocatorInputParameters::getSpecStrategyParams ( )

Returns a pointer to the internal specific tie-points locator strategy parameters.

Returns
A pointer to the internal specific tie-points locator strategy parameters, or null if no parameters are present.

◆ getSpecStrategyParams() [2/2]

TiePointsLocatorStrategyParameters const* te::rp::TiePointsLocatorInputParameters::getSpecStrategyParams ( ) const

Returns a pointer to the internal specific tie-points locator strategy parameters.

Returns
A pointer to the internal specific tie-points locator strategy parameters, or null if no parameters are present.

◆ operator=()

const TiePointsLocatorInputParameters& te::rp::TiePointsLocatorInputParameters::operator= ( const TiePointsLocatorInputParameters &  params)

◆ reset()

void te::rp::TiePointsLocatorInputParameters::reset ( )
virtual

Clear all internal allocated resources and reset the parameters instance to its initial state.

Implements te::common::AbstractParameters.

◆ serialize()

bool te::rp::TiePointsLocatorInputParameters::serialize ( AlgorithmParametersSerializer &  serializer) const
virtual

Returns a parameter serialization object.

Parameters
serializerThe output serialization object.
Returns
Returns true if ok, false on erros.

Reimplemented from te::rp::AlgorithmInputParameters.

◆ setSpecStrategyParams()

void te::rp::TiePointsLocatorInputParameters::setSpecStrategyParams ( const TiePointsLocatorStrategyParameters &  specStratParams)

Set specific tie-points locator strategy parameters.

Parameters
specStratParamsThe specific tie-points locator strategy parameters.

Member Data Documentation

◆ m_enableGeometryFilter

bool te::rp::TiePointsLocatorInputParameters::m_enableGeometryFilter

Enable/disable the geometry filter/outliers remotion (default:true).

Definition at line 96 of file TiePointsLocatorInputParameters.h.

◆ m_enableMultiThread

bool te::rp::TiePointsLocatorInputParameters::m_enableMultiThread

Enable/Disable the use of multi-threads (default:true).

Definition at line 82 of file TiePointsLocatorInputParameters.h.

◆ m_enableProgress

bool te::rp::TiePointsLocatorInputParameters::m_enableProgress

Enable/Disable the progress interface (default:false).

Definition at line 84 of file TiePointsLocatorInputParameters.h.

◆ m_geomTransfMaxError

double te::rp::TiePointsLocatorInputParameters::m_geomTransfMaxError

The maximum allowed transformation error (pixel units, default:2).

Definition at line 94 of file TiePointsLocatorInputParameters.h.

◆ m_geomTransfName

std::string te::rp::TiePointsLocatorInputParameters::m_geomTransfName

The name of the geometric transformation used to ensure tie-points consistency (see each te::gm::GTFactory inherited classes to find each factory key/name, default:Affine).

Definition at line 92 of file TiePointsLocatorInputParameters.h.

◆ m_inMaskRaster1Ptr

te::rst::Raster const* te::rp::TiePointsLocatorInputParameters::m_inMaskRaster1Ptr

Optional one band input mask raster 1 (tie-points will not be generated inside mask image areas marked with zeroes).

Definition at line 56 of file TiePointsLocatorInputParameters.h.

◆ m_inMaskRaster2Ptr

te::rst::Raster const* te::rp::TiePointsLocatorInputParameters::m_inMaskRaster2Ptr

Optional one band input mask raster 2 (tie-points will not be generated inside mask image areas marked with zeroes).

Definition at line 70 of file TiePointsLocatorInputParameters.h.

◆ m_inRaster1Bands

std::vector< unsigned int > te::rp::TiePointsLocatorInputParameters::m_inRaster1Bands

Bands to be used from the input raster 1.

Definition at line 58 of file TiePointsLocatorInputParameters.h.

◆ m_inRaster1Ptr

te::rst::Raster const* te::rp::TiePointsLocatorInputParameters::m_inRaster1Ptr

Input raster 1.

Definition at line 54 of file TiePointsLocatorInputParameters.h.

◆ m_inRaster2Bands

std::vector< unsigned int > te::rp::TiePointsLocatorInputParameters::m_inRaster2Bands

Bands to be used from the input raster 2.

Definition at line 72 of file TiePointsLocatorInputParameters.h.

◆ m_inRaster2Ptr

te::rst::Raster const* te::rp::TiePointsLocatorInputParameters::m_inRaster2Ptr

Input raster 2.

Definition at line 68 of file TiePointsLocatorInputParameters.h.

◆ m_interesPointsLocationStrategyName

std::string te::rp::TiePointsLocatorInputParameters::m_interesPointsLocationStrategyName

The strategy used to locate interest points (default:Moravec).

Definition at line 52 of file TiePointsLocatorInputParameters.h.

◆ m_interpMethod

te::rst::Interpolator::Method te::rp::TiePointsLocatorInputParameters::m_interpMethod

The raster interpolator method (default:NearestNeighbor).

Definition at line 102 of file TiePointsLocatorInputParameters.h.

◆ m_maxTiePoints

unsigned int te::rp::TiePointsLocatorInputParameters::m_maxTiePoints

The maximum number of tie-points to generate (0:Automatically calculated, default:2500).

Definition at line 86 of file TiePointsLocatorInputParameters.h.

◆ m_pixelSizeXRelation

double te::rp::TiePointsLocatorInputParameters::m_pixelSizeXRelation

The pixel resolution relation m_pixelSizeXRelation = raster1_pixel_res_x / raster2_pixel_res_x (default=1.0).

Definition at line 88 of file TiePointsLocatorInputParameters.h.

◆ m_pixelSizeYRelation

double te::rp::TiePointsLocatorInputParameters::m_pixelSizeYRelation

The pixel resolution relation m_pixelSizeYRelation = raster1_pixel_res_y / raster2_pixel_res_y (default=1.0).

Definition at line 90 of file TiePointsLocatorInputParameters.h.

◆ m_raster1TargetAreaColStart

unsigned int te::rp::TiePointsLocatorInputParameters::m_raster1TargetAreaColStart

The first column of the raster 2 target area to process (default:0 - The entire raster will be considered).

Definition at line 62 of file TiePointsLocatorInputParameters.h.

◆ m_raster1TargetAreaHeight

unsigned int te::rp::TiePointsLocatorInputParameters::m_raster1TargetAreaHeight

The raster 1 target area height (default:0 - The entire raster will be considered).

Definition at line 66 of file TiePointsLocatorInputParameters.h.

◆ m_raster1TargetAreaLineStart

unsigned int te::rp::TiePointsLocatorInputParameters::m_raster1TargetAreaLineStart

The first line of the raster 1 target area to process (default:0 - The entire raster will be considered).

Definition at line 60 of file TiePointsLocatorInputParameters.h.

◆ m_raster1TargetAreaWidth

unsigned int te::rp::TiePointsLocatorInputParameters::m_raster1TargetAreaWidth

The raster 1 target area width (default:0 - The entire raster will be considered).

Definition at line 64 of file TiePointsLocatorInputParameters.h.

◆ m_raster2TargetAreaColStart

unsigned int te::rp::TiePointsLocatorInputParameters::m_raster2TargetAreaColStart

The first column of the raster 2 target area to process (default:0 - The entire raster will be considered).

Definition at line 76 of file TiePointsLocatorInputParameters.h.

◆ m_raster2TargetAreaHeight

unsigned int te::rp::TiePointsLocatorInputParameters::m_raster2TargetAreaHeight

The raster 2 target area height (default:0 - The entire raster will be considered).

Definition at line 80 of file TiePointsLocatorInputParameters.h.

◆ m_raster2TargetAreaLineStart

unsigned int te::rp::TiePointsLocatorInputParameters::m_raster2TargetAreaLineStart

The first line of the raster 2 target area to process (default:0 - The entire raster will be considered).

Definition at line 74 of file TiePointsLocatorInputParameters.h.

◆ m_raster2TargetAreaWidth

unsigned int te::rp::TiePointsLocatorInputParameters::m_raster2TargetAreaWidth

The raster 2 target area width (default:0 - The entire raster will be considered).

Definition at line 78 of file TiePointsLocatorInputParameters.h.

◆ m_specStratParamsPtr

std::unique_ptr< TiePointsLocatorStrategyParameters > te::rp::TiePointsLocatorInputParameters::m_specStratParamsPtr
protected

A pointer to the internal specific segmenter strategy parameters or NULL if no parameters are present.

Definition at line 151 of file TiePointsLocatorInputParameters.h.

◆ m_subSampleOptimizationMinTPAreaCoverage

double te::rp::TiePointsLocatorInputParameters::m_subSampleOptimizationMinTPAreaCoverage

Sub-sampled optimization - mininumum required tie-points covered area percent of each raster area - valid range [0,100] (default:25).

Definition at line 100 of file TiePointsLocatorInputParameters.h.

◆ m_subSampleOptimizationRescaleFactor

double te::rp::TiePointsLocatorInputParameters::m_subSampleOptimizationRescaleFactor

Sub-sampled optimization tie-points search rescale factor (Tie-ponts will be searched into a subsabmpled image and refined before using the original image - Defaul: 1 - subsample optimization disabled, valid range: non-zero positive values).

Definition at line 98 of file TiePointsLocatorInputParameters.h.

◆ m_tiePointsSubSectorsSplitFactor

unsigned int te::rp::TiePointsLocatorInputParameters::m_tiePointsSubSectorsSplitFactor

The algorithm will try to generate tie-points distributed over image sectors ( Default: 3 - 3x3 sub-sectors, minimum: 1).

Definition at line 104 of file TiePointsLocatorInputParameters.h.

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