Input parameters. More...

#include <GeometricRefining.h>

Inheritance diagram for te::rp::GeometricRefining::InputParameters:

Public Member Functions
AbstractParameters *	clone () const
	Create a clone copy of this instance. More...

	InputParameters ()

	InputParameters (const InputParameters &)

const InputParameters &	operator= (const InputParameters &params)

void	reset () throw ( te::rp::Exception )
	Clear all internal allocated resources and reset the parameters instance to its initial state. More...

	~InputParameters ()

Public Attributes
bool	m_enableMultiThread
	Enable/Disable the use of threads (default:true). More...

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

bool	m_enableRasterCache
	If true, a internal raster data cache will be used (defaul:true). More...

double	m_geomTransfMaxTiePointError
	The maximum allowed tie-point error (pixels unit, 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...

std::vector< unsigned int >	m_inRasterBands2Process
	Bands to process from the input raster. More...

int	m_inRasterExpectedColDisplacement
	The expected input raster row displacement (pixel units, default:0) More...

unsigned int	m_inRasterExpectedColError
	The expected column position error for the given input raster (pixels units), default value:10. More...

int	m_inRasterExpectedRowDisplacement
	The expected input raster row displacement (pixel units, default:0) More...

unsigned int	m_inRasterExpectedRowError
	The expected row position error for the given input raster (pixels units), default value:10. More...

te::rst::Raster const *	m_inRasterPtr
	Input raster pointer. More...

unsigned int	m_inRasterSubSectorsFactor
	A positive factor used to devide the input raster area into sectors ,(efault value: 3 ( 3 x 3 = 9 sub-sectors). More...

std::vector< unsigned int >	m_inRasterTPLocationBands
	Input raster bands used for tie-points location. More...

te::rst::Interpolator::Method	m_interpMethod
	The raster interpolator method (default:NearestNeighbor). More...

te::rp::TiePointsLocator::InputParameters	m_locatorParams
	The parameters used by the tie-points locator when matching each raster (feeder) against the input raster (m_RasterPtr),leave untouched to use the default values. More...

double	m_minInRasterCoveredAreaPercent
	The mininumum required area percent (from the input raster ) covered by tie-points - valid range [0,100] (default:25). More...

double	m_minrReferenceRasterCoveredAreaPercent
	The mininumum required area percent (from each reference raster ) covered by tie-points - valid range [0,100] (default:50). More...

double	m_minrReferenceRasterRequiredTiePointsFactor
	The mininumum required tie-points factor over the minimum number of tie-points required by the choosen transformation model (from each reference raster ) covered by tie-points - valid range: positive numbers (default:1.5). More...

double	m_outliersRemotionAssurance
	The error-free selection assurance - valid range (0-1) - Use Lower values for good tie-points sets - Higher values may increase the number of iterations. Use 0-zero to let this number be automatically found (default:0.75). More...

unsigned int	m_outliersRemotionMaxIterations
	The maximum number of iterations (Use 0-zero to let this number be automatically found, default:0). More...

double	m_outputNoDataValue
	The pixel value used where no output raster data is avaliable (defaul:0). More...

bool	m_processAllReferenceRasters
	If true, all reference rasters will be processed, if false the matching can finish when minimum quality criterias are achieved (default:true). More...

FeederConstRaster *	m_referenceRastersPtr
	A feeder of reference rasters. More...

std::vector< double >	m_referenceRastersWeights
	A vector of weights for each reference raster, or an empty vector if all reference rasters have the same weight. More...

std::vector< std::vector < unsigned int > >	m_referenceTPLocationBands
	Reference rasters bands used for tie-points location. More...

Detailed Description

Input parameters.

Definition at line 58 of file GeometricRefining.h.

Constructor & Destructor Documentation

te::rp::GeometricRefining::InputParameters::InputParameters ( )

Definition at line 49 of file GeometricRefining.cpp.

References reset().

te::rp::GeometricRefining::InputParameters::InputParameters ( const InputParameters & other )

Definition at line 54 of file GeometricRefining.cpp.

References te::rp::Algorithm::operator=(), and te::rp::GeometricRefining::reset().

te::rp::GeometricRefining::InputParameters::~InputParameters ( )

Definition at line 60 of file GeometricRefining.cpp.

References te::rp::GeometricRefining::reset().

Member Function Documentation

te::common::AbstractParameters * te::rp::GeometricRefining::InputParameters::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.

Definition at line 128 of file GeometricRefining.cpp.

const GeometricRefining::InputParameters & te::rp::GeometricRefining::InputParameters::operator= ( const InputParameters & params )

void te::rp::GeometricRefining::InputParameters::reset	(		)
throw	(	te::rp::Exception
	)

virtual

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

Implements te::common::AbstractParameters.

Definition at line 65 of file GeometricRefining.cpp.

References te::rst::Interpolator::NearestNeighbor.

Referenced by InputParameters(), and te::rp::GeometricRefining::reset().

Member Data Documentation

bool te::rp::GeometricRefining::InputParameters::m_enableMultiThread

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

Definition at line 74 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), te::rp::GeometricRefining::getTransformation(), and operator=().

bool te::rp::GeometricRefining::InputParameters::m_enableProgress

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

Definition at line 76 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), and operator=().

bool te::rp::GeometricRefining::InputParameters::m_enableRasterCache

If true, a internal raster data cache will be used (defaul:true).

Definition at line 100 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), and operator=().

double te::rp::GeometricRefining::InputParameters::m_geomTransfMaxTiePointError

The maximum allowed tie-point error (pixels unit, default: 2);.

