QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsRasterInterface Class Referenceabstract

Base class for processing filters like renderers, reprojector, resampler etc. More...

#include <qgsrasterinterface.h>

Inheritance diagram for QgsRasterInterface:
Inheritance graph
[legend]

Public Types

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

 QgsRasterInterface (QgsRasterInterface *input=nullptr)
 
virtual ~QgsRasterInterface ()=default
 
virtual int bandCount () const =0
 Gets number of bands. More...
 
Q_DECL_DEPRECATED QgsRasterBandStats bandStatistics (int bandNo, int stats, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr)
 Returns the band statistics. More...
 
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. More...
 
virtual QgsRasterBlockblock (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr)=0
 Read block of data using given extent and size. 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 QgsRasterInterfaceclone () const =0
 Clone itself, create deep copy. More...
 
virtual QString colorInterpretationName (int bandNumber) const
 Returns the name of the color interpretation for the specified bandNumber. 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...
 
virtual Qgis::DataType dataType (int bandNo) const =0
 Returns data type for the band specified by number. More...
 
int dataTypeSize (int bandNo) const
 Returns the size (in bytes) for the data type for the specified band. More...
 
QString displayBandName (int bandNumber) const
 Generates a friendly, descriptive name for the specified bandNumber. More...
 
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...
 
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). More...
 
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). 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 QgsRasterInterfacesourceInput ()
 Gets source / raw input, the first in pipe, usually provider. More...
 
virtual const QgsRasterInterfacesourceInput () const
 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
 

Protected Member Functions

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...
 
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. More...
 
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. More...
 

Protected Attributes

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

Base class for processing filters like renderers, reprojector, resampler etc.

Definition at line 135 of file qgsrasterinterface.h.

Member Enumeration Documentation

◆ Capability

If you add to this, please also add to capabilitiesString()

Enumerator
NoCapabilities 
Size 

Original data source size (and thus resolution) is known, it is not always available, for example for WMS.

Create 

Create new datasets.

Remove 

Delete datasets.

BuildPyramids 

Supports building of pyramids (overviews)

Identify 

At least one identify format supported.

IdentifyValue 

Numerical values.

IdentifyText 

WMS text.

IdentifyHtml 

WMS HTML.

IdentifyFeature 

WMS GML -> feature.

Prefetch 

Allow prefetching of out-of-view images.

Definition at line 205 of file qgsrasterinterface.h.

Constructor & Destructor Documentation

◆ QgsRasterInterface()

QgsRasterInterface::QgsRasterInterface ( QgsRasterInterface input = nullptr)

Definition at line 31 of file qgsrasterinterface.cpp.

◆ ~QgsRasterInterface()

virtual QgsRasterInterface::~QgsRasterInterface ( )
virtualdefault

Member Function Documentation

◆ bandCount()

virtual int QgsRasterInterface::bandCount ( ) const
pure virtual

◆ bandStatistics() [1/2]

QgsRasterBandStats QgsRasterInterface::bandStatistics ( int  bandNo,
int  stats,
const QgsRectangle extent = QgsRectangle(),
int  sampleSize = 0,
QgsRasterBlockFeedback feedback = nullptr 
)

Returns the band statistics.

Parameters
bandNoThe band (number).
statsRequested statistics
extentExtent used to calc statistics, if empty, whole raster extent is used.
sampleSizeApproximate number of cells in sample. If 0, all cells (whole raster will be used). If raster does not have exact size (WCS without exact size for example), provider decides size of sample.
feedbackoptional feedback object
Deprecated:
Use Qgis::RasterBandStatistic instead of int for stats argument

Definition at line 657 of file qgsrasterinterface.cpp.

◆ bandStatistics() [2/2]

QgsRasterBandStats QgsRasterInterface::bandStatistics ( int  bandNo,
Qgis::RasterBandStatistics  stats = Qgis::RasterBandStatistic::All,
const QgsRectangle extent = QgsRectangle(),
int  sampleSize = 0,
QgsRasterBlockFeedback feedback = nullptr 
)
virtual

Returns the band statistics.

Parameters
bandNoThe band (number).
statsRequested statistics
extentExtent used to calc statistics, if empty, whole raster extent is used.
sampleSizeApproximate number of cells in sample. If 0, all cells (whole raster will be used). If raster does not have exact size (WCS without exact size for example), provider decides size of sample.
feedbackoptional feedback object

Definition at line 116 of file qgsrasterinterface.cpp.

◆ block()

virtual QgsRasterBlock* QgsRasterInterface::block ( int  bandNo,
const QgsRectangle extent,
int  width,
int  height,
QgsRasterBlockFeedback feedback = nullptr 
)
pure virtual

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.

Implemented in QgsRasterRenderer, QgsSingleBandPseudoColorRenderer, QgsSingleBandGrayRenderer, QgsSingleBandColorDataRenderer, QgsRasterResampleFilter, QgsRasterProjector, QgsRasterNuller, QgsRasterContourRenderer, QgsPalettedRasterRenderer, QgsMultiBandColorRenderer, QgsHueSaturationFilter, QgsHillshadeRenderer, QgsBrightnessContrastFilter, and QgsRasterDataProvider.

