QGIS API Documentation 3.41.0-Master (092dc69654e)
|
Raster renderer pipe for single band gray. More...
#include <qgssinglebandgrayrenderer.h>
Public Types | |
enum | Gradient { BlackToWhite , WhiteToBlack } |
Public Member Functions | |
QgsSingleBandGrayRenderer (const QgsSingleBandGrayRenderer &)=delete | |
QgsSingleBandGrayRenderer cannot be copied. Use clone() instead. | |
QgsSingleBandGrayRenderer (QgsRasterInterface *input, int grayBand) | |
QgsRasterBlock * | block (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override |
Read block of data using given extent and size. | |
QgsSingleBandGrayRenderer * | clone () const override |
Clone itself, create deep copy. | |
const QgsContrastEnhancement * | contrastEnhancement () const |
QList< QgsLayerTreeModelLegendNode * > | createLegendNodes (QgsLayerTreeLayer *nodeLayer) override |
Creates a set of legend nodes representing the renderer. | |
Qgis::RasterRendererFlags | flags () const override |
Returns flags which dictate renderer behavior. | |
Gradient | gradient () const |
Q_DECL_DEPRECATED int | grayBand () const |
int | inputBand () const override |
Returns the input band for the renderer, or -1 if no input band is available. | |
const QgsColorRampLegendNodeSettings * | legendSettings () const |
Returns the color ramp shader legend settings. | |
QList< QPair< QString, QColor > > | legendSymbologyItems () const override |
Returns symbology items if provided by renderer. | |
const QgsSingleBandGrayRenderer & | operator= (const QgsSingleBandGrayRenderer &)=delete |
QgsSingleBandGrayRenderer cannot be copied. Use clone() instead. | |
void | setContrastEnhancement (QgsContrastEnhancement *ce) |
Takes ownership. | |
void | setGradient (Gradient gradient) |
Q_DECL_DEPRECATED void | setGrayBand (int band) |
bool | setInputBand (int band) override |
Attempts to set the input band for the renderer. | |
void | setLegendSettings (QgsColorRampLegendNodeSettings *settings) |
Sets the color ramp shader legend settings. | |
void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const override |
Used from subclasses to create SLD Rule elements following SLD v1.0 specs. | |
QList< int > | usesBands () const override |
Returns a list of band numbers used by the renderer. | |
void | writeXml (QDomDocument &doc, QDomElement &parentElem) const override |
Write base class members to xml. | |
Public Member Functions inherited from QgsRasterRenderer | |
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. | |
virtual bool | canCreateRasterAttributeTable () const |
Returns true if the renderer is suitable for attribute table creation. | |
void | copyCommonProperties (const QgsRasterRenderer *other, bool copyMinMaxOrigin=true) |
Copies common properties like opacity / transparency data from other renderer. | |
Qgis::DataType | dataType (int bandNo) const override |
Returns data type for the band specified by number. | |
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. | |
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 QString | type () const |
Returns a unique string representation of the renderer type. | |
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 int | xBlockSize () const |
Gets block size. | |
virtual int | xSize () const |
Gets raster size. | |
virtual int | yBlockSize () const |
virtual int | ySize () const |
Static Public Member Functions | |
static QgsRasterRenderer * | create (const QDomElement &elem, QgsRasterInterface *input) |
Additional Inherited Members | |
Static Public Attributes inherited from QgsRasterRenderer | |
static const QRgb | NODATA_COLOR = qRgba( 0, 0, 0, 0 ) |
Protected Member Functions inherited from QgsRasterRenderer | |
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 inherited from QgsRasterRenderer | |
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 for single band gray.
Definition at line 35 of file qgssinglebandgrayrenderer.h.
Enumerator | |
---|---|
BlackToWhite | |
WhiteToBlack |
Definition at line 38 of file qgssinglebandgrayrenderer.h.
QgsSingleBandGrayRenderer::QgsSingleBandGrayRenderer | ( | QgsRasterInterface * | input, |
int | grayBand | ||
) |
Definition at line 32 of file qgssinglebandgrayrenderer.cpp.
|
delete |
QgsSingleBandGrayRenderer cannot be copied. Use clone() instead.
|
overridevirtual |
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 QgsRasterRenderer.
Definition at line 97 of file qgssinglebandgrayrenderer.cpp.
|
overridevirtual |
Clone itself, create deep copy.
Implements QgsRasterRenderer.
Definition at line 41 of file qgssinglebandgrayrenderer.cpp.
|
inline |
Definition at line 71 of file qgssinglebandgrayrenderer.h.
|
static |
Definition at line 60 of file qgssinglebandgrayrenderer.cpp.
|
overridevirtual |
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 from QgsRasterRenderer.
Definition at line 269 of file qgssinglebandgrayrenderer.cpp.
|
overridevirtual |
Returns flags which dictate renderer behavior.
Reimplemented from QgsRasterRenderer.
Definition at line 55 of file qgssinglebandgrayrenderer.cpp.
|
inline |
Definition at line 76 of file qgssinglebandgrayrenderer.h.
|
inline |
Definition at line 61 of file qgssinglebandgrayrenderer.h.
|
overridevirtual |
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 from QgsRasterRenderer.
Definition at line 200 of file qgssinglebandgrayrenderer.cpp.
const QgsColorRampLegendNodeSettings * QgsSingleBandGrayRenderer::legendSettings | ( | ) | const |
Returns the color ramp shader legend settings.
Definition at line 450 of file qgssinglebandgrayrenderer.cpp.
|
overridevirtual |
Returns symbology items if provided by renderer.
Reimplemented from QgsRasterRenderer.
Definition at line 256 of file qgssinglebandgrayrenderer.cpp.
|
delete |
QgsSingleBandGrayRenderer cannot be copied. Use clone() instead.
void QgsSingleBandGrayRenderer::setContrastEnhancement | ( | QgsContrastEnhancement * | ce | ) |
Takes ownership.
Definition at line 92 of file qgssinglebandgrayrenderer.cpp.
|
inline |
Definition at line 75 of file qgssinglebandgrayrenderer.h.
void QgsSingleBandGrayRenderer::setGrayBand | ( | int | band | ) |
Definition at line 195 of file qgssinglebandgrayrenderer.cpp.
|
overridevirtual |
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 from QgsRasterRenderer.
Definition at line 205 of file qgssinglebandgrayrenderer.cpp.
void QgsSingleBandGrayRenderer::setLegendSettings | ( | QgsColorRampLegendNodeSettings * | settings | ) |
Sets the color ramp shader legend settings.
Ownership of settings is transferred.
Definition at line 455 of file qgssinglebandgrayrenderer.cpp.
|
overridevirtual |
Used from subclasses to create SLD Rule elements following SLD v1.0 specs.
Reimplemented from QgsRasterRenderer.
Definition at line 300 of file qgssinglebandgrayrenderer.cpp.
|
overridevirtual |
Returns a list of band numbers used by the renderer.
Reimplemented from QgsRasterRenderer.
Definition at line 290 of file qgssinglebandgrayrenderer.cpp.
|
overridevirtual |
Write base class members to xml.
Reimplemented from QgsRasterInterface.
Definition at line 220 of file qgssinglebandgrayrenderer.cpp.