QGIS API Documentation  3.15.0-Master (a49cb7c9f3)
Public Types | Public Member Functions | Static Public Member Functions | List of all members
QgsRasterProjector Class Reference

QgsRasterProjector implements approximate projection support for it calculates grid of points in source CRS for target CRS + extent which are used to calculate affine transformation matrices. More...

#include <qgsrasterprojector.h>

Inheritance diagram for QgsRasterProjector:
Inheritance graph
[legend]

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 Types inherited from QgsRasterInterface
enum  Capability {
  NoCapabilities = 0, Size = 1 << 1, Create = 1 << 2, Remove = 1 << 3,
  BuildPyramids = 1 << 4, Identify = 1 << 5, IdentifyValue = 1 << 6, IdentifyText = 1 << 7,
  IdentifyHtml = 1 << 8, IdentifyFeature = 1 << 9, Prefetch = 1 << 10
}
 If you add to this, please also add to capabilitiesString() More...
 

Public Member Functions

 QgsRasterProjector ()
 
int bandCount () const override
 Gets number of bands. More...
 
QgsRasterBlockblock (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override
 Read block of data using given extent and size. More...
 
QgsRasterProjectorclone () const override
 Clone itself, create deep copy. More...
 
Qgis::DataType dataType (int bandNo) const override
 Returns data type for the band specified by number. More...
 
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. More...
 
QgsCoordinateReferenceSystem destinationCrs () const
 Returns the destination CRS. More...
 
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. More...
 
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. More...
 
void setPrecision (Precision precision)
 
QgsCoordinateReferenceSystem sourceCrs () const
 Returns the source CRS. More...
 
- Public Member Functions inherited from QgsRasterInterface
 QgsRasterInterface (QgsRasterInterface *input=nullptr)
 
virtual ~QgsRasterInterface ()=default
 
virtual QgsRasterBandStats bandStatistics (int bandNo, int stats=QgsRasterBandStats::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr)
 Returns the band statistics. More...
 
virtual int capabilities () const
 Returns a bitmask containing the supported capabilities. More...
 
QString capabilitiesString () const
 Returns the raster interface capabilities in friendly format. More...
 
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. More...
 
int dataTypeSize (int bandNo)
 
virtual QgsRectangle extent () const
 Gets the extent of the interface. More...
 
virtual QString generateBandName (int bandNumber) const
 helper function to create zero padded band names More...
 
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) More...
 
virtual bool hasStatistics (int bandNo, int stats=QgsRasterBandStats::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0)
 Returns true if histogram is available (cached, already calculated). More...
 
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. More...
 
virtual QgsRasterInterfaceinput () const
 Current input. More...
 
virtual bool on () const
 Returns whether the interface is on or off. More...
 
virtual void readXml (const QDomElement &filterElem)
 Sets base class members from xml. Usually called from create() methods of subclasses. More...
 
virtual bool setInput (QgsRasterInterface *input)
 Set input. More...
 
virtual void setOn (bool on)
 Sets whether the interface is on or off. More...
 
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. More...
 
virtual const QgsRasterInterfacesourceInput () const
 Gets source / raw input, the first in pipe, usually provider. More...
 
virtual QgsRasterInterfacesourceInput ()
 Gets source / raw input, the first in pipe, usually provider. More...
 
virtual void writeXml (QDomDocument &doc, QDomElement &parentElem) const
 Write base class members to xml. More...
 
virtual int xBlockSize () const
 Gets block size. More...
 
virtual int xSize () const
 Gets raster size. More...
 
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. More...
 
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. More...
 
void initStatistics (QgsRasterBandStats &statistics, int bandNo, int stats=QgsRasterBandStats::All, const QgsRectangle &boundingBox=QgsRectangle(), int binCount=0)
 Fill in statistics defaults if not specified. More...
 
- Protected Attributes inherited from QgsRasterInterface
QList< QgsRasterHistogrammHistograms
 List of cached histograms, all bands mixed. More...
 
QgsRasterInterfacemInput = nullptr
 
bool mOn = true
 
QList< QgsRasterBandStatsmStatistics
 List of cached statistics, all bands mixed. More...
 

Detailed Description

QgsRasterProjector implements approximate projection support for it calculates grid of points in source CRS for target CRS + extent which are used to calculate affine transformation matrices.

Definition at line 47 of file qgsrasterprojector.h.

Member Enumeration Documentation

◆ 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 57 of file qgsrasterprojector.h.

Constructor & Destructor Documentation

◆ QgsRasterProjector()

Q_NOWARN_DEPRECATED_PUSH QgsRasterProjector::QgsRasterProjector ( )

Definition at line 26 of file qgsrasterprojector.cpp.

Member Function Documentation

◆ bandCount()

int QgsRasterProjector::bandCount ( ) const
overridevirtual

Gets number of bands.

Implements QgsRasterInterface.

Definition at line 51 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
bandNoband number
extentextent of block
widthpixel width of block
heightpixel height of block
feedbackoptional raster feedback object for cancellation/preview. Added in QGIS 3.0.

Implements QgsRasterInterface.

Definition at line 776 of file qgsrasterprojector.cpp.

◆ clone()

Q_NOWARN_DEPRECATED_POP QgsRasterProjector * QgsRasterProjector::clone ( ) const
overridevirtual

Clone itself, create deep copy.

Implements QgsRasterInterface.

Definition at line 34 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 58 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 892 of file qgsrasterprojector.cpp.

◆ destinationCrs()

QgsCoordinateReferenceSystem QgsRasterProjector::destinationCrs ( ) const
inline

Returns the destination CRS.

Definition at line 90 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 908 of file qgsrasterprojector.cpp.

◆ precision()

Precision QgsRasterProjector::precision ( ) const
inline

Definition at line 92 of file qgsrasterprojector.h.

◆ precisionLabel()

QString QgsRasterProjector::precisionLabel ( Precision  precision)
static

Definition at line 764 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:
since 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 93 of file qgsrasterprojector.h.

◆ sourceCrs()

QgsCoordinateReferenceSystem QgsRasterProjector::sourceCrs ( ) const
inline

Returns the source CRS.

Definition at line 87 of file qgsrasterprojector.h.


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