QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Renderer for paletted raster images. More...
#include <qgspalettedrasterrenderer.h>
Classes | |
struct | Class |
Properties of a single value class. More... | |
class | MultiValueClass |
Properties of a multi value class: a class that contains multiple values. More... | |
Public Types | |
typedef QList< QgsPalettedRasterRenderer::Class > | ClassData |
Map of value to class properties. | |
typedef QList< QgsPalettedRasterRenderer::MultiValueClass > | MultiValueClassData |
Map of multi value to class properties. | |
Public Member Functions | |
QgsPalettedRasterRenderer (const QgsPalettedRasterRenderer &)=delete | |
QgsPalettedRasterRenderer cannot be copied. Use clone() instead. | |
QgsPalettedRasterRenderer (QgsRasterInterface *input, int bandNumber, const ClassData &classes) | |
Constructor for QgsPalettedRasterRenderer. | |
QgsPalettedRasterRenderer (QgsRasterInterface *input, int bandNumber, const MultiValueClassData &classes) | |
Constructor for QgsPalettedRasterRenderer from multi value classes. | |
bool | accept (QgsStyleEntityVisitorInterface *visitor) const override |
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer. | |
Q_DECL_DEPRECATED int | band () const |
Returns the raster band used for rendering the raster. | |
QgsRasterBlock * | block (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override |
Read block of data using given extent and size. | |
bool | canCreateRasterAttributeTable () const override |
Returns true if the renderer is suitable for attribute table creation. | |
ClassData | classes () const |
Returns a map of value to classes (colors) used by the renderer. | |
QgsPalettedRasterRenderer * | clone () const override |
Clone itself, create deep copy. | |
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. | |
int | inputBand () const override |
Returns the input band for the renderer, or -1 if no input band is available. | |
QString | label (double idx) const |
Returns optional category label. | |
QList< QPair< QString, QColor > > | legendSymbologyItems () const override |
Returns symbology items if provided by renderer. | |
MultiValueClassData | multiValueClasses () const |
Returns a map of multi value to classes (colors) used by the renderer. | |
int | nColors () const |
Returns number of colors. | |
const QgsPalettedRasterRenderer & | operator= (const QgsPalettedRasterRenderer &)=delete |
QgsPalettedRasterRenderer cannot be copied. Use clone() instead. | |
bool | setInputBand (int band) override |
Attempts to set the input band for the renderer. | |
void | setLabel (double idx, const QString &label) |
Set category label. | |
void | setMultiValueClasses (const MultiValueClassData &classes) |
Sets the multi value classes to setMultiValueClasses. | |
void | setSourceColorRamp (QgsColorRamp *ramp) |
Set the source color ramp. | |
QgsColorRamp * | sourceColorRamp () const |
Gets the source color ramp. | |
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 | |
int | alphaBand () const |
int | bandCount () const override |
Gets number of bands. | |
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 QgsPalettedRasterRenderer::ClassData | classDataFromFile (const QString &path) |
Opens a color table file and returns corresponding paletted renderer class data. | |
static QgsPalettedRasterRenderer::ClassData | classDataFromRaster (QgsRasterInterface *raster, int bandNumber, QgsColorRamp *ramp=nullptr, QgsRasterBlockFeedback *feedback=nullptr) |
Generates class data from a raster, for the specified bandNumber. | |
static QgsPalettedRasterRenderer::ClassData | classDataFromString (const QString &string) |
Converts a string containing a color table or class data to to paletted renderer class data. | |
static QString | classDataToString (const QgsPalettedRasterRenderer::ClassData &classes) |
Converts classes to a string representation, using the .clr/gdal color table file format. | |
static QgsPalettedRasterRenderer::ClassData | colorTableToClassData (const QList< QgsColorRampShader::ColorRampItem > &table) |
Converts a raster color table to paletted renderer class data. | |
static QgsRasterRenderer * | create (const QDomElement &elem, QgsRasterInterface *input) |
static QgsPalettedRasterRenderer::MultiValueClassData | rasterAttributeTableToClassData (const QgsRasterAttributeTable *attributeTable, int classificationColumn=-1, QgsColorRamp *ramp=nullptr) |
Reads and returns classes from the Raster Attribute Table attributeTable, optionally classifying the attribute table by classificationColumn and setting the colors from ramp. | |
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. | |
Renderer for paletted raster images.
Definition at line 36 of file qgspalettedrasterrenderer.h.
typedef QList< QgsPalettedRasterRenderer::Class > QgsPalettedRasterRenderer::ClassData |
Map of value to class properties.
Definition at line 84 of file qgspalettedrasterrenderer.h.
typedef QList< QgsPalettedRasterRenderer::MultiValueClass > QgsPalettedRasterRenderer::MultiValueClassData |
Map of multi value to class properties.
Definition at line 87 of file qgspalettedrasterrenderer.h.
QgsPalettedRasterRenderer::QgsPalettedRasterRenderer | ( | QgsRasterInterface * | input, |
int | bandNumber, | ||
const ClassData & | classes | ||
) |
Constructor for QgsPalettedRasterRenderer.
Definition at line 40 of file qgspalettedrasterrenderer.cpp.
QgsPalettedRasterRenderer::QgsPalettedRasterRenderer | ( | QgsRasterInterface * | input, |
int | bandNumber, | ||
const MultiValueClassData & | classes | ||
) |
Constructor for QgsPalettedRasterRenderer from multi value classes.
|
delete |
QgsPalettedRasterRenderer cannot be copied. Use clone() instead.
|
overridevirtual |
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 from QgsRasterRenderer.
Definition at line 401 of file qgspalettedrasterrenderer.cpp.
|
inline |
Returns the raster band used for rendering the raster.
Definition at line 149 of file qgspalettedrasterrenderer.h.
|
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 209 of file qgspalettedrasterrenderer.cpp.
|
overridevirtual |
Returns true
if the renderer is suitable for attribute table creation.
The default implementation returns false
.
Reimplemented from QgsRasterRenderer.
Definition at line 856 of file qgspalettedrasterrenderer.cpp.
|
static |
Opens a color table file and returns corresponding paletted renderer class data.
Definition at line 626 of file qgspalettedrasterrenderer.cpp.
|
static |
Generates class data from a raster, for the specified bandNumber.
An optional color ramp can be specified to automatically assign colors from the ramp.
Definition at line 658 of file qgspalettedrasterrenderer.cpp.
|
static |
Converts a string containing a color table or class data to to paletted renderer class data.
Definition at line 547 of file qgspalettedrasterrenderer.cpp.
|
static |
Converts classes to a string representation, using the .clr/gdal color table file format.
Definition at line 639 of file qgspalettedrasterrenderer.cpp.
QgsPalettedRasterRenderer::ClassData QgsPalettedRasterRenderer::classes | ( | ) | const |
Returns a map of value to classes (colors) used by the renderer.
Definition at line 145 of file qgspalettedrasterrenderer.cpp.
|
overridevirtual |
Clone itself, create deep copy.
Implements QgsRasterRenderer.
Definition at line 82 of file qgspalettedrasterrenderer.cpp.
|
static |
Converts a raster color table to paletted renderer class data.
Definition at line 485 of file qgspalettedrasterrenderer.cpp.
|
static |
Definition at line 100 of file qgspalettedrasterrenderer.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 444 of file qgspalettedrasterrenderer.cpp.
|
overridevirtual |
Returns flags which dictate renderer behavior.
Reimplemented from QgsRasterRenderer.
Definition at line 95 of file qgspalettedrasterrenderer.cpp.
|
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 189 of file qgspalettedrasterrenderer.cpp.
QString QgsPalettedRasterRenderer::label | ( | double | idx | ) | const |
Returns optional category label.
Definition at line 161 of file qgspalettedrasterrenderer.cpp.
|
overridevirtual |
Returns symbology items if provided by renderer.
Reimplemented from QgsRasterRenderer.
Definition at line 413 of file qgspalettedrasterrenderer.cpp.
QgsPalettedRasterRenderer::MultiValueClassData QgsPalettedRasterRenderer::multiValueClasses | ( | ) | const |
Returns a map of multi value to classes (colors) used by the renderer.
Definition at line 150 of file qgspalettedrasterrenderer.cpp.
int QgsPalettedRasterRenderer::nColors | ( | ) | const |
Returns number of colors.
Definition at line 304 of file qgspalettedrasterrenderer.cpp.
|
delete |
QgsPalettedRasterRenderer cannot be copied. Use clone() instead.
|
static |
Reads and returns classes from the Raster Attribute Table attributeTable, optionally classifying the attribute table by classificationColumn and setting the colors from ramp.
The default value of -1 for the classificationColumn uses the first available value column.
Definition at line 496 of file qgspalettedrasterrenderer.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 194 of file qgspalettedrasterrenderer.cpp.
void QgsPalettedRasterRenderer::setLabel | ( | double | idx, |
const QString & | label | ||
) |
Set category label.
Definition at line 176 of file qgspalettedrasterrenderer.cpp.
void QgsPalettedRasterRenderer::setMultiValueClasses | ( | const MultiValueClassData & | classes | ) |
Sets the multi value classes to setMultiValueClasses.
Definition at line 155 of file qgspalettedrasterrenderer.cpp.
void QgsPalettedRasterRenderer::setSourceColorRamp | ( | QgsColorRamp * | ramp | ) |
Set the source color ramp.
Ownership is transferred to the renderer.
Definition at line 475 of file qgspalettedrasterrenderer.cpp.
QgsColorRamp * QgsPalettedRasterRenderer::sourceColorRamp | ( | ) | const |
Gets the source color ramp.
Definition at line 480 of file qgspalettedrasterrenderer.cpp.
|
overridevirtual |
Used from subclasses to create SLD Rule elements following SLD v1.0 specs.
Reimplemented from QgsRasterRenderer.
Definition at line 348 of file qgspalettedrasterrenderer.cpp.
|
overridevirtual |
Returns a list of band numbers used by the renderer.
Reimplemented from QgsRasterRenderer.
Definition at line 465 of file qgspalettedrasterrenderer.cpp.
|
overridevirtual |
Write base class members to xml.
Reimplemented from QgsRasterInterface.
Definition at line 309 of file qgspalettedrasterrenderer.cpp.