◆ capabilities()

virtual int QgsRasterInterface::capabilities ( ) const
inlinevirtual

Returns a bitmask containing the supported capabilities.

Definition at line 228 of file qgsrasterinterface.h.

◆ capabilitiesString()

QString QgsRasterInterface::capabilitiesString ( ) const

Returns the raster interface capabilities in friendly format.

Definition at line 594 of file qgsrasterinterface.cpp.

◆ clone()

virtual QgsRasterInterface* QgsRasterInterface::clone ( ) const
pure virtual

◆ colorInterpretationName()

QString QgsRasterInterface::colorInterpretationName ( int  bandNumber) const
virtual

Returns the name of the color interpretation for the specified bandNumber.

Since
QGIS 3.18

Reimplemented in QgsRasterDataProvider.

Definition at line 638 of file qgsrasterinterface.cpp.

◆ cumulativeCut()

void QgsRasterInterface::cumulativeCut ( int  bandNo,
double  lowerCount,
double  upperCount,
double &  lowerValue,
double &  upperValue,
const QgsRectangle extent = QgsRectangle(),
int  sampleSize = 0 
)
virtual

Find values for cumulative pixel count cut.

Parameters
bandNoThe band (number).
lowerCountThe lower count as fraction of 1, e.g. 0.02 = 2%
upperCountThe upper count as fraction of 1, e.g. 0.98 = 98%
lowerValueLocation into which the lower value will be set.
upperValueLocation into which the upper value will be set.
extentExtent used to calc histogram, if empty, whole raster extent is used.
sampleSizeApproximate number of cells in sample. If 0, all cells (whole raster will be used). If raster does not have exact size (WCS without exact size for example), provider decides size of sample.

Definition at line 532 of file qgsrasterinterface.cpp.

◆ dataType()

virtual Qgis::DataType QgsRasterInterface::dataType ( int  bandNo) const
pure virtual

◆ dataTypeSize()

int QgsRasterInterface::dataTypeSize ( int  bandNo) const
inline

Returns the size (in bytes) for the data type for the specified band.

Definition at line 256 of file qgsrasterinterface.h.

◆ displayBandName()

QString QgsRasterInterface::displayBandName ( int  bandNumber) const

Generates a friendly, descriptive name for the specified bandNumber.

Since
QGIS 3.18

Definition at line 646 of file qgsrasterinterface.cpp.

◆ extent()

virtual QgsRectangle QgsRasterInterface::extent ( ) const
inlinevirtual

Gets the extent of the interface.

Returns
QgsRectangle containing the extent of the layer

Reimplemented in QgsRasterDataProvider.

Definition at line 251 of file qgsrasterinterface.h.

◆ generateBandName()

QString QgsRasterInterface::generateBandName ( int  bandNumber) const
virtual

helper function to create zero padded band names

Definition at line 629 of file qgsrasterinterface.cpp.

◆ hasHistogram()

bool QgsRasterInterface::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 
)
virtual

Returns true if histogram is available (cached, already calculated)

Note
the parameters are the same as in
See also
histogram()

Definition at line 386 of file qgsrasterinterface.cpp.

◆ hasStatistics() [1/2]

bool QgsRasterInterface::hasStatistics ( int  bandNo,
int  stats,
const QgsRectangle extent = QgsRectangle(),
int  sampleSize = 0 
)

Returns true if histogram is available (cached, already calculated).

The parameters are the same as in bandStatistics()

Returns
true if statistics are available (ready to use)
Deprecated:
Use Qgis::RasterBandStatistic instead of int for stats argument

Definition at line 249 of file qgsrasterinterface.cpp.

◆ hasStatistics() [2/2]

bool QgsRasterInterface::hasStatistics ( int  bandNo,
Qgis::RasterBandStatistics  stats = Qgis::RasterBandStatistic::All,
const QgsRectangle extent = QgsRectangle(),
int  sampleSize = 0 
)
virtual

Returns true if histogram is available (cached, already calculated).

The parameters are the same as in bandStatistics()

Returns
true if statistics are available (ready to use)

Definition at line 93 of file qgsrasterinterface.cpp.

◆ histogram()

QgsRasterHistogram QgsRasterInterface::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 
)
virtual

Returns a band histogram.

Histograms are cached in providers.

Parameters
bandNoThe band (number).
binCountNumber of bins (intervals,buckets). If 0, the number of bins is decided automatically according to data type, raster size etc.
minimumMinimum value, if NaN (None for Python), raster minimum value will be used.
maximumMaximum value, if NaN (None for Python), raster maximum value will be used.
extentExtent used to calc histogram, if empty, whole raster extent is used.
sampleSizeApproximate number of cells in sample. If 0, all cells (whole raster will be used). If raster does not have exact size (WCS without exact size for example), provider decides size of sample.
includeOutOfRangeinclude out of range values
feedbackoptional feedback object
Returns
Vector of non NULL cell counts for each bin.
Note
binCount, minimum and maximum not optional in Python bindings

Definition at line 413 of file qgsrasterinterface.cpp.

◆ initHistogram()

