te::rp::TiePointsMosaic Class Reference

Create a mosaic from a set of rasters using tie-points. More...

#include <TiePointsMosaic.h>

Inheritance diagram for te::rp::TiePointsMosaic:
te::rp::Algorithm

Classes

class  InputParameters
 Mosaic input parameters. More...
 
class  OutputParameters
 Mosaic output parameters. More...
 

Public Member Functions

bool execute (AlgorithmOutputParameters &outputParams) throw ( te::rp::Exception )
 Executes the algorithm using the supplied parameters. More...
 
const std::string & getErrorMessage () const
 Return the current error message if there is any. More...
 
bool initialize (const AlgorithmInputParameters &inputParams) throw ( te::rp::Exception )
 Initialize the algorithm instance making it ready for execution. More...
 
bool isInitialized () const
 Returns true if the algorithm instance is initialized and ready for execution. More...
 
void reset () throw ( te::rp::Exception )
 Clear all internal allocated objects and reset the algorithm to its initial state. More...
 
 TiePointsMosaic ()
 
 ~TiePointsMosaic ()
 

Protected Member Functions

bool executeGeoMosaic (TiePointsMosaic::OutputParameters &outputParams)
 Execute a mosaic of georeferenced images. More...
 
bool executeTiePointsMosaic (TiePointsMosaic::OutputParameters &outputParams)
 Execute a mosaic of images linket by tie-points. More...
 
void setErrorMessage (const std::string &newErrorMessage)
 Set the current error message. More...
 

Static Protected Member Functions

static void calcBandStatistics (const te::rst::Band &band, const bool &forceNoDataValue, const double &noDataValue, double &mean, double &variance)
 Raster band statistics calcule. More...
 

Protected Attributes

TiePointsMosaic::InputParameters m_inputParameters
 Input execution parameters. More...
 
bool m_isInitialized
 Tells if this instance is initialized. More...
 

Detailed Description

Create a mosaic from a set of rasters using tie-points.

Note
The first raster will always be taken as reference to define the mosaic resolution and SRS.

Definition at line 50 of file TiePointsMosaic.h.

Constructor & Destructor Documentation

◆ TiePointsMosaic()

te::rp::TiePointsMosaic::TiePointsMosaic ( )

◆ ~TiePointsMosaic()

te::rp::TiePointsMosaic::~TiePointsMosaic ( )

Member Function Documentation

◆ calcBandStatistics()

static void te::rp::TiePointsMosaic::calcBandStatistics ( const te::rst::Band band,
const bool &  forceNoDataValue,
const double &  noDataValue,
double &  mean,
double &  variance 
)
staticprotected

Raster band statistics calcule.

Parameters
bandInput raster band.
forceNoDataValueForce the noDataValue to be used as the band no-data value.
noDataValueThe no-data value to use.
meanPixels mean.
variancePixels variance.

◆ execute()

bool te::rp::TiePointsMosaic::execute ( AlgorithmOutputParameters outputParams)
throw (te::rp::Exception
)
virtual

Executes the algorithm using the supplied parameters.

Parameters
outputParamsOutput parameters.
Returns
true if OK, false on errors.
Note
A return error string can be obtained via Algorithm::getErrorMessage()

Implements te::rp::Algorithm.

◆ executeGeoMosaic()

bool te::rp::TiePointsMosaic::executeGeoMosaic ( TiePointsMosaic::OutputParameters outputParams)
protected

Execute a mosaic of georeferenced images.

Parameters
outputParamsThe algorithm execution parameters.
Returns
true if ok, false on errors.

◆ executeTiePointsMosaic()

bool te::rp::TiePointsMosaic::executeTiePointsMosaic ( TiePointsMosaic::OutputParameters outputParams)
protected

Execute a mosaic of images linket by tie-points.

Parameters
outputParamsThe algorithm execution parameters.
Returns
true if ok, false on errors.

◆ getErrorMessage()

const std::string& te::rp::Algorithm::getErrorMessage ( ) const
inherited

Return the current error message if there is any.

Returns
Return the current error message if there is any.

◆ initialize()

bool te::rp::TiePointsMosaic::initialize ( const AlgorithmInputParameters inputParams)
throw (te::rp::Exception
)
virtual

Initialize the algorithm instance making it ready for execution.

Parameters
inputParamsInput parameters.
Returns
true if OK, false on errors.
Note
A return error string can be obtained via Algorithm::getErrorMessage()

Implements te::rp::Algorithm.

◆ isInitialized()

bool te::rp::TiePointsMosaic::isInitialized ( ) const
virtual

Returns true if the algorithm instance is initialized and ready for execution.

Returns
true if the algorithm instance is initialized and ready for execution.

Implements te::rp::Algorithm.

◆ reset()

void te::rp::TiePointsMosaic::reset ( )
throw (te::rp::Exception
)
virtual

Clear all internal allocated objects and reset the algorithm to its initial state.

Reimplemented from te::rp::Algorithm.

◆ setErrorMessage()

void te::rp::Algorithm::setErrorMessage ( const std::string &  newErrorMessage)
protectedinherited

Set the current error message.

Parameters
newErrorMessageNew error message;

Member Data Documentation

◆ m_inputParameters

TiePointsMosaic::InputParameters te::rp::TiePointsMosaic::m_inputParameters
protected

Input execution parameters.

Definition at line 159 of file TiePointsMosaic.h.

◆ m_isInitialized

bool te::rp::TiePointsMosaic::m_isInitialized
protected

Tells if this instance is initialized.

Definition at line 161 of file TiePointsMosaic.h.


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