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

Performs raster data registering into a SRS using a set of tie points. More...

#include <Register.h>

Inheritance diagram for te::rp::Register:
te::rp::Algorithm

Classes

class  InputParameters
 Register input parameters. More...
 
class  OutputParameters
 Register 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...
 
 Register ()
 
void reset () throw ( te::rp::Exception )
 Clear all internal allocated objects and reset the algorithm to its initial state. More...
 
 ~Register ()
 

Protected Member Functions

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

Protected Attributes

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

Detailed Description

Performs raster data registering into a SRS using a set of tie points.

Definition at line 48 of file Register.h.

Constructor & Destructor Documentation

te::rp::Register::Register ( )

Definition at line 141 of file src/terralib/rp/Register.cpp.

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

te::rp::Register::~Register ( )
default

Referenced by Register().

Member Function Documentation

bool te::rp::Register::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 148 of file src/terralib/rp/Register.cpp.

References te::gm::GeometricTransformation::clone(), te::rst::Raster::getBand(), te::rst::GetDataTypeRanges(), te::rst::Raster::getGrid(), te::rp::GetIndexedDetailedExtent(), te::rst::Band::getProperty(), te::rst::Interpolator::getValue(), te::gm::LineString::getX(), te::gm::LineString::getY(), te::rst::Grid::gridToGeo(), te::gm::GeometricTransformation::inverseMap(), te::gm::LineStringType, te::rp::Register::InputParameters::m_geomTransfName, te::rp::Register::InputParameters::m_geomTransfPtr, m_inputParameters, te::rp::Register::InputParameters::m_inputRasterBands, te::rp::Register::InputParameters::m_inputRasterPtr, te::rp::Register::InputParameters::m_interpMethod, m_isInitialized, te::gm::Envelope::m_llx, te::gm::Envelope::m_lly, te::rp::Register::InputParameters::m_noDataValue, te::rst::BandProperty::m_noDataValue, te::rp::Register::InputParameters::m_outputBoundingBox, te::rp::Register::OutputParameters::m_outputRasterPtr, te::rp::Register::InputParameters::m_outputResolutionX, te::rp::Register::InputParameters::m_outputResolutionY, te::rp::Register::InputParameters::m_outputSRID, te::rp::Register::OutputParameters::m_rInfo, te::rp::Register::OutputParameters::m_rType, te::rp::Register::InputParameters::m_tiePoints, te::gm::GTParameters::m_tiePoints, te::rst::BandProperty::m_type, te::gm::Envelope::m_urx, te::gm::Envelope::m_ury, te::rst::RasterFactory::make(), te::common::AbstractFactory< GeometricTransformation, std::string >::make(), nCols, te::rst::Band::setValue(), te::gm::LineString::size(), TERP_INSTANCE_TRUE_OR_RETURN_FALSE, and TERP_TRUE_OR_THROW.

Referenced by BOOST_AUTO_TEST_SUITE(), te::qt::widgets::RegisterWizard::execute(), and Register().

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::Register::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 319 of file src/terralib/rp/Register.cpp.

References te::rst::Raster::getAccessPolicy(), te::rst::Raster::getNumberOfBands(), te::gm::GeometricTransformation::isValid(), te::rp::Register::InputParameters::m_geomTransfName, te::rp::Register::InputParameters::m_geomTransfPtr, m_inputParameters, te::rp::Register::InputParameters::m_inputRasterBands, te::rp::Register::InputParameters::m_inputRasterPtr, m_isInitialized, te::rp::Register::InputParameters::m_outputResolutionX, te::rp::Register::InputParameters::m_outputResolutionY, te::rp::Register::InputParameters::m_outputSRID, te::rp::Register::InputParameters::m_tiePoints, te::common::AbstractFactory< GeometricTransformation, std::string >::make(), te::common::RAccess, te::rp::Register::InputParameters::reset(), TERP_INSTANCE_TRUE_OR_RETURN_FALSE, and TERP_TRUE_OR_THROW.

Referenced by BOOST_AUTO_TEST_SUITE(), te::qt::widgets::RegisterWizard::execute(), and Register().

bool te::rp::Register::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 386 of file src/terralib/rp/Register.cpp.

References m_isInitialized.

void te::rp::Register::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 311 of file src/terralib/rp/Register.cpp.

References m_inputParameters, m_isInitialized, te::rp::Algorithm::reset(), and te::rp::Register::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

Register::InputParameters te::rp::Register::m_inputParameters
protected

Input execution parameters.

Definition at line 145 of file Register.h.

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

bool te::rp::Register::m_isInitialized
protected

Tells if this instance is initialized.

Definition at line 147 of file Register.h.

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

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