TerraLib 4.1
TePDIRegister Class Reference

This is the class for digital image registering. More...

#include <TePDIRegister.hpp>

Inheritance diagram for TePDIRegister:
TePDIAlgorithm

List of all members.

Public Member Functions

 TePDIRegister ()
 Default Constructor.
 ~TePDIRegister ()
 Default Destructor.
bool CheckParameters (const TePDIParameters &parameters) const
 Checks if the supplied parameters fits the requirements of each PDI algorithm implementation.

Protected Member Functions

void ResetState (const TePDIParameters &params)
 Reset the internal state to the initial state.
bool RunImplementation ()
 Runs the current algorithm implementation.

Detailed Description

This is the class for digital image registering.

Author:
Emiliano F. Castejon <castejon@dpi.inpe.br>
Note:
The general required parameters:
Parameters:
proj_params( TePDITypes::TeProjParamsPtrType ) - The output projection parameters.
res_x( double ) - X Axis output resolution.
res_y( double ) - Y Axis output resolution.
adjust_raster( TePDITypes::TePDIRasterPtrType ) - The input raster that needs to be registered.
output_raster( TePDITypes::TePDIRasterPtrType ) - The output raster.
interpolator( TePDIInterpolator::InterpMethod ) - Interpolator method to use when rendering output_raster ( For rasters with internal palletes only TePDIInterpolator::NNMethod can be used ).
adjust_channels(std::vector<int>) - Band(s) to process from adjust_raster.
Note:
The optional parameters are:
Parameters:
dummy_value(double) - A dummy pixel value for use in pixels where no data is available.
tie_points( TePDITypes::TeCoordPairVectPtrType ) - The input tie-points where TeCoordPair.pt1 are adjust_rater matricial indexes (They must be inside the respective raster to be valid) and TeCoordPair.pt2 are the respective projected coordinates (this parameter is not necessary if the parameter "transf_params" is given).
gt_name( std::string ) - Geometric transformation name ( see TeGTFactory documentation for reference; this parameter is not necessary if the parameter "transf_params" is given ).
transf_params( TeGTParams ) - The geometric transformation parameters (if this parameter is given, the "tie_points" and "gt_name" parameters will be ignored).
Examples:

TePDIRegister_test.cpp.


Constructor & Destructor Documentation

TePDIRegister::TePDIRegister ( )

Default Constructor.

TePDIRegister::~TePDIRegister ( )

Default Destructor.


Member Function Documentation

bool TePDIRegister::CheckParameters ( const TePDIParameters parameters) const [virtual]

Checks if the supplied parameters fits the requirements of each PDI algorithm implementation.

Note:
Error log messages must be generated. No exceptions generated.
Parameters:
parametersThe parameters to be checked.
Returns:
true if the parameters are OK. false if not.

Implements TePDIAlgorithm.

void TePDIRegister::ResetState ( const TePDIParameters params) [protected, virtual]

Reset the internal state to the initial state.

Parameters:
paramsThe new parameters referente at initial state.

Implements TePDIAlgorithm.

bool TePDIRegister::RunImplementation ( ) [protected, virtual]

Runs the current algorithm implementation.

Returns:
true if OK. false on error.

Implements TePDIAlgorithm.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines