OGRCoordinateTransformation Class Reference

Interface for transforming between coordinate systems. More...

#include <ogr_spatialref.h>

Inherited by CompositeCT, CutlineTransformer, GCPCoordTransformation, and OGRProj4CT.

Public Member Functions
virtual OGRSpatialReference *	GetSourceCS ()=0
	Fetch internal source coordinate system. More...
virtual OGRSpatialReference *	GetTargetCS ()=0
	Fetch internal target coordinate system. More...
virtual bool	GetEmitErrors ()
	Whether the transformer will emit CPLError.
virtual void	SetEmitErrors (bool)
	Set if the transformer must emit CPLError.
virtual int	Transform (int nCount, double *x, double *y, double *z=nullptr)=0
	Transform points from source to destination space. More...
virtual int	TransformEx (int nCount, double *x, double *y, double *z=nullptr, int *pabSuccess=nullptr)=0
	Transform points from source to destination space. More...

Static Public Member Functions
static void	DestroyCT (OGRCoordinateTransformation *poCT)
	OGRCoordinateTransformation destructor. More...
static OGRCoordinateTransformationH	ToHandle (OGRCoordinateTransformation *poCT)
	Convert a OGRCoordinateTransformation* to a OGRCoordinateTransformationH. More...
static OGRCoordinateTransformation *	FromHandle (OGRCoordinateTransformationH hCT)
	Convert a OGRCoordinateTransformationH to a OGRCoordinateTransformation*. More...

Detailed Description

Interface for transforming between coordinate systems.

Currently, the only implementation within OGR is OGRProj4CT, which requires the PROJ.4 library to be available at run-time.

Also, see OGRCreateCoordinateTransformation() for creating transformations.

Member Function Documentation

DestroyCT()

void OGRCoordinateTransformation::DestroyCT ( OGRCoordinateTransformation *  poCT )

static

OGRCoordinateTransformation destructor.

This function is the same as OGRCoordinateTransformation::~OGRCoordinateTransformation() and OCTDestroyCoordinateTransformation()

This static method will destroy a OGRCoordinateTransformation. It is equivalent to calling delete on the object, but it ensures that the deallocation is properly executed within the OGR libraries heap on platforms where this can matter (win32).

Parameters

poCT	the object to delete

Since

GDAL 1.7.0

FromHandle()

static OGRCoordinateTransformation* OGRCoordinateTransformation::FromHandle ( OGRCoordinateTransformationH  hCT )

inlinestatic

Convert a OGRCoordinateTransformationH to a OGRCoordinateTransformation*.

Since

GDAL 2.3

GetSourceCS()

virtual OGRSpatialReference* OGRCoordinateTransformation::GetSourceCS ( )

pure virtual

Fetch internal source coordinate system.

GetTargetCS()

virtual OGRSpatialReference* OGRCoordinateTransformation::GetTargetCS ( )

pure virtual

Fetch internal target coordinate system.

ToHandle()

static OGRCoordinateTransformationH OGRCoordinateTransformation::ToHandle ( OGRCoordinateTransformation *  poCT )

inlinestatic

Convert a OGRCoordinateTransformation* to a OGRCoordinateTransformationH.

Since

GDAL 2.3

Transform()

virtual int OGRCoordinateTransformation::Transform ( int  nCount, double *  x, double *  y, double *  z = nullptr  )

pure virtual

Transform points from source to destination space.

This method is the same as the C function OCTTransform().

The method TransformEx() allows extended success information to be captured indicating which points failed to transform.

Parameters

nCount	number of points to transform.
x	array of nCount X vertices, modified in place.
y	array of nCount Y vertices, modified in place.
z	array of nCount Z vertices, modified in place.

Returns

TRUE on success, or FALSE if some or all points fail to transform.

TransformEx()

virtual int OGRCoordinateTransformation::TransformEx ( int  nCount, double *  x, double *  y, double *  z = nullptr, int *  pabSuccess = nullptr  )

pure virtual

Transform points from source to destination space.

This method is the same as the C function OCTTransformEx().

Parameters

nCount	number of points to transform.
x	array of nCount X vertices, modified in place.
y	array of nCount Y vertices, modified in place.
z	array of nCount Z vertices, modified in place.
pabSuccess	array of per-point flags set to TRUE if that point transforms, or FALSE if it does not.

Returns

TRUE if some or all points transform successfully, or FALSE if if none transform.

---

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

• ogr_spatialref.h
• ogrct.cpp