void QgsRasterInterface::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 
)
protected

Fill in histogram defaults if not specified.

Note
the parameters are the same as in
See also
histogram()

Definition at line 254 of file qgsrasterinterface.cpp.

◆ initStatistics() [1/2]

void QgsRasterInterface::initStatistics ( QgsRasterBandStats statistics,
int  bandNo,
int  stats,
const QgsRectangle boundingBox = QgsRectangle(),
int  binCount = 0 
) const
protected

Fill in statistics defaults if not specified.

Deprecated:
Use Qgis::RasterBandStatistic instead of int for stats argument

Definition at line 381 of file qgsrasterinterface.cpp.

◆ initStatistics() [2/2]

void QgsRasterInterface::initStatistics ( QgsRasterBandStats statistics,
int  bandNo,
Qgis::RasterBandStatistics  stats = Qgis::RasterBandStatistic::All,
const QgsRectangle boundingBox = QgsRectangle(),
int  binCount = 0 
) const
protected

Fill in statistics defaults if not specified.

Definition at line 36 of file qgsrasterinterface.cpp.

◆ input()

virtual QgsRasterInterface* QgsRasterInterface::input ( ) const
inlinevirtual

Current input.

Definition at line 305 of file qgsrasterinterface.h.

◆ on()

virtual bool QgsRasterInterface::on ( ) const
inlinevirtual

Returns whether the interface is on or off.

Definition at line 308 of file qgsrasterinterface.h.

◆ readXml()

virtual void QgsRasterInterface::readXml ( const QDomElement &  filterElem)
inlinevirtual

Sets base class members from xml. Usually called from create() methods of subclasses.

Reimplemented in QgsRasterRenderer, QgsRasterResampleFilter, QgsRasterDataProvider, QgsHueSaturationFilter, and QgsBrightnessContrastFilter.

Definition at line 519 of file qgsrasterinterface.h.

◆ setInput()

virtual bool QgsRasterInterface::setInput ( QgsRasterInterface input)
inlinevirtual

Set input.

Returns true if set correctly, false if cannot use that input

Reimplemented in QgsSingleBandColorDataRenderer, QgsRasterResampleFilter, QgsRasterRenderer, QgsRasterDataProvider, QgsHueSaturationFilter, and QgsBrightnessContrastFilter.

Definition at line 302 of file qgsrasterinterface.h.

◆ setOn()

virtual void QgsRasterInterface::setOn ( bool  on)
inlinevirtual

Sets whether the interface is on or off.

Definition at line 311 of file qgsrasterinterface.h.

◆ sourceDataType()

virtual Qgis::DataType QgsRasterInterface::sourceDataType ( int  bandNo) const
inlinevirtual

Returns source data type for the band specified by number, source data type may be shorter than dataType.

Reimplemented in QgsRasterDataProvider.

Definition at line 245 of file qgsrasterinterface.h.

◆ sourceInput() [1/2]

virtual QgsRasterInterface* QgsRasterInterface::sourceInput ( )
inlinevirtual

Gets source / raw input, the first in pipe, usually provider.

It may be used to get info about original data, e.g. resolution to decide resampling etc.

Definition at line 330 of file qgsrasterinterface.h.

◆ sourceInput() [2/2]

virtual const QgsRasterInterface* QgsRasterInterface::sourceInput ( ) const
inlinevirtual

Gets source / raw input, the first in pipe, usually provider.

It may be used to get info about original data, e.g. resolution to decide resampling etc.

Note
not available in Python bindings.

Definition at line 319 of file qgsrasterinterface.h.

◆ writeXml()

virtual void QgsRasterInterface::writeXml ( QDomDocument &  doc,
QDomElement &  parentElem 
) const
inlinevirtual

◆ xBlockSize()

virtual int QgsRasterInterface::xBlockSize ( ) const
inlinevirtual

Gets block size.

Definition at line 262 of file qgsrasterinterface.h.

◆ xSize()

virtual int QgsRasterInterface::xSize ( ) const
inlinevirtual

Gets raster size.

Definition at line 266 of file qgsrasterinterface.h.

◆ yBlockSize()

virtual int QgsRasterInterface::yBlockSize ( ) const
inlinevirtual

Definition at line 263 of file qgsrasterinterface.h.

◆ ySize()

virtual int QgsRasterInterface::ySize ( ) const
inlinevirtual

Definition at line 267 of file qgsrasterinterface.h.

Member Data Documentation

◆ mHistograms

QList<QgsRasterHistogram> QgsRasterInterface::mHistograms
protected

List of cached histograms, all bands mixed.

Definition at line 529 of file qgsrasterinterface.h.

◆ mInput

QgsRasterInterface* QgsRasterInterface::mInput = nullptr
protected

Definition at line 523 of file qgsrasterinterface.h.

◆ mOn

bool QgsRasterInterface::mOn = true
protected

Definition at line 532 of file qgsrasterinterface.h.

◆ mStatistics

QList<QgsRasterBandStats> QgsRasterInterface::mStatistics
protected

List of cached statistics, all bands mixed.

Definition at line 526 of file qgsrasterinterface.h.


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