QGIS API Documentation  2.99.0-Master (8ec3eaf)
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
}
 If you add to this, please also add to capabilitiesString() More...
 

Public Member Functions

 QgsRasterProjector ()
 
 ~QgsRasterProjector ()
 The destructor. More...
 
int bandCount () const override
 Get 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 &theSrcExtent, int theSrcXSize, int theSrcYSize, QgsRectangle &theDestExtent, int &theDestXSize, int &theDestYSize)
 Calculate destination extent and size from source extent and size. More...
 
QgsCoordinateReferenceSystem destinationCrs () const
 Get destination CRS. More...
 
Precision precision () const
 
void setCrs (const QgsCoordinateReferenceSystem &theSrcCRS, const QgsCoordinateReferenceSystem &theDestCRS, int srcDatumTransform=-1, int destDatumTransform=-1)
 set source and destination CRS More...
 
void setPrecision (Precision precision)
 
QgsCoordinateReferenceSystem sourceCrs () const
 Get source CRS. More...
 
- Public Member Functions inherited from QgsRasterInterface
 QgsRasterInterface (QgsRasterInterface *input=nullptr)
 
virtual ~QgsRasterInterface ()
 
virtual QgsRasterBandStats bandStatistics (int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
 Get band statistics. More...
 
virtual int capabilities () const
 Returns a bitmask containing the supported capabilities. More...
 
QString capabilitiesString () const
 Returns the above in friendly format. More...
 
virtual void cumulativeCut (int theBandNo, double theLowerCount, double theUpperCount, double &theLowerValue, double &theUpperValue, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
 Find values for cumulative pixel count cut. More...
 
int dataTypeSize (int bandNo)
 
virtual QgsRectangle extent () const
 Get the extent of the interface. More...
 
virtual QString generateBandName (int theBandNumber) const
 helper function to create zero padded band names More...
 
virtual bool hasHistogram (int theBandNo, int theBinCount, double theMinimum=std::numeric_limits< double >::quiet_NaN(), double theMaximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0, bool theIncludeOutOfRange=false)
 Returns true if histogram is available (cached, already calculated), the parameters are the same as in histogram() More...
 
virtual bool hasStatistics (int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
 Returns true if histogram is available (cached, already calculated). More...
 
virtual QgsRasterHistogram histogram (int theBandNo, int theBinCount=0, double theMinimum=std::numeric_limits< double >::quiet_NaN(), double theMaximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0, bool theIncludeOutOfRange=false)
 Get histogram. More...
 
virtual QgsRasterInterfaceinput () const
 Current input. More...
 
virtual bool on () const
 Is on/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)
 Set on/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
 Get source / raw input, the first in pipe, usually provider. More...
 
virtual QgsRasterInterfacesourceInput ()
 Get 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
 Get block size. More...
 
virtual int xSize () const
 Get raster size. More...
 
virtual int yBlockSize () const
 
virtual int ySize () const
 

Static Public Member Functions

static bool extentSize (const QgsCoordinateTransform &ct, const QgsRectangle &theSrcExtent, int theSrcXSize, int theSrcYSize, QgsRectangle &theDestExtent, int &theDestXSize, int &theDestYSize)
 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 &theHistogram, int theBandNo, int theBinCount=0, double theMinimum=std::numeric_limits< double >::quiet_NaN(), double theMaximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0, bool theIncludeOutOfRange=false)
 Fill in histogram defaults if not specified. More...
 
void initStatistics (QgsRasterBandStats &theStatistics, int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theBinCount=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
 
bool mOn
 
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 44 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 51 of file qgsrasterprojector.h.

Constructor & Destructor Documentation

§ QgsRasterProjector()

QgsRasterProjector::QgsRasterProjector ( )

Definition at line 27 of file qgsrasterprojector.cpp.

§ ~QgsRasterProjector()

QgsRasterProjector::~QgsRasterProjector ( )

The destructor.

Definition at line 49 of file qgsrasterprojector.cpp.

Member Function Documentation

§ bandCount()

int QgsRasterProjector::bandCount ( ) const
overridevirtual

Get number of bands.

Implements QgsRasterInterface.

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

§ clone()

QgsRasterProjector * QgsRasterProjector::clone ( ) const
overridevirtual

Clone itself, create deep copy.

Implements QgsRasterInterface.

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

§ destExtentSize()

bool QgsRasterProjector::destExtentSize ( const QgsRectangle theSrcExtent,
int  theSrcXSize,
int  theSrcYSize,
QgsRectangle theDestExtent,
int &  theDestXSize,
int &  theDestYSize 
)

Calculate destination extent and size from source extent and size.

Definition at line 861 of file qgsrasterprojector.cpp.

§ destinationCrs()

QgsCoordinateReferenceSystem QgsRasterProjector::destinationCrs ( ) const
inline

Get destination CRS.

Definition at line 76 of file qgsrasterprojector.h.

§ extentSize()

bool QgsRasterProjector::extentSize ( const QgsCoordinateTransform ct,
const QgsRectangle theSrcExtent,
int  theSrcXSize,
int  theSrcYSize,
QgsRectangle theDestExtent,
int &  theDestXSize,
int &  theDestYSize 
)
static

Calculate destination extent and size from source extent and size.

Definition at line 873 of file qgsrasterprojector.cpp.

§ precision()

Precision QgsRasterProjector::precision ( ) const
inline

Definition at line 78 of file qgsrasterprojector.h.

§ precisionLabel()

QString QgsRasterProjector::precisionLabel ( Precision  precision)
static

Definition at line 736 of file qgsrasterprojector.cpp.

§ setCrs()

void QgsRasterProjector::setCrs ( const QgsCoordinateReferenceSystem theSrcCRS,
const QgsCoordinateReferenceSystem theDestCRS,
int  srcDatumTransform = -1,
int  destDatumTransform = -1 
)

set source and destination CRS

§ setPrecision()

void QgsRasterProjector::setPrecision ( Precision  precision)
inline

Definition at line 79 of file qgsrasterprojector.h.

§ sourceCrs()

QgsCoordinateReferenceSystem QgsRasterProjector::sourceCrs ( ) const
inline

Get source CRS.

Definition at line 73 of file qgsrasterprojector.h.


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