te::gm::GeometricTransformation Class Referenceabstract

2D Geometric transformation base class. More...

#include <GeometricTransformation.h>

Inheritance diagram for te::gm::GeometricTransformation:
te::gm::AffineGT te::gm::ProjectiveGT te::gm::RSTGT te::gm::SecondDegreePolynomialGT te::gm::ThirdDegreePolynomialGT

Public Member Functions

virtual GeometricTransformationclone () const =0
 Creat a clone copy of this instance. More...
 
virtual void directMap (const GTParameters &params, const double &pt1X, const double &pt1Y, double &pt2X, double &pt2Y) const =0
 Direct mapping (from pt1 space into pt2 space). More...
 
void directMap (const double &pt1X, const double &pt1Y, double &pt2X, double &pt2Y) const
 Direct mapping ( from pt1 space into pt2 space ). More...
 
void directMap (const GTParameters &params, const Coord2D &pt1, Coord2D &pt2) const
 Direct mapping (from pt1 space into pt2 space). More...
 
void directMap (const Coord2D &pt1, Coord2D &pt2) const
 Direct mapping (from pt1 space into pt2 space). More...
 
double getDirectMappingError (const GTParameters::TiePoint &tiePoint, const GTParameters &params) const
 Calculates the direct mapping error for the supplied tie-point. More...
 
double getDirectMappingError (const GTParameters::TiePoint &tiePoint) const
 Calculates the direct mapping error for the supplied tie-point. More...
 
double getDirectMapRMSE (const std::vector< GTParameters::TiePoint > &tiePoints, const GTParameters &params) const
 Calculates root mean square direct mapping error for the supplied tie-points using the supplied parameters. More...
 
double getDirectMapRMSE (const GTParameters &params) const
 Calculates root mean square direct mapping error for the supplied parameters. More...
 
double getDirectMapRMSE (const std::vector< GTParameters::TiePoint > &tiePoints) const
 Calculates root mean square direct mapping error for the supplied tie-points. More...
 
double getDirectMapRMSE () const
 Calculates root mean square direct mapping error. More...
 
double getInverseMappingError (const GTParameters::TiePoint &tiePoint, const GTParameters &params) const
 Calculates the inverse mapping error for the supplied tie-point. More...
 
double getInverseMappingError (const GTParameters::TiePoint &tiePoint) const
 Calculates the inverse mapping error for the supplied tie-point. More...
 
double getInverseMapRMSE (const std::vector< GTParameters::TiePoint > &tiePoints, const GTParameters &params) const
 Calculates root mean square inverse mapping error for the supplied tie-points using the supplied parameters. More...
 
double getInverseMapRMSE (const GTParameters &params) const
 Calculates root mean square inverse mapping error for the supplied parameters. More...
 
double getInverseMapRMSE (const std::vector< GTParameters::TiePoint > &tiePoints) const
 Calculates root mean square inverse mapping error for the supplied tie-points. More...
 
double getInverseMapRMSE () const
 Calculates root mean square inverse mapping error. More...
 
double getMaxDirectMappingError (const GTParameters &params) const
 Calculates maximum direct mapping error for the supplied parameters. More...
 
double getMaxDirectMappingError () const
 Calculates the current transformation maximum direct mapping error. More...
 
double getMaxInverseMappingError (const GTParameters &params) const
 Calculates maximum inverse mapping error for the supplied parameters. More...
 
double getMaxInverseMappingError () const
 Calculates the current transformation maximum inverse mapping error. More...
 
virtual unsigned int getMinRequiredTiePoints () const =0
 Returns the minimum number of required tie-points for the current transformation. More...
 
virtual const std::string & getName () const =0
 Returns the current transformation name. More...
 
const GTParametersgetParameters () const
 Returns a reference of the current internal transformation parameters. More...
 
bool initialize (const GTParameters &newParameters)
 Initialize the current transformation following the new supplied parameters. More...
 
virtual void inverseMap (const GTParameters &params, const double &pt2X, const double &pt2Y, double &pt1X, double &pt1Y) const =0
 Inverse mapping (from pt2 space into pt1 space). More...
 
void inverseMap (const double &pt2X, const double &pt2Y, double &pt1X, double &pt1Y) const
 Inverse mapping (from pt2 space into pt1 space). More...
 
