te::rp::SequenceMosaic Class Reference

Create mosaics from a sequence of overlapped rasters using an automatic tie-points detection method. More...

#include <SequenceMosaic.h>

Inheritance diagram for te::rp::SequenceMosaic:
te::rp::Algorithm

Classes

class  InputParameters
 Mosaic input parameters. More...
 
class  MosaicSequenceInfo
 Mosaic sequence info. 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...
 
 SequenceMosaic ()
 
 ~SequenceMosaic ()
 

Protected Member Functions

bool createDiskRasterCopy (const std::string &fileName, const te::rst::Raster &sourceRaster) const
 Create copy of the given raster into a disk file. More...
 
bool createRasterDataSet (const std::string &dataSetName, const te::rst::Raster &sourceRaster, te::da::DataSource *dataSourcePtr) const
 Create a raster data set from the given raster. 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

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

Detailed Description

Create mosaics from a sequence of overlapped rasters using an automatic tie-points detection method.

Note
When the tie-points detection fails, a new mosaic sequence is generated.
Each mosaic sequence takes the first raster (of each sequence) as reference for resolution, SRS and equalization parameters.

Definition at line 50 of file SequenceMosaic.h.

Constructor & Destructor Documentation

◆ SequenceMosaic()

te::rp::SequenceMosaic::SequenceMosaic ( )

◆ ~SequenceMosaic()

te::rp::SequenceMosaic::~SequenceMosaic ( )

Member Function Documentation

◆ calcBandStatistics()

static void te::rp::SequenceMosaic::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.

◆ createDiskRasterCopy()

bool te::rp::SequenceMosaic::createDiskRasterCopy ( const std::string &  fileName,
const te::rst::Raster sourceRaster 
) const
protected

Create copy of the given raster into a disk file.

Parameters
fileNameThe disk file name.
sourceRasterThe source raster.
Returns
true if OK, false on errors.

◆ createRasterDataSet()

bool te::rp::SequenceMosaic::createRasterDataSet ( const std::string &  dataSetName,
const te::rst::Raster sourceRaster,
te::da::DataSource dataSourcePtr 
) const
protected

Create a raster data set from the given raster.

Parameters
dataSetNameThe data set name.
sourceRasterThe source raster.
dataSourcePtrThe output data source pointer.
Returns
true if OK, false on errors.

◆ execute()

bool te::rp::SequenceMosaic::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.

◆ 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::SequenceMosaic::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::SequenceMosaic::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::SequenceMosaic::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

SequenceMosaic::InputParameters te::rp::SequenceMosaic::m_inputParameters
protected

Input execution parameters.

Definition at line 176 of file SequenceMosaic.h.

◆ m_isInitialized

bool te::rp::SequenceMosaic::m_isInitialized
protected

Tells if this instance is initialized.

Definition at line 178 of file SequenceMosaic.h.


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