QgsGDALGeorefTransform Class Reference

Interface to gdal thin plate splines and 1st/2nd/3rd order polynomials. More...

#include <qgsgcptransformer.h>

Inheritance diagram for QgsGDALGeorefTransform:

Public Member Functions
	QgsGDALGeorefTransform (bool useTPS, unsigned int polynomialOrder)
	Constructor for QgsGDALGeorefTransform. More...
	~QgsGDALGeorefTransform () override
QgsGcpTransformerInterface *	clone () const override
	Clones the transformer, returning a new copy of the transformer with the same parameters as this one. More...
GDALTransformerFunc	GDALTransformer () const override
	Returns function pointer to the GDALTransformer function. More...
void *	GDALTransformerArgs () const override
	Returns pointer to the GDALTransformer arguments. More...
TransformMethod	method () const override
	Returns the transformation method. More...
int	minimumGcpCount () const override
	Returns the minimum number of Ground Control Points (GCPs) required for parameter fitting. More...
bool	updateParametersFromGcps (const QVector< QgsPointXY > &sourceCoordinates, const QVector< QgsPointXY > &destinationCoordinates, bool invertYAxis=false) override
	Fits transformation parameters using the specified Ground Control Points (GCPs) lists of source and destination coordinates. More...
Public Member Functions inherited from QgsGcpTransformerInterface
	QgsGcpTransformerInterface ()=default
	Constructor for QgsGcpTransformerInterface. More...
	QgsGcpTransformerInterface (const QgsGcpTransformerInterface &other)=delete
	QgsGcpTransformerInterface cannot be copied - use clone() instead. More...
virtual	~QgsGcpTransformerInterface ()=default
virtual QgsGcpTransformerInterface *	clone () const =0
	Clones the transformer, returning a new copy of the transformer with the same parameters as this one. More...
virtual GDALTransformerFunc	GDALTransformer () const =0
	Returns function pointer to the GDALTransformer function. More...
virtual void *	GDALTransformerArgs () const =0
	Returns pointer to the GDALTransformer arguments. More...
virtual TransformMethod	method () const =0
	Returns the transformation method. More...
virtual int	minimumGcpCount () const =0
	Returns the minimum number of Ground Control Points (GCPs) required for parameter fitting. More...
QgsGcpTransformerInterface &	operator= (const QgsGcpTransformerInterface &other)=delete
	QgsGcpTransformerInterface cannot be copied - use clone() instead. More...
bool	transform (double &x, double &y, bool inverseTransform=false) const
	Transforms the point (x, y) from source to destination coordinates. More...
virtual bool	updateParametersFromGcps (const QVector< QgsPointXY > &sourceCoordinates, const QVector< QgsPointXY > &destinationCoordinates, bool invertYAxis=false) SIP_THROW(QgsNotSupportedException)=0
	Fits transformation parameters using the specified Ground Control Points (GCPs) lists of source and destination coordinates. More...

Additional Inherited Members
Public Types inherited from QgsGcpTransformerInterface
enum class	TransformMethod : int {   Linear , Helmert , PolynomialOrder1 , PolynomialOrder2 ,   PolynomialOrder3 , ThinPlateSpline , Projective , InvalidTransform = 65535 }
	Available transformation methods. More...
Static Public Member Functions inherited from QgsGcpTransformerInterface
static QgsGcpTransformerInterface *	create (TransformMethod method)
	Creates a new QgsGcpTransformerInterface subclass representing the specified transform method. More...
static QgsGcpTransformerInterface *	createFromParameters (TransformMethod method, const QVector< QgsPointXY > &sourceCoordinates, const QVector< QgsPointXY > &destinationCoordinates) SIP_THROW(QgsNotSupportedException)
	Creates a new QgsGcpTransformerInterface subclass representing the specified transform method, initialized using the given lists of source and destination coordinates. More...
static QString	methodToString (TransformMethod method)
	Returns a translated string representing the specified transform method. More...

Detailed Description

Interface to gdal thin plate splines and 1st/2nd/3rd order polynomials.

Note

Not available in Python bindings

Since

QGIS 3.20

Definition at line 231 of file qgsgcptransformer.h.

Constructor & Destructor Documentation

QgsGDALGeorefTransform()

QgsGDALGeorefTransform::QgsGDALGeorefTransform	(	bool	useTPS,
		unsigned int	polynomialOrder
	)

Constructor for QgsGDALGeorefTransform.

Definition at line 321 of file qgsgcptransformer.cpp.

~QgsGDALGeorefTransform()

QgsGDALGeorefTransform::~QgsGDALGeorefTransform ( )

override

Definition at line 327 of file qgsgcptransformer.cpp.

Member Function Documentation

clone()

QgsGcpTransformerInterface * QgsGDALGeorefTransform::clone ( ) const

overridevirtual

Clones the transformer, returning a new copy of the transformer with the same parameters as this one.

Caller takes ownership of the returned object.

Implements QgsGcpTransformerInterface.

Definition at line 332 of file qgsgcptransformer.cpp.

GDALTransformer()

GDALTransformerFunc QgsGDALGeorefTransform::GDALTransformer ( ) const

overridevirtual

Returns function pointer to the GDALTransformer function.

Implements QgsGcpTransformerInterface.

Definition at line 386 of file qgsgcptransformer.cpp.

GDALTransformerArgs()

void * QgsGDALGeorefTransform::GDALTransformerArgs ( ) const

overridevirtual

Returns pointer to the GDALTransformer arguments.

Implements QgsGcpTransformerInterface.

Definition at line 398 of file qgsgcptransformer.cpp.

method()

QgsGcpTransformerInterface::TransformMethod QgsGDALGeorefTransform::method ( ) const

overridevirtual

Returns the transformation method.

Implements QgsGcpTransformerInterface.

Definition at line 403 of file qgsgcptransformer.cpp.

minimumGcpCount()

int QgsGDALGeorefTransform::minimumGcpCount ( ) const

overridevirtual

Returns the minimum number of Ground Control Points (GCPs) required for parameter fitting.

Implements QgsGcpTransformerInterface.

Definition at line 378 of file qgsgcptransformer.cpp.

updateParametersFromGcps()

bool QgsGDALGeorefTransform::updateParametersFromGcps ( const QVector< QgsPointXY > &  sourceCoordinates, const QVector< QgsPointXY > &  destinationCoordinates, bool  invertYAxis = false  )

overridevirtual

Fits transformation parameters using the specified Ground Control Points (GCPs) lists of source and destination coordinates.

If invertYAxis is set to true then the y-axis of source coordinates will be inverted, e.g. to allow for transformation of raster layers with ascending top-to-bottom vertical axis coordinates.

Returns

true on success, false on failure

Implements QgsGcpTransformerInterface.

Definition at line 339 of file qgsgcptransformer.cpp.

---

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

• /build/qgis-3.28.0+99sid/src/analysis/georeferencing/qgsgcptransformer.h
• /build/qgis-3.28.0+99sid/src/analysis/georeferencing/qgsgcptransformer.cpp