QGIS API Documentation  3.20.0-Odense (decaadbb31)
Classes | Public Member Functions | List of all members
QgsLinearGeorefTransform Class Reference

A simple transform which is parametrized by a translation and anistotropic scale. More...

#include <qgsgcptransformer.h>

Inheritance diagram for QgsLinearGeorefTransform:
Inheritance graph
[legend]

Public Member Functions

 QgsLinearGeorefTransform ()=default
 Constructor for QgsLinearGeorefTransform. More...
 
QgsGcpTransformerInterfaceclone () 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...
 
bool getOriginScale (QgsPointXY &origin, double &scaleX, double &scaleY) const
 Returns the origin and scale for the transform. 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
 
QgsGcpTransformerInterfaceoperator= (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...
 

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 QgsGcpTransformerInterfacecreate (TransformMethod method)
 Creates a new QgsGcpTransformerInterface subclass representing the specified transform method. More...
 
static QgsGcpTransformerInterfacecreateFromParameters (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

A simple transform which is parametrized by a translation and anistotropic scale.

Note
Not available in Python bindings
Since
QGIS 3.20

Definition at line 148 of file qgsgcptransformer.h.

Constructor & Destructor Documentation

◆ QgsLinearGeorefTransform()

QgsLinearGeorefTransform::QgsLinearGeorefTransform ( )
default

Constructor for QgsLinearGeorefTransform.

Member Function Documentation

◆ clone()

QgsGcpTransformerInterface * QgsLinearGeorefTransform::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 118 of file qgsgcptransformer.cpp.

◆ GDALTransformer()

GDALTransformerFunc QgsLinearGeorefTransform::GDALTransformer ( ) const
overridevirtual

Returns function pointer to the GDALTransformer function.

Implements QgsGcpTransformerInterface.

Definition at line 140 of file qgsgcptransformer.cpp.

◆ GDALTransformerArgs()

void * QgsLinearGeorefTransform::GDALTransformerArgs ( ) const
overridevirtual

Returns pointer to the GDALTransformer arguments.

Implements QgsGcpTransformerInterface.

Definition at line 145 of file qgsgcptransformer.cpp.

◆ getOriginScale()

bool QgsLinearGeorefTransform::getOriginScale ( QgsPointXY origin,
double &  scaleX,
double &  scaleY 
) const

Returns the origin and scale for the transform.

Definition at line 110 of file qgsgcptransformer.cpp.

◆ method()

QgsGcpTransformerInterface::TransformMethod QgsLinearGeorefTransform::method ( ) const
overridevirtual

Returns the transformation method.

Implements QgsGcpTransformerInterface.

Definition at line 150 of file qgsgcptransformer.cpp.

◆ minimumGcpCount()

int QgsLinearGeorefTransform::minimumGcpCount ( ) const
overridevirtual

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

Implements QgsGcpTransformerInterface.

Definition at line 135 of file qgsgcptransformer.cpp.

◆ updateParametersFromGcps()

bool QgsLinearGeorefTransform::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 125 of file qgsgcptransformer.cpp.


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