te::rp::PCAFusion Class Reference

Fusion of a low-resolution multi-band image with a high resolution image using the PCA (Principal components analysis) method. More...

#include <PCAFusion.h>

Inheritance diagram for te::rp::PCAFusion:

Classes
class	InputParameters
	PCAFusion input parameters. More...
class	OutputParameters
	PCAFusion output parameters. More...
struct	SwapBandByHighResRasterThreadParameters

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

Protected Member Functions
void	setErrorMessage (const std::string &newErrorMessage)
	Set the current error message.
bool	swapBandByHighResRaster (const te::rst::Raster &highResRaster, const unsigned int highResRasterBand, te::rst::Raster &pcaRaster, const unsigned int pcaRasterBandIdx)
	Swap the band values by the normalized high resolution raster data.

Static Protected Member Functions
static void	swapBandByHighResRasterThreadEntry (SwapBandByHighResRasterThreadParameters *paramsPtr)

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

Private Attributes
std::string	m_errorMessage
	Current error message.

Detailed Description

Fusion of a low-resolution multi-band image with a high resolution image using the PCA (Principal components analysis) method.

The PCA performs image fusion where the first principal component of the multi-spectral image is replaced by the histogram matched panchromatic imagery.

Note

Reference: Tania Stathaki, "Image Fusion: Algorithms and Applications", Elsevier, First edition 2008.

This algorithm expects both images to be aligned over the same geographic region. No reprojection or crop operations are performed.

Definition at line 53 of file PCAFusion.h.

Constructor & Destructor Documentation

PCAFusion()

te::rp::PCAFusion::PCAFusion

(

)

~PCAFusion()

te::rp::PCAFusion::~PCAFusion

(

)

Member Function Documentation

execute()

bool te::rp::PCAFusion::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::PCAFusion::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::PCAFusion::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::PCAFusion::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;

swapBandByHighResRaster()

bool te::rp::PCAFusion::swapBandByHighResRaster ( const te::rst::Raster &  highResRaster, const unsigned int  highResRasterBand, te::rst::Raster &  pcaRaster, const unsigned int  pcaRasterBandIdx  )

protected

Swap the band values by the normalized high resolution raster data.

Parameters

highResRaster	High resolution raster.
highResRaster	High resolution raster.
pcaRaster	The PCA raster.
pcaRasterBandIdx	The band index where the values will be swapped.

Returns

true if ok, false on errors.

swapBandByHighResRasterThreadEntry()

static void te::rp::PCAFusion::swapBandByHighResRasterThreadEntry ( SwapBandByHighResRasterThreadParameters *  paramsPtr )

staticprotected

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

InputParameters te::rp::PCAFusion::m_inputParameters

protected

Input execution parameters.

Definition at line 189 of file PCAFusion.h.

m_isInitialized

bool te::rp::PCAFusion::m_isInitialized

protected

Tells if this instance is initialized.

Definition at line 191 of file PCAFusion.h.

---

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

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