Definition at line 104 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), te::rp::GeometricRefining::getTransformation(), and operator=().

std::string te::rp::GeometricRefining::InputParameters::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 102 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::convert(), te::rp::GeometricRefining::execute(), te::rp::GeometricRefining::getTransformation(), and operator=().

std::vector< unsigned int > te::rp::GeometricRefining::InputParameters::m_inRasterBands2Process

Bands to process from the input raster.

Definition at line 64 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), te::rp::GeometricRefining::initialize(), and operator=().

int te::rp::GeometricRefining::InputParameters::m_inRasterExpectedColDisplacement

The expected input raster row displacement (pixel units, default:0)

Definition at line 96 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), and operator=().

unsigned int te::rp::GeometricRefining::InputParameters::m_inRasterExpectedColError

The expected column position error for the given input raster (pixels units), default value:10.

Definition at line 92 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), te::rp::GeometricRefining::initialize(), and operator=().

int te::rp::GeometricRefining::InputParameters::m_inRasterExpectedRowDisplacement

The expected input raster row displacement (pixel units, default:0)

Definition at line 94 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), and operator=().

unsigned int te::rp::GeometricRefining::InputParameters::m_inRasterExpectedRowError

The expected row position error for the given input raster (pixels units), default value:10.

Definition at line 90 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), te::rp::GeometricRefining::initialize(), and operator=().

te::rst::Raster const* te::rp::GeometricRefining::InputParameters::m_inRasterPtr

Input raster pointer.

Definition at line 62 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), te::rp::GeometricRefining::getTransformation(), te::rp::GeometricRefining::initialize(), and operator=().

unsigned int te::rp::GeometricRefining::InputParameters::m_inRasterSubSectorsFactor

A positive factor used to devide the input raster area into sectors ,(efault value: 3 ( 3 x 3 = 9 sub-sectors).

Definition at line 88 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), te::rp::GeometricRefining::initialize(), and operator=().

std::vector< unsigned int > te::rp::GeometricRefining::InputParameters::m_inRasterTPLocationBands

Input raster bands used for tie-points location.

Definition at line 66 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), te::rp::GeometricRefining::initialize(), and operator=().

te::rst::Interpolator::Method te::rp::GeometricRefining::InputParameters::m_interpMethod

The raster interpolator method (default:NearestNeighbor).

Definition at line 78 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), and operator=().

te::rp::TiePointsLocator::InputParameters te::rp::GeometricRefining::InputParameters::m_locatorParams

The parameters used by the tie-points locator when matching each raster (feeder) against the input raster (m_RasterPtr),leave untouched to use the default values.

Definition at line 80 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), and operator=().

double te::rp::GeometricRefining::InputParameters::m_minInRasterCoveredAreaPercent

The mininumum required area percent (from the input raster ) covered by tie-points - valid range [0,100] (default:25).

Definition at line 82 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::getTransformation(), te::rp::GeometricRefining::initialize(), and operator=().

double te::rp::GeometricRefining::InputParameters::m_minrReferenceRasterCoveredAreaPercent

The mininumum required area percent (from each reference raster ) covered by tie-points - valid range [0,100] (default:50).

Definition at line 84 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), te::rp::GeometricRefining::initialize(), and operator=().

double te::rp::GeometricRefining::InputParameters::m_minrReferenceRasterRequiredTiePointsFactor

The mininumum required tie-points factor over the minimum number of tie-points required by the choosen transformation model (from each reference raster ) covered by tie-points - valid range: positive numbers (default:1.5).

Definition at line 86 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::convert(), te::rp::GeometricRefining::execute(), te::rp::GeometricRefining::initialize(), and operator=().

double te::rp::GeometricRefining::InputParameters::m_outliersRemotionAssurance

The error-free selection assurance - valid range (0-1) - Use Lower values for good tie-points sets - Higher values may increase the number of iterations. Use 0-zero to let this number be automatically found (default:0.75).

Definition at line 106 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), te::rp::GeometricRefining::getTransformation(), and operator=().

unsigned int te::rp::GeometricRefining::InputParameters::m_outliersRemotionMaxIterations

The maximum number of iterations (Use 0-zero to let this number be automatically found, default:0).

Definition at line 108 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::getTransformation(), and operator=().

double te::rp::GeometricRefining::InputParameters::m_outputNoDataValue

The pixel value used where no output raster data is avaliable (defaul:0).

Definition at line 110 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), and operator=().

bool te::rp::GeometricRefining::InputParameters::m_processAllReferenceRasters

If true, all reference rasters will be processed, if false the matching can finish when minimum quality criterias are achieved (default:true).

Definition at line 98 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), and operator=().

FeederConstRaster* te::rp::GeometricRefining::InputParameters::m_referenceRastersPtr

A feeder of reference rasters.

Definition at line 68 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), te::rp::GeometricRefining::initialize(), and operator=().

std::vector< double > te::rp::GeometricRefining::InputParameters::m_referenceRastersWeights

A vector of weights for each reference raster, or an empty vector if all reference rasters have the same weight.

Definition at line 70 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::convert(), te::rp::GeometricRefining::execute(), te::rp::GeometricRefining::initialize(), and operator=().

std::vector< std::vector< unsigned int > > te::rp::GeometricRefining::InputParameters::m_referenceTPLocationBands

Reference rasters bands used for tie-points location.

Definition at line 72 of file GeometricRefining.h.

Referenced by te::rp::GeometricRefining::execute(), and operator=().

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

C:/BB_TL5/terralib5/src/terralib/rp/GeometricRefining.h
C:/BB_TL5/terralib5/src/terralib/rp/GeometricRefining.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation