QGIS API Documentation 3.39.0-Master (8f4da32b6b8)
|
Raster renderer pipe that applies colors to a raster. More...
#include <qgsrasterrenderer.h>
Public Member Functions | |
QgsRasterRenderer (const QgsRasterRenderer &)=delete | |
QgsRasterRenderer cannot be copied. Use clone() instead. | |
QgsRasterRenderer (QgsRasterInterface *input=nullptr, const QString &type=QString()) | |
Constructor for QgsRasterRenderer. | |
~QgsRasterRenderer () override | |
virtual bool | accept (QgsStyleEntityVisitorInterface *visitor) const |
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer. | |
int | alphaBand () const |
int | bandCount () const override |
Gets number of bands. | |
QgsRasterBlock * | block (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override=0 |
Read block of data using given extent and size. | |
virtual bool | canCreateRasterAttributeTable () const |
Returns true if the renderer is suitable for attribute table creation. | |
QgsRasterRenderer * | clone () const override=0 |
Clone itself, create deep copy. | |
void | copyCommonProperties (const QgsRasterRenderer *other, bool copyMinMaxOrigin=true) |
Copies common properties like opacity / transparency data from other renderer. | |
virtual QList< QgsLayerTreeModelLegendNode * > | createLegendNodes (QgsLayerTreeLayer *nodeLayer) |
Creates a set of legend nodes representing the renderer. | |
Qgis::DataType | dataType (int bandNo) const override |
Returns data type for the band specified by number. | |
virtual Qgis::RasterRendererFlags | flags () const |
Returns flags which dictate renderer behavior. | |
virtual int | inputBand () const |
Returns the input band for the renderer, or -1 if no input band is available. | |
virtual QList< QPair< QString, QColor > > | legendSymbologyItems () const |
Returns symbology items if provided by renderer. | |
const QgsRasterMinMaxOrigin & | minMaxOrigin () const |
Returns const reference to origin of min/max values. | |
QColor | nodataColor () const |
Returns the color to use for shading nodata pixels. | |
double | opacity () const |
Returns the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque). | |
const QgsRasterRenderer & | operator= (const QgsRasterRenderer &)=delete |
QgsRasterRenderer cannot be copied. Use clone() instead. | |
const QgsRasterTransparency * | rasterTransparency () const |
void | readXml (const QDomElement &rendererElem) override |
Sets base class members from xml. Usually called from create() methods of subclasses. | |
void | setAlphaBand (int band) |
bool | setInput (QgsRasterInterface *input) override |
Set input. | |
virtual bool | setInputBand (int band) |
Attempts to set the input band for the renderer. | |
void | setMinMaxOrigin (const QgsRasterMinMaxOrigin &origin) |
Sets origin of min/max values. | |
void | setNodataColor (const QColor &color) |
Sets the color to use for shading nodata pixels. | |
void | setOpacity (double opacity) |
Sets the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque). | |
void | setRasterTransparency (QgsRasterTransparency *t) |
virtual void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const |
Used from subclasses to create SLD Rule elements following SLD v1.0 specs. | |
virtual QString | type () const |
Returns a unique string representation of the renderer type. | |
virtual QList< int > | usesBands () const |
Returns a list of band numbers used by the renderer. | |
bool | usesTransparency () const |
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 | 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 Attributes | |
static const QRgb | NODATA_COLOR = qRgba( 0, 0, 0, 0 ) |
Protected Member Functions | |
void | _writeXml (QDomDocument &doc, QDomElement &rasterRendererElem) const |
Write upper class info into rasterrenderer element (called by writeXml method of subclasses) | |
QRgb | renderColorForNodataPixel () const |
Returns the color for the renderer to use to represent nodata pixels. | |
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 | |
int | mAlphaBand = -1 |
Read alpha value from band. | |
QgsRasterMinMaxOrigin | mMinMaxOrigin |
Origin of min/max values. | |
double | mOpacity = 1.0 |
Global alpha value (0-1) | |
QgsRasterTransparency * | mRasterTransparency = nullptr |
Raster transparency per color or value. Overwrites global alpha value. | |
QString | mType |
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. | |
Raster renderer pipe that applies colors to a raster.
Definition at line 40 of file qgsrasterrenderer.h.
QgsRasterRenderer::QgsRasterRenderer | ( | QgsRasterInterface * | input = nullptr , |
const QString & | type = QString() |
||
) |
Constructor for QgsRasterRenderer.
Definition at line 33 of file qgsrasterrenderer.cpp.
|
override |
Definition at line 39 of file qgsrasterrenderer.cpp.
|
delete |
QgsRasterRenderer cannot be copied. Use clone() instead.
|
protected |
Write upper class info into rasterrenderer element (called by writeXml method of subclasses)
Definition at line 158 of file qgsrasterrenderer.cpp.
|
virtual |
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer.
Returns true
if the visitor should continue visiting other objects, or false
if visiting should be canceled.
Reimplemented in QgsPalettedRasterRenderer, and QgsSingleBandPseudoColorRenderer.
Definition at line 243 of file qgsrasterrenderer.cpp.
|
inline |
Definition at line 165 of file qgsrasterrenderer.h.
|
overridevirtual |
Gets number of bands.
Implements QgsRasterInterface.
Definition at line 44 of file qgsrasterrenderer.cpp.
|
overridepure 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 cancellation/preview. Added in QGIS 3.0. |
Implements QgsRasterInterface.
Implemented in QgsHillshadeRenderer, QgsMultiBandColorRenderer, QgsPalettedRasterRenderer, QgsRasterContourRenderer, QgsRasterSingleColorRenderer, QgsSingleBandColorDataRenderer, QgsSingleBandGrayRenderer, and QgsSingleBandPseudoColorRenderer.
|
virtual |
Returns true
if the renderer is suitable for attribute table creation.
The default implementation returns false
.
Reimplemented in QgsPalettedRasterRenderer, and QgsSingleBandPseudoColorRenderer.
Definition at line 69 of file qgsrasterrenderer.cpp.
|
overridepure virtual |
Clone itself, create deep copy.
Implements QgsRasterInterface.
Implemented in QgsHillshadeRenderer, QgsMultiBandColorRenderer, QgsPalettedRasterRenderer, QgsRasterContourRenderer, QgsRasterSingleColorRenderer, QgsSingleBandColorDataRenderer, QgsSingleBandGrayRenderer, and QgsSingleBandPseudoColorRenderer.
void QgsRasterRenderer::copyCommonProperties | ( | const QgsRasterRenderer * | other, |
bool | copyMinMaxOrigin = true |
||
) |
Copies common properties like opacity / transparency data from other renderer.
Useful when cloning renderers.
Definition at line 216 of file qgsrasterrenderer.cpp.
|
virtual |
Creates a set of legend nodes representing the renderer.
The default implementation calls legendSymbologyItems() and creates corresponding legend nodes for each returned symbology item.
Subclasses can override this to return more legend nodes which better represent the renderer.
Reimplemented in QgsMultiBandColorRenderer, QgsPalettedRasterRenderer, QgsRasterContourRenderer, QgsSingleBandGrayRenderer, and QgsSingleBandPseudoColorRenderer.
Definition at line 130 of file qgsrasterrenderer.cpp.
|
overridevirtual |
Returns data type for the band specified by number.
Implements QgsRasterInterface.
Definition at line 53 of file qgsrasterrenderer.cpp.
|
virtual |
Returns flags which dictate renderer behavior.
Reimplemented in QgsHillshadeRenderer, QgsMultiBandColorRenderer, QgsPalettedRasterRenderer, QgsRasterContourRenderer, QgsRasterSingleColorRenderer, QgsSingleBandColorDataRenderer, QgsSingleBandGrayRenderer, and QgsSingleBandPseudoColorRenderer.
Definition at line 64 of file qgsrasterrenderer.cpp.
|
virtual |
Returns the input band for the renderer, or -1 if no input band is available.
For renderers which utilize multiple input bands -1 will be returned. In these cases usesBands() will return a list of all utilized bands (including alpha bands).
Reimplemented in QgsHillshadeRenderer, QgsPalettedRasterRenderer, QgsRasterContourRenderer, QgsRasterSingleColorRenderer, QgsSingleBandColorDataRenderer, QgsSingleBandGrayRenderer, and QgsSingleBandPseudoColorRenderer.
Definition at line 100 of file qgsrasterrenderer.cpp.
|
virtual |
Returns symbology items if provided by renderer.
Reimplemented in QgsPalettedRasterRenderer, QgsSingleBandGrayRenderer, and QgsSingleBandPseudoColorRenderer.
Definition at line 125 of file qgsrasterrenderer.cpp.
|
inline |
Returns const reference to origin of min/max values.
Definition at line 203 of file qgsrasterrenderer.h.
|
inline |
Returns the color to use for shading nodata pixels.
If the returned value is an invalid color then the default transparent rendering of nodata values will be used.
Definition at line 148 of file qgsrasterrenderer.h.
|
inline |
Returns the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).
Definition at line 136 of file qgsrasterrenderer.h.
|
delete |
QgsRasterRenderer cannot be copied. Use clone() instead.
|
inline |
Definition at line 162 of file qgsrasterrenderer.h.
|
overridevirtual |
Sets base class members from xml. Usually called from create() methods of subclasses.
Reimplemented from QgsRasterInterface.
Definition at line 188 of file qgsrasterrenderer.cpp.
|
protected |
Returns the color for the renderer to use to represent nodata pixels.
Subclasses should use this rather then nodataColor() to determine the color to use for nodata pixels during an actual rendering operation.
Definition at line 180 of file qgsrasterrenderer.cpp.
|
inline |
Definition at line 164 of file qgsrasterrenderer.h.
|
overridevirtual |
Set input.
Returns true
if set correctly, false
if cannot use that input
Reimplemented from QgsRasterInterface.
Reimplemented in QgsSingleBandColorDataRenderer.
Definition at line 74 of file qgsrasterrenderer.cpp.
|
virtual |
Attempts to set the input band for the renderer.
Returns true
if the band was successfully set, or false
if the band could not be set.
Reimplemented in QgsHillshadeRenderer, QgsPalettedRasterRenderer, QgsRasterContourRenderer, QgsRasterSingleColorRenderer, QgsSingleBandColorDataRenderer, QgsSingleBandGrayRenderer, and QgsSingleBandPseudoColorRenderer.
Definition at line 105 of file qgsrasterrenderer.cpp.
|
inline |
Sets origin of min/max values.
Definition at line 206 of file qgsrasterrenderer.h.
|
inline |
Sets the color to use for shading nodata pixels.
If color is an invalid color then the default transparent rendering of nodata values will be used.
Definition at line 159 of file qgsrasterrenderer.h.
|
inline |
Sets the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).
Definition at line 129 of file qgsrasterrenderer.h.
void QgsRasterRenderer::setRasterTransparency | ( | QgsRasterTransparency * | t | ) |
Definition at line 119 of file qgsrasterrenderer.cpp.
|
virtual |
Used from subclasses to create SLD Rule elements following SLD v1.0 specs.
Reimplemented in QgsHillshadeRenderer, QgsMultiBandColorRenderer, QgsPalettedRasterRenderer, QgsSingleBandGrayRenderer, and QgsSingleBandPseudoColorRenderer.
Definition at line 229 of file qgsrasterrenderer.cpp.
|
inlinevirtual |
Returns a unique string representation of the renderer type.
Definition at line 69 of file qgsrasterrenderer.h.
|
inlinevirtual |
Returns a list of band numbers used by the renderer.
Reimplemented in QgsHillshadeRenderer, QgsMultiBandColorRenderer, QgsPalettedRasterRenderer, QgsRasterContourRenderer, QgsRasterSingleColorRenderer, QgsSingleBandColorDataRenderer, QgsSingleBandGrayRenderer, and QgsSingleBandPseudoColorRenderer.
Definition at line 200 of file qgsrasterrenderer.h.
bool QgsRasterRenderer::usesTransparency | ( | ) | const |
Definition at line 110 of file qgsrasterrenderer.cpp.
|
protected |
Read alpha value from band.
Is combined with value from raster transparency / global alpha value. Default: -1 (not set)
Definition at line 241 of file qgsrasterrenderer.h.
|
protected |
Origin of min/max values.
Definition at line 244 of file qgsrasterrenderer.h.
|
protected |
Global alpha value (0-1)
Definition at line 233 of file qgsrasterrenderer.h.
|
protected |
Raster transparency per color or value. Overwrites global alpha value.
Definition at line 235 of file qgsrasterrenderer.h.
|
protected |
Definition at line 230 of file qgsrasterrenderer.h.
|
static |
Definition at line 47 of file qgsrasterrenderer.h.