Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
te::rp::WisperFusion Class Reference
Raster Processing » Optical Raster Data Processing. » Fusion

Fusion of a low-resolution multi-band image with a high resolution image using the WiSpeR method. More...

#include <WisperFusion.h>

Inheritance diagram for te::rp::WisperFusion:
te::rp::Algorithm

Classes

class  InputParameters
 WisperFusion input parameters. More...
 
class  OutputParameters
 WisperFusion 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...
 
 WisperFusion ()
 
 ~WisperFusion ()
 

Protected Member Functions

void setErrorMessage (const std::string &newErrorMessage)
 Set the current error message. More...
 

Protected Attributes

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

Detailed Description

Fusion of a low-resolution multi-band image with a high resolution image using the WiSpeR method.

Note
This algorithm expects both images to be aligned over the same geographic region. No reprojection or crop operations are performed.
Reference: OTAZU, X.; GONZALEZ-AUDICANA, M.; FORS, O.; NUNEZ, J. Introduction of sensor spectral response into image fusion methods. application to wavelet-based methods. IEEE Transactions on Geoscience and Remote Sensing, v. 43, n. 10, p. 2376{2385, Oct. 2005. 21, 26, 36, 40.
Reference: GONZALEZ-AUDICANA, M.; OTAZU, X.; FORS, O.; SECO, A. Comparison between Mallat's and the 'a trous' discrete wavelet transform based algorithms for the fusion of multispectral and panchromatic images. International Journal of Remote Sensing, Taylor & Francis, v. 26, n. 3, p. 595{614, 2005. 33.
The spectral response functions must be in the form std::pair< double, double >( wavelength , response );

Definition at line 57 of file WisperFusion.h.

Constructor & Destructor Documentation

te::rp::WisperFusion::WisperFusion ( )

Definition at line 148 of file WisperFusion.cpp.

References te::rp::WisperFusion::InputParameters::reset(), and ~WisperFusion().

te::rp::WisperFusion::~WisperFusion ( )
default

Referenced by WisperFusion().

Member Function Documentation

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

Definition at line 155 of file WisperFusion.cpp.

References col, te::rp::CreateWaveletAtrousFilter(), te::rp::DirectWaveletAtrous(), te::dt::DOUBLE_TYPE, te::rst::Raster::getBand(), te::rp::GetDataTypeRange(), te::rst::Raster::getGrid(), te::rp::srf::getIntersectionSRF(), te::rst::Raster::getNumberOfBands(), te::rst::Raster::getNumberOfColumns(), te::rst::Raster::getNumberOfRows(), te::rst::Band::getProperty(), te::rp::srf::getSRF(), te::rp::srf::getSRFArea(), te::rp::srf::getUnionSRF(), te::rst::Raster::getValue(), te::sa::Grid, te::rp::WisperFusion::InputParameters::m_enableProgress, te::rp::WisperFusion::InputParameters::m_highResRasterBand, te::rp::WisperFusion::InputParameters::m_highResRasterPtr, te::rp::WisperFusion::InputParameters::m_hiResRasterBandSensor, te::rp::WisperFusion::InputParameters::m_hiResRasterBandsSRFs, te::rp::WisperFusion::InputParameters::m_hiResRasterWaveletLevels, m_inputParameters, te::rp::WisperFusion::InputParameters::m_interpMethod, m_isInitialized, te::rp::WisperFusion::InputParameters::m_lowResRasterBands, te::rp::WisperFusion::InputParameters::m_lowResRasterBandSensors, te::rp::WisperFusion::InputParameters::m_lowResRasterBandsSRFs, te::rp::WisperFusion::InputParameters::m_lowResRasterPtr, te::rp::WisperFusion::OutputParameters::m_outputRasterPtr, te::rp::WisperFusion::OutputParameters::m_rInfo, te::rp::WisperFusion::OutputParameters::m_rType, te::rp::WisperFusion::InputParameters::m_userWaveletFilterPtr, te::rp::WisperFusion::InputParameters::m_waveletFilterType, te::rst::RasterFactory::make(), nCols, te::rp::RasterResample(), te::rp::Matrix< TemplateElementType >::reset(), te::rst::Raster::setValue(), TERP_INSTANCE_TRUE_OR_RETURN_FALSE, and TERP_TRUE_OR_THROW.

Referenced by BOOST_AUTO_TEST_CASE(), and te::qt::widgets::FusionWizard::executeWisper().

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.

Definition at line 44 of file rp/Algorithm.cpp.

References te::rp::Algorithm::m_errorMessage.

Referenced by te::qt::widgets::FilterDialogForm::applyPreview(), te::qt::widgets::PostClassificationWidget::execute(), te::qt::widgets::ClassifierWizard::execute(), te::qt::widgets::MixtureModelWizard::execute(), te::qt::widgets::ContrastDialogForm::execute(), te::qt::widgets::FilterDialogForm::execute(), te::qt::widgets::ArithmeticOpDialogForm::execute(), te::qt::widgets::MosaicWizard::executeGeoMosaic(), te::qt::widgets::FusionWizard::executeIHS(), te::qt::widgets::FusionWizard::executePCA(), te::qt::widgets::MosaicWizard::executeSequenceMosaic(), te::qt::widgets::MosaicWizard::executeTiePointMosaic(), and te::qt::widgets::FusionWizard::executeWisper().

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

Definition at line 656 of file WisperFusion.cpp.

References te::rst::Raster::getAccessPolicy(), te::rst::Raster::getNumberOfBands(), te::rp::srf::InvalidSensor, te::rp::WisperFusion::InputParameters::m_highResRasterBand, te::rp::WisperFusion::InputParameters::m_highResRasterPtr, te::rp::WisperFusion::InputParameters::m_hiResRasterBandSensor, te::rp::WisperFusion::InputParameters::m_hiResRasterBandsSRFs, m_inputParameters, m_isInitialized, te::rp::WisperFusion::InputParameters::m_lowResRasterBands, te::rp::WisperFusion::InputParameters::m_lowResRasterBandSensors, te::rp::WisperFusion::InputParameters::m_lowResRasterBandsSRFs, te::rp::WisperFusion::InputParameters::m_lowResRasterPtr, te::rp::WisperFusion::InputParameters::m_userWaveletFilterPtr, te::common::RAccess, te::rp::WisperFusion::InputParameters::reset(), TERP_INSTANCE_TRUE_OR_RETURN_FALSE, and TERP_TRUE_OR_THROW.

Referenced by BOOST_AUTO_TEST_CASE(), and te::qt::widgets::FusionWizard::executeWisper().

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

Definition at line 749 of file WisperFusion.cpp.

References m_isInitialized.

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

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

Reimplemented from te::rp::Algorithm.

Definition at line 648 of file WisperFusion.cpp.

References m_inputParameters, m_isInitialized, te::rp::Algorithm::reset(), and te::rp::WisperFusion::InputParameters::reset().

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

Set the current error message.

Parameters
newErrorMessageNew error message;

Definition at line 49 of file rp/Algorithm.cpp.

References te::rp::Algorithm::m_errorMessage.

Member Data Documentation

InputParameters te::rp::WisperFusion::m_inputParameters
protected

Input execution parameters.

Definition at line 161 of file WisperFusion.h.

Referenced by execute(), initialize(), and reset().

bool te::rp::WisperFusion::m_isInitialized
protected

Tells if this instance is initialized.

Definition at line 163 of file WisperFusion.h.

Referenced by execute(), initialize(), isInitialized(), and reset().

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