te::rp::MixtureModel Class Reference

Raster decomposition using mixture model. More...

#include <MixtureModel.h>

Inheritance diagram for te::rp::MixtureModel:
te::rp::Algorithm

Classes

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

Public Member Functions

bool execute (AlgorithmOutputParameters &outputParams) throw (te::rp::Exception)
 Executes the mixing model using the parameters defined in inputParams and outputParams. More...
 
bool generateTransformMatrix (boost::numeric::ublas::matrix< double > &matrix)
 Generates a Transform Matrix. 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)
 Initializes model with paramters defined in inputParams. More...
 
bool isInitialized () const
 Model already initialized? More...
 
 MixtureModel ()
 
void reset () throw (te::rp::Exception)
 Resets all variables. More...
 
bool setTransformMatrix (boost::numeric::ublas::matrix< double > &matrix)
 Sets Transform Matrix, read from a file or pre-calculated. More...
 
 ~MixtureModel ()
 

Protected Member Functions

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

Protected Attributes

MixtureModel::InputParameters m_inputParameters
 Mixture model execution parameters. More...
 
bool m_instanceInitialized
 Is this instance already initialized? More...
 

Private Attributes

std::string m_errorMessage
 Current error message. More...
 

Detailed Description

Raster decomposition using mixture model.

Raster decomposition following the choosed mixture model strategy.

Note
The created output image will be written to the raster instance pointed by m_outRasterPtr (in this case the output band must also be passed by m_outRasterBand).

Definition at line 62 of file MixtureModel.h.

Constructor & Destructor Documentation

◆ MixtureModel()

te::rp::MixtureModel::MixtureModel ( )

◆ ~MixtureModel()

te::rp::MixtureModel::~MixtureModel ( )

Member Function Documentation

◆ execute()

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

Executes the mixing model using the parameters defined in inputParams and outputParams.

Implements te::rp::Algorithm.

◆ generateTransformMatrix()

bool te::rp::MixtureModel::generateTransformMatrix ( boost::numeric::ublas::matrix< double > &  matrix)

Generates a Transform Matrix.

◆ 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::MixtureModel::initialize ( const AlgorithmInputParameters inputParams)
throw (te::rp::Exception
)
virtual

Initializes model with paramters defined in inputParams.

Implements te::rp::Algorithm.

◆ isInitialized()

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

Model already initialized?

Implements te::rp::Algorithm.

◆ reset()

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

Resets all variables.

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;

◆ setTransformMatrix()

bool te::rp::MixtureModel::setTransformMatrix ( boost::numeric::ublas::matrix< double > &  matrix)

Sets Transform Matrix, read from a file or pre-calculated.

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

MixtureModel::InputParameters te::rp::MixtureModel::m_inputParameters
protected

Mixture model execution parameters.

Definition at line 195 of file MixtureModel.h.

◆ m_instanceInitialized

bool te::rp::MixtureModel::m_instanceInitialized
protected

Is this instance already initialized?

Definition at line 194 of file MixtureModel.h.


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