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:

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)
	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)
	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 ()
	Clear all internal allocated objects and reset the algorithm to its initial state. More...
	SequenceMosaic ()
	~SequenceMosaic ()

Protected Member Functions
bool	calcBandStatistics (const te::rst::Raster &raster, const unsigned int bandIndex, const bool &forceNoDataValue, const double &noDataValue, double &mean, double &variance)
	Raster band statistics calcule. More...
bool	createDiskRasterCopy (const std::string &fileName, const te::rst::Raster &sourceRaster)
	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...

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

Private Attributes
std::string	m_errorMessage
	Current error message. 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()

bool te::rp::SequenceMosaic::calcBandStatistics ( const te::rst::Raster &  raster, const unsigned int  bandIndex, const bool &  forceNoDataValue, const double &  noDataValue, double &  mean, double &  variance  )

protected

Raster band statistics calcule.

Parameters

raster	Input raster
bandIndex	Input raster band index.
forceNoDataValue	Force the noDataValue to be used as the band no-data value.
noDataValue	The no-data value to use.
mean	Pixels mean.
variance	Pixels variance.

Returns

true if ok, false on errors.

createDiskRasterCopy()

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

protected

Create copy of the given raster into a disk file.

Parameters

fileName	The disk file name.
sourceRaster	The 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

dataSetName	The data set name.
sourceRaster	The source raster.
dataSourcePtr	The output data source pointer.

Returns

true if OK, false on errors.

execute()

bool te::rp::SequenceMosaic::execute ( AlgorithmOutputParameters &  outputParams )

virtual

Executes the algorithm using the supplied parameters.

Parameters

outputParams

Output 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 )

virtual

Initialize the algorithm instance making it ready for execution.

Parameters

inputParams

Input 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 ( )

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

newErrorMessage

New error message;

Member Data Documentation

m_errorMessage

std::string te::rp::Algorithm::m_errorMessage

privateinherited

Current error message.

Definition at line 104 of file Algorithm.h.

m_inputParameters

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

protected

Input execution parameters.

Definition at line 181 of file SequenceMosaic.h.

m_isInitialized

bool te::rp::SequenceMosaic::m_isInitialized

protected

Tells if this instance is initialized.

Definition at line 183 of file SequenceMosaic.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/rp/SequenceMosaic.h