QGIS API Documentation
3.0.2-Girona (307d082)
|
Base class for processing filters like renderers, reprojector, resampler etc. More...
#include <qgsrasterinterface.h>
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 } |
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 |
Get number of bands. More... | |
virtual QgsRasterBandStats | bandStatistics (int bandNo, int stats=QgsRasterBandStats::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr) |
Get band statistics. More... | |
virtual QgsRasterBlock * | block (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 above in friendly format. More... | |
virtual QgsRasterInterface * | clone () const =0 |
Clone itself, create deep copy. 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) |
virtual QgsRectangle | extent () const |
Get 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) |
Get histogram. More... | |
virtual QgsRasterInterface * | input () 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 QgsRasterInterface * | sourceInput () const |
Get source / raw input, the first in pipe, usually provider. More... | |
virtual QgsRasterInterface * | sourceInput () |
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 |
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... | |
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 | |
QList< QgsRasterHistogram > | mHistograms |
List of cached histograms, all bands mixed. More... | |
QgsRasterInterface * | mInput = nullptr |
bool | mOn = true |
QList< QgsRasterBandStats > | mStatistics |
List of cached statistics, all bands mixed. More... | |
Base class for processing filters like renderers, reprojector, resampler etc.
Definition at line 97 of file qgsrasterinterface.h.
If you add to this, please also add to capabilitiesString()
Enumerator | |
---|---|
NoCapabilities | |
Size | |
Create | |
Remove | |
BuildPyramids | |
Identify | |
IdentifyValue | |
IdentifyText | |
IdentifyHtml | |
IdentifyFeature |
Definition at line 164 of file qgsrasterinterface.h.
QgsRasterInterface::QgsRasterInterface | ( | QgsRasterInterface * | input = nullptr | ) |
Definition at line 31 of file qgsrasterinterface.cpp.
|
virtualdefault |
|
pure virtual |
Get number of bands.
Implemented in QgsRasterProjector, QgsRasterRenderer, QgsHueSaturationFilter, QgsRasterNuller, QgsRasterResampleFilter, and QgsBrightnessContrastFilter.
|
virtual |
Get band statistics.
bandNo | The band (number). |
stats | Requested statistics |
extent | Extent used to calc statistics, if empty, whole raster extent is used. |
sampleSize | Approximate 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. |
feedback | optional feedback object |
Definition at line 115 of file qgsrasterinterface.cpp.
|
pure virtual |
Read block of data using given extent and size.
Returns pointer to data. Caller is responsible to free the memory returned.
bandNo | band number |
extent | extent of block |
width | pixel width of block |
height | pixel height of block |
feedback | optional raster feedback object for cancelation/preview. Added in QGIS 3.0. |
Implemented in QgsRasterDataProvider, QgsRasterProjector, QgsPalettedRasterRenderer, QgsRasterRenderer, QgsHillshadeRenderer, QgsHueSaturationFilter, QgsSingleBandGrayRenderer, QgsSingleBandPseudoColorRenderer, QgsMultiBandColorRenderer, QgsRasterNuller, QgsSingleBandColorDataRenderer, QgsRasterResampleFilter, and QgsBrightnessContrastFilter.
|
inlinevirtual |
Returns a bitmask containing the supported capabilities.
Definition at line 186 of file qgsrasterinterface.h.
QString QgsRasterInterface::capabilitiesString | ( | ) | const |
Returns the above in friendly format.
Definition at line 573 of file qgsrasterinterface.cpp.
|
pure virtual |
Clone itself, create deep copy.
Implemented in QgsRasterDataProvider, QgsPalettedRasterRenderer, QgsRasterProjector, QgsRasterRenderer, QgsHillshadeRenderer, QgsSingleBandGrayRenderer, QgsSingleBandPseudoColorRenderer, QgsHueSaturationFilter, QgsMultiBandColorRenderer, QgsRasterNuller, QgsSingleBandColorDataRenderer, QgsRasterResampleFilter, and QgsBrightnessContrastFilter.
|
virtual |
Find values for cumulative pixel count cut.
bandNo | The band (number). |
lowerCount | The lower count as fraction of 1, e.g. 0.02 = 2% |
upperCount | The upper count as fraction of 1, e.g. 0.98 = 98% |
lowerValue | Location into which the lower value will be set. |
upperValue | Location into which the upper value will be set. |
extent | Extent used to calc histogram, if empty, whole raster extent is used. |
sampleSize | Approximate 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 511 of file qgsrasterinterface.cpp.
|
pure virtual |
Returns data type for the band specified by number.
Implemented in QgsRasterDataProvider, QgsRasterProjector, QgsRasterRenderer, QgsHueSaturationFilter, QgsRasterNuller, QgsRasterResampleFilter, and QgsBrightnessContrastFilter.
|
inline |
Definition at line 210 of file qgsrasterinterface.h.
|
inlinevirtual |
Get the extent of the interface.
Reimplemented in QgsRasterDataProvider.
Definition at line 208 of file qgsrasterinterface.h.
|
inlinevirtual |
helper function to create zero padded band names
Definition at line 224 of file qgsrasterinterface.h.
|
virtual |
Returns true if histogram is available (cached, already calculated)
Definition at line 367 of file qgsrasterinterface.cpp.
|
virtual |
Returns true if histogram is available (cached, already calculated).
Definition at line 93 of file qgsrasterinterface.cpp.
|
virtual |
Get histogram.
Histograms are cached in providers.
bandNo | The band (number). |
binCount | Number of bins (intervals,buckets). If 0, the number of bins is decided automatically according to data type, raster size etc. |
minimum | Minimum value, if NaN (None for Python), raster minimum value will be used. |
maximum | Maximum value, if NaN (None for Python), raster maximum value will be used. |
extent | Extent used to calc histogram, if empty, whole raster extent is used. |
sampleSize | Approximate 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. |
includeOutOfRange | include out of range values |
feedback | optional feedback object |
Definition at line 393 of file qgsrasterinterface.cpp.
|
protected |
Fill in histogram defaults if not specified.
Definition at line 246 of file qgsrasterinterface.cpp.
|
protected |
Fill in statistics defaults if not specified.
Definition at line 36 of file qgsrasterinterface.cpp.
|
inlinevirtual |
Current input.
Definition at line 247 of file qgsrasterinterface.h.
|
inlinevirtual |
Is on/off.
Definition at line 250 of file qgsrasterinterface.h.
|
inlinevirtual |
Sets base class members from xml. Usually called from create() methods of subclasses.
Reimplemented in QgsRasterRenderer, QgsHueSaturationFilter, QgsRasterResampleFilter, and QgsBrightnessContrastFilter.
Definition at line 442 of file qgsrasterinterface.h.
|
inlinevirtual |
Set input.
Returns true if set correctly, false if cannot use that input
Reimplemented in QgsRasterDataProvider, QgsRasterRenderer, QgsHueSaturationFilter, QgsSingleBandColorDataRenderer, QgsRasterResampleFilter, and QgsBrightnessContrastFilter.
Definition at line 244 of file qgsrasterinterface.h.
|
inlinevirtual |
Set on/off.
Definition at line 253 of file qgsrasterinterface.h.
|
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 202 of file qgsrasterinterface.h.
|
inlinevirtual |
Get 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 261 of file qgsrasterinterface.h.
|
inlinevirtual |
Get 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 272 of file qgsrasterinterface.h.
|
inlinevirtual |
Write base class members to xml.
Reimplemented in QgsPalettedRasterRenderer, QgsSingleBandPseudoColorRenderer, QgsMultiBandColorRenderer, QgsHueSaturationFilter, QgsSingleBandGrayRenderer, QgsHillshadeRenderer, QgsRasterResampleFilter, QgsBrightnessContrastFilter, and QgsSingleBandColorDataRenderer.
Definition at line 440 of file qgsrasterinterface.h.
|
inlinevirtual |
Get block size.
Definition at line 216 of file qgsrasterinterface.h.
|
inlinevirtual |
Get raster size.
Definition at line 220 of file qgsrasterinterface.h.
|
inlinevirtual |
Definition at line 217 of file qgsrasterinterface.h.
|
inlinevirtual |
Definition at line 221 of file qgsrasterinterface.h.
|
protected |
List of cached histograms, all bands mixed.
Definition at line 452 of file qgsrasterinterface.h.
|
protected |
Definition at line 446 of file qgsrasterinterface.h.
|
protected |
Definition at line 455 of file qgsrasterinterface.h.
|
protected |
List of cached statistics, all bands mixed.
Definition at line 449 of file qgsrasterinterface.h.