void inverseMap (const GTParameters &params, const Coord2D &pt2, Coord2D &pt1) const
 Inverse mapping ( from pt2 space into pt1 space ). More...
 
void inverseMap (const Coord2D &pt2, Coord2D &pt1) const
 Inverse mapping (from pt2 space into pt1 space). More...
 
virtual bool isValid (const GTParameters &params) const =0
 Verifies if the supplied parameters already has a valid transformation. More...
 
bool isValid () const
 Tells if the current instance has a valid transformation. More...
 
virtual ~GeometricTransformation ()
 Virtual destructor. More...
 

Protected Member Functions

virtual bool computeParameters (GTParameters &params) const =0
 Calculate the transformation parameters following the new supplied tie-points. More...
 
 GeometricTransformation ()
 Default constructor. More...
 

Protected Attributes

GTParameters m_internalParameters
 The current internal parameters. More...
 

Friends

class GTFilter
 

Detailed Description

2D Geometric transformation base class.

Definition at line 56 of file GeometricTransformation.h.

Constructor & Destructor Documentation

virtual te::gm::GeometricTransformation::~GeometricTransformation ( )
virtual

Virtual destructor.

te::gm::GeometricTransformation::GeometricTransformation ( )
protected

Default constructor.

Member Function Documentation

virtual GeometricTransformation* te::gm::GeometricTransformation::clone ( ) const
pure virtual

Creat a clone copy of this instance.

Returns
A clone copy of this instance (the caller of this method must take the ownership of the returned object and delete it when appropriate.

Implemented in te::gm::ProjectiveGT, te::gm::AffineGT, te::gm::RSTGT, te::gm::ThirdDegreePolynomialGT, and te::gm::SecondDegreePolynomialGT.

virtual bool te::gm::GeometricTransformation::computeParameters ( GTParameters params) const
protectedpure virtual

Calculate the transformation parameters following the new supplied tie-points.

Parameters
paramsTransformation parameters.
Returns
true if OK, false on errors.

Implemented in te::gm::AffineGT, te::gm::ProjectiveGT, te::gm::RSTGT, te::gm::ThirdDegreePolynomialGT, and te::gm::SecondDegreePolynomialGT.

virtual void te::gm::GeometricTransformation::directMap ( const GTParameters params,
const double &  pt1X,
const double &  pt1Y,
double &  pt2X,
double &  pt2Y 
) const
pure virtual

Direct mapping (from pt1 space into pt2 space).

Parameters
paramsTransformation parameters.
pt1Xpt1 X coordinate.
pt1Ypt1 Y coordinate.
pt2Xpt2 X coordinate.
pt2Ypt2 Y coordinate.

Implemented in te::gm::ProjectiveGT, te::gm::AffineGT, te::gm::RSTGT, te::gm::ThirdDegreePolynomialGT, and te::gm::SecondDegreePolynomialGT.

void te::gm::GeometricTransformation::directMap ( const double &  pt1X,
const double &  pt1Y,
double &  pt2X,
double &  pt2Y 
) const
inline

Direct mapping ( from pt1 space into pt2 space ).

Parameters
pt1Xpt1 X coordinate.
pt1Ypt1 Y coordinate.
pt2Xpt2 X coordinate.
pt2Ypt2 Y coordinate.

Definition at line 133 of file GeometricTransformation.h.

void te::gm::GeometricTransformation::directMap ( const GTParameters params,
const Coord2D pt1,
Coord2D pt2 
) const
inline

Direct mapping (from pt1 space into pt2 space).

Parameters
paramsTransformation parameters.
pt1pt1 coordinate.
pt2pt2 coordinate.

Definition at line 150 of file GeometricTransformation.h.

References te::gm::Coord2D::x, and te::gm::Coord2D::y.

void te::gm::GeometricTransformation::directMap ( const Coord2D pt1,
Coord2D pt2 
) const
inline

Direct mapping (from pt1 space into pt2 space).

Parameters
pt1pt1 coordinate.
pt2pt2 coordinate.

Definition at line 161 of file GeometricTransformation.h.

References te::gm::Coord2D::x, and te::gm::Coord2D::y.

double te::gm::GeometricTransformation::getDirectMappingError ( const GTParameters::TiePoint tiePoint,
const GTParameters params 
) const

Calculates the direct mapping error for the supplied tie-point.

Parameters
tiePointThe tie-point.
paramsTransformation parameters.
Returns
The current maximum direct mapping error.
double te::gm::GeometricTransformation::getDirectMappingError ( const GTParameters::TiePoint tiePoint) const
inline

Calculates the direct mapping error for the supplied tie-point.

Parameters
tiePointThe tie-point.
Returns
The current direct mapping error.

Definition at line 374 of file GeometricTransformation.h.

double te::gm::GeometricTransformation::getDirectMapRMSE ( const std::vector< GTParameters::TiePoint > &  tiePoints,
const GTParameters params 
) const

Calculates root mean square direct mapping error for the supplied tie-points using the supplied parameters.

Parameters
tiePointsThe tie-points.
paramsTransformation parameters.
Returns
The root mean square error.
double te::gm::GeometricTransformation::getDirectMapRMSE ( const GTParameters params) const
inline

Calculates root mean square direct mapping error for the supplied parameters.

Parameters
paramsTransformation parameters.
Returns
The root mean square error.

Definition at line 283 of file GeometricTransformation.h.

References te::gm::GTParameters::m_tiePoints.

double te::gm::GeometricTransformation::getDirectMapRMSE ( const std::vector< GTParameters::TiePoint > &  tiePoints) const
inline

Calculates root mean square direct mapping error for the supplied tie-points.

Parameters
tiePointsThe tie-points.
Returns
The root mean square error.

Definition at line 295 of file GeometricTransformation.h.

double te::gm::GeometricTransformation::getDirectMapRMSE ( ) const
inline

Calculates root mean square direct mapping error.

Returns
The root mean square error.

Definition at line 305 of file GeometricTransformation.h.

double te::gm::GeometricTransformation::getInverseMappingError ( const GTParameters::TiePoint tiePoint,
const GTParameters params 
) const

Calculates the inverse mapping error for the supplied tie-point.

Parameters
tiePointThe tie-point.
paramsTransformation parameters.
Returns
The current maximum inverse mapping error.
double te::gm::GeometricTransformation::getInverseMappingError ( const GTParameters::TiePoint tiePoint) const
inline

Calculates the inverse mapping error for the supplied tie-point.

Parameters
tiePointThe tie-point.
Returns
The current inverse mapping error.

Definition at line 397 of file GeometricTransformation.h.

double te::gm::GeometricTransformation::getInverseMapRMSE ( const std::vector< GTParameters::TiePoint > &  tiePoints,
const GTParameters params 
) const

Calculates root mean square inverse mapping error for the supplied tie-points using the supplied parameters.

Parameters
tiePointsThe tie-points.
paramsTransformation parameters.
Returns
The root mean square error.
double te::gm::GeometricTransformation::getInverseMapRMSE ( const GTParameters params) const
inline

Calculates root mean square inverse mapping error for the supplied parameters.

Parameters
paramsTransformation parameters.
Returns
The root mean square error.

Definition at line 329 of file GeometricTransformation.h.

References te::gm::GTParameters::m_tiePoints.

double te::gm::GeometricTransformation::getInverseMapRMSE ( const std::vector< GTParameters::TiePoint > &  tiePoints) const
inline

Calculates root mean square inverse mapping error for the supplied tie-points.

Parameters
tiePointsThe tie-points.
Returns
The root mean square error.

Definition at line 341 of file GeometricTransformation.h.

double te::gm::GeometricTransformation::getInverseMapRMSE ( ) const
inline

Calculates root mean square inverse mapping error.

Returns
The root mean square error.

Definition at line 351 of file GeometricTransformation.h.

double te::gm::GeometricTransformation::getMaxDirectMappingError ( const GTParameters params) const

Calculates maximum direct mapping error for the supplied parameters.

Parameters
paramsTransformation parameters.
Returns
The maximum direct mapping error for the supplied parameters.
double te::gm::GeometricTransformation::getMaxDirectMappingError ( ) const
inline

Calculates the current transformation maximum direct mapping error.

Returns
The current maximum direct mapping error.

Definition at line 240 of file GeometricTransformation.h.

double te::gm::GeometricTransformation::getMaxInverseMappingError ( const GTParameters params) const

Calculates maximum inverse mapping error for the supplied parameters.

Parameters
paramsTransformation parameters.
Returns
The maximum inverse mapping error for the supplied parameters.
double te::gm::GeometricTransformation::getMaxInverseMappingError ( ) const
inline

Calculates the current transformation maximum inverse mapping error.

Returns
The current maximum inverse mapping error.

Definition at line 259 of file GeometricTransformation.h.

virtual unsigned int te::gm::GeometricTransformation::getMinRequiredTiePoints ( ) const
pure virtual

Returns the minimum number of required tie-points for the current transformation.

Returns
The minimum number of required tie-points for the current transformation.

Implemented in te::gm::ProjectiveGT, te::gm::AffineGT, te::gm::RSTGT, te::gm::ThirdDegreePolynomialGT, and te::gm::SecondDegreePolynomialGT.

virtual const std::string& te::gm::GeometricTransformation::getName ( ) const
pure virtual

Returns the current transformation name.

Returns
The current transformation name.

Implemented in te::gm::ProjectiveGT, te::gm::AffineGT, te::gm::RSTGT, te::gm::ThirdDegreePolynomialGT, and te::gm::SecondDegreePolynomialGT.

const GTParameters& te::gm::GeometricTransformation::getParameters ( ) const
inline

Returns a reference of the current internal transformation parameters.

Returns
A reference of the current internal transformation parameters.

Definition at line 105 of file GeometricTransformation.h.

bool te::gm::GeometricTransformation::initialize ( const GTParameters newParameters)

Initialize the current transformation following the new supplied parameters.

Parameters
newparamsThe new parameters.
Returns
true if OK, false on errors.
virtual void te::gm::GeometricTransformation::inverseMap ( const GTParameters params,
const double &  pt2X,
const double &  pt2Y,
double &  pt1X,
double &  pt1Y 
) const
pure virtual

Inverse mapping (from pt2 space into pt1 space).

Parameters
paramsTransformation parameters.
pt1Xpt1 X coordinate.
pt1Ypt1 Y coordinate.
pt2Xpt2 X coordinate.
pt2Ypt2 Y coordinate.

Implemented in te::gm::ProjectiveGT, te::gm::AffineGT, te::gm::RSTGT, te::gm::ThirdDegreePolynomialGT, and te::gm::SecondDegreePolynomialGT.

void te::gm::GeometricTransformation::inverseMap ( const double &  pt2X,
const double &  pt2Y,
double &  pt1X,
double &  pt1Y 
) const
inline

Inverse mapping (from pt2 space into pt1 space).

Parameters
pt1Xpt1 X coordinate.
pt1Ypt1 Y coordinate.
pt2Xpt2 X coordinate.
pt2Ypt2 Y coordinate.

Definition at line 191 of file GeometricTransformation.h.

void te::gm::GeometricTransformation::inverseMap ( const GTParameters params,
const Coord2D pt2,
Coord2D pt1 
) const
inline

Inverse mapping ( from pt2 space into pt1 space ).

Parameters
paramsTransformation parameters.
pt2pt2 coordinate.
pt1pt1 coordinate.

Definition at line 208 of file GeometricTransformation.h.

References te::gm::Coord2D::x, and te::gm::Coord2D::y.

void te::gm::GeometricTransformation::inverseMap ( const Coord2D pt2,
Coord2D pt1 
) const
inline

Inverse mapping (from pt2 space into pt1 space).

Parameters
pt2pt2 coordinate.
pt1pt1 coordinate.

Definition at line 219 of file GeometricTransformation.h.

References te::gm::Coord2D::x, and te::gm::Coord2D::y.

virtual bool te::gm::GeometricTransformation::isValid ( const GTParameters params) const
pure virtual

Verifies if the supplied parameters already has a valid transformation.

Parameters
paramsTransformation parameters.
Returns
true if a transformation is already defined, false otherwise.

Implemented in te::gm::ProjectiveGT, te::gm::AffineGT, te::gm::RSTGT, te::gm::ThirdDegreePolynomialGT, and te::gm::SecondDegreePolynomialGT.

bool te::gm::GeometricTransformation::isValid ( ) const
inline

Tells if the current instance has a valid transformation.

Returns
true if a transformation is already defined, false otherwise.

Definition at line 86 of file GeometricTransformation.h.

Friends And Related Function Documentation

friend class GTFilter
friend

Definition at line 58 of file GeometricTransformation.h.

Member Data Documentation

GTParameters te::gm::GeometricTransformation::m_internalParameters
protected

The current internal parameters.

Definition at line 432 of file GeometricTransformation.h.


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