Implements approximate projection support for optimised raster transformation. More...

#include <qgsrasterprojector.h>

Inheritance diagram for QgsRasterProjector:

Public Types
enum	Precision { Approximate = 0 , Exact = 1 }
	Precision defines if each pixel is reprojected or approximate reprojection based on an approximation matrix of reprojected points is used. More...

Public Member Functions
	QgsRasterProjector ()

int	bandCount () const override
	Gets number of bands.

QgsRasterBlock *	block (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override
	Read block of data using given extent and size.

QgsRasterProjector *	clone () const override
	Clone itself, create deep copy.

Qgis::DataType	dataType (int bandNo) const override
	Returns data type for the band specified by number.

bool	destExtentSize (const QgsRectangle &srcExtent, int srcXSize, int srcYSize, QgsRectangle &destExtent, int &destXSize, int &destYSize)
	Calculate destination extent and size from source extent and size.

QgsCoordinateReferenceSystem	destinationCrs () const
	Returns the destination CRS.

Precision	precision () const

Q_DECL_DEPRECATED void	setCrs (const QgsCoordinateReferenceSystem &srcCRS, const QgsCoordinateReferenceSystem &destCRS, int srcDatumTransform=-1, int destDatumTransform=-1)
	Sets the source and destination CRS.

void	setCrs (const QgsCoordinateReferenceSystem &srcCRS, const QgsCoordinateReferenceSystem &destCRS, QgsCoordinateTransformContext transformContext)
	Sets source CRS to srcCRS and destination CRS to destCRS and the transformation context to transformContext.

void	setPrecision (Precision precision)

QgsCoordinateReferenceSystem	sourceCrs () const
	Returns the source CRS.

Public Member Functions inherited from QgsRasterInterface
	QgsRasterInterface (QgsRasterInterface *input=nullptr)

virtual	~QgsRasterInterface ()=default

Q_DECL_DEPRECATED QgsRasterBandStats	bandStatistics (int bandNo, int stats, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr)
	Returns the band statistics.

virtual QgsRasterBandStats	bandStatistics (int bandNo, Qgis::RasterBandStatistics stats=Qgis::RasterBandStatistic::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr)
	Returns the band statistics.

virtual Qgis::RasterInterfaceCapabilities	capabilities () const
	Returns the capabilities supported by the interface.

Q_DECL_DEPRECATED QString	capabilitiesString () const
	Returns the raster interface capabilities in friendly format.

virtual QString	colorInterpretationName (int bandNumber) const
	Returns the name of the color interpretation for the specified bandNumber.

virtual void	cumulativeCut (int bandNo, double lowerCount, double upperCount, double &lowerValue, double &upperValue, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0)
	Find values for cumulative pixel count cut.

int	dataTypeSize (int bandNo) const
	Returns the size (in bytes) for the data type for the specified band.

QString	displayBandName (int bandNumber) const
	Generates a friendly, descriptive name for the specified bandNumber.

virtual QgsRectangle	extent () const
	Gets the extent of the interface.

virtual QString	generateBandName (int bandNumber) const
	helper function to create zero padded band names

virtual bool	hasHistogram (int bandNo, int binCount, double minimum=std::numeric_limits< double >::quiet_NaN(), double maximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, bool includeOutOfRange=false)
	Returns `true` if histogram is available (cached, already calculated)

Q_DECL_DEPRECATED bool	hasStatistics (int bandNo, int stats, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0)
	Returns `true` if histogram is available (cached, already calculated).

virtual bool	hasStatistics (int bandNo, Qgis::RasterBandStatistics stats=Qgis::RasterBandStatistic::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0)
	Returns `true` if histogram is available (cached, already calculated).

virtual QgsRasterHistogram	histogram (int bandNo, int binCount=0, double minimum=std::numeric_limits< double >::quiet_NaN(), double maximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, bool includeOutOfRange=false, QgsRasterBlockFeedback *feedback=nullptr)
	Returns a band histogram.

virtual QgsRasterInterface *	input () const
	Current input.

virtual bool	on () const
	Returns whether the interface is on or off.

virtual void	readXml (const QDomElement &filterElem)
	Sets base class members from xml. Usually called from create() methods of subclasses.

virtual bool	setInput (QgsRasterInterface *input)
	Set input.

virtual void	setOn (bool on)
	Sets whether the interface is on or off.

virtual Qgis::DataType	sourceDataType (int bandNo) const
	Returns source data type for the band specified by number, source data type may be shorter than dataType.

virtual QgsRasterInterface *	sourceInput ()
	Gets source / raw input, the first in pipe, usually provider.

virtual const QgsRasterInterface *	sourceInput () const
	Gets source / raw input, the first in pipe, usually provider.

virtual void	writeXml (QDomDocument &doc, QDomElement &parentElem) const
	Write base class members to xml.

virtual int	xBlockSize () const
	Gets block size.

virtual int	xSize () const
	Gets raster size.

virtual int	yBlockSize () const

virtual int	ySize () const

Static Public Member Functions
static bool	extentSize (const QgsCoordinateTransform &ct, const QgsRectangle &srcExtent, int srcXSize, int srcYSize, QgsRectangle &destExtent, int &destXSize, int &destYSize)
	Calculate destination extent and size from source extent and size.

static QString	precisionLabel (Precision precision)

Additional Inherited Members
Protected Member Functions inherited from QgsRasterInterface
void	initHistogram (QgsRasterHistogram &histogram, int bandNo, int binCount, double minimum=std::numeric_limits< double >::quiet_NaN(), double maximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &boundingBox=QgsRectangle(), int sampleSize=0, bool includeOutOfRange=false)
	Fill in histogram defaults if not specified.

Q_DECL_DEPRECATED void	initStatistics (QgsRasterBandStats &statistics, int bandNo, int stats, const QgsRectangle &boundingBox=QgsRectangle(), int binCount=0) const
	Fill in statistics defaults if not specified.

void	initStatistics (QgsRasterBandStats &statistics, int bandNo, Qgis::RasterBandStatistics stats=Qgis::RasterBandStatistic::All, const QgsRectangle &boundingBox=QgsRectangle(), int binCount=0) const
	Fill in statistics defaults if not specified.

Protected Attributes inherited from QgsRasterInterface
QList< QgsRasterHistogram >	mHistograms
	List of cached histograms, all bands mixed.

QgsRasterInterface *	mInput = nullptr

bool	mOn = true

QList< QgsRasterBandStats >	mStatistics
	List of cached statistics, all bands mixed.

Detailed Description

Implements approximate projection support for optimised raster transformation.

QgsRasterProjector calculates a grid of points in the source CRS for a specific target CRS and extent. These are used to calculate affine transformation matrices, which can be used instead of raw PROJ transformations for optimised bulk reprojection of points.

Definition at line 50 of file qgsrasterprojector.h.

Member Enumeration Documentation

◆ Precision

enum QgsRasterProjector::Precision

Precision defines if each pixel is reprojected or approximate reprojection based on an approximation matrix of reprojected points is used.

Enumerator
Approximate	Approximate (default), fast but possibly inaccurate.
Exact	Exact, precise but slow.

Definition at line 60 of file qgsrasterprojector.h.

Constructor & Destructor Documentation

◆ QgsRasterProjector()

Q_NOWARN_DEPRECATED_PUSH QgsRasterProjector::QgsRasterProjector ( )

Definition at line 27 of file qgsrasterprojector.cpp.

Member Function Documentation

◆ bandCount()

int QgsRasterProjector::bandCount ( ) const

overridevirtual

Gets number of bands.

Implements QgsRasterInterface.

Definition at line 52 of file qgsrasterprojector.cpp.

◆ block()

QgsRasterBlock * QgsRasterProjector::block	(	int	bandNo,
		const QgsRectangle &	extent,
		int	width,
		int	height,
		QgsRasterBlockFeedback *	feedback = `nullptr`
	)

overridevirtual

Read block of data using given extent and size.

Returns pointer to data. Caller is responsible to free the memory returned.

Parameters

bandNo	band number
extent	extent of block
width	pixel width of block
height	pixel height of block
feedback	optional raster feedback object for cancellation/preview. Added in QGIS 3.0.

Implements QgsRasterInterface.

Definition at line 809 of file qgsrasterprojector.cpp.

◆ clone()

Q_NOWARN_DEPRECATED_POP QgsRasterProjector * QgsRasterProjector::clone ( ) const

overridevirtual

Clone itself, create deep copy.

Implements QgsRasterInterface.

Definition at line 35 of file qgsrasterprojector.cpp.

◆ dataType()

Qgis::DataType QgsRasterProjector::dataType ( int bandNo ) const

overridevirtual

Returns data type for the band specified by number.

Implements QgsRasterInterface.

Definition at line 59 of file qgsrasterprojector.cpp.

◆ destExtentSize()

bool QgsRasterProjector::destExtentSize	(	const QgsRectangle &	srcExtent,
		int	srcXSize,
		int	srcYSize,
		QgsRectangle &	destExtent,
		int &	destXSize,
		int &	destYSize
	)

Calculate destination extent and size from source extent and size.

Definition at line 925 of file qgsrasterprojector.cpp.

◆ destinationCrs()

QgsCoordinateReferenceSystem QgsRasterProjector::destinationCrs ( ) const

inline

Returns the destination CRS.

Definition at line 93 of file qgsrasterprojector.h.

◆ extentSize()

bool QgsRasterProjector::extentSize	(	const QgsCoordinateTransform &	ct,
		const QgsRectangle &	srcExtent,
		int	srcXSize,
		int	srcYSize,
		QgsRectangle &	destExtent,
		int &	destXSize,
		int &	destYSize
	)

static

Calculate destination extent and size from source extent and size.

Definition at line 941 of file qgsrasterprojector.cpp.

◆ precision()

Precision QgsRasterProjector::precision ( ) const

inline

Definition at line 95 of file qgsrasterprojector.h.

◆ precisionLabel()

QString QgsRasterProjector::precisionLabel ( Precision precision )

static

Definition at line 797 of file qgsrasterprojector.cpp.

◆ setCrs() [1/2]

Q_DECL_DEPRECATED void QgsRasterProjector::setCrs	(	const QgsCoordinateReferenceSystem &	srcCRS,
		const QgsCoordinateReferenceSystem &	destCRS,
		int	srcDatumTransform = `-1`,
		int	destDatumTransform = `-1`
	)

Sets the source and destination CRS.

Deprecated:: QGIS 3.8. Use transformContext version instead.

◆ setCrs() [2/2]

void QgsRasterProjector::setCrs	(	const QgsCoordinateReferenceSystem &	srcCRS,
		const QgsCoordinateReferenceSystem &	destCRS,
		QgsCoordinateTransformContext	transformContext
	)

Sets source CRS to srcCRS and destination CRS to destCRS and the transformation context to transformContext.

Since: QGIS 3.8

◆ setPrecision()

void QgsRasterProjector::setPrecision ( Precision precision )

inline

Definition at line 96 of file qgsrasterprojector.h.

◆ sourceCrs()

QgsCoordinateReferenceSystem QgsRasterProjector::sourceCrs ( ) const

inline

Returns the source CRS.

Definition at line 90 of file qgsrasterprojector.h.

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

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/raster/qgsrasterprojector.h
/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/raster/qgsrasterprojector.cpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Precision

Constructor & Destructor Documentation

◆ QgsRasterProjector()

Member Function Documentation

◆ bandCount()

◆ block()

◆ clone()

◆ dataType()

◆ destExtentSize()

◆ destinationCrs()

◆ extentSize()

◆ precision()

◆ precisionLabel()

◆ setCrs() [1/2]

◆ setCrs() [2/2]

◆ setPrecision()

◆ sourceCrs()