QGIS API Documentation  3.22.4-Białowieża (ce8e65e95e)
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
QgsPalettedRasterRenderer Class Reference

Renderer for paletted raster images. More...

#include <qgspalettedrasterrenderer.h>

Inheritance diagram for QgsPalettedRasterRenderer:
Inheritance graph
[legend]

Classes

struct  Class
 Properties of a single value class. More...
 

Public Types

typedef QList< QgsPalettedRasterRenderer::ClassClassData
 Map of value to class properties. More...
 
- Public Types inherited from QgsRasterInterface
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

 QgsPalettedRasterRenderer (const QgsPalettedRasterRenderer &)=delete
 QgsPalettedRasterRenderer cannot be copied. Use clone() instead. More...
 
 QgsPalettedRasterRenderer (QgsRasterInterface *input, int bandNumber, const ClassData &classes)
 Constructor for QgsPalettedRasterRenderer. More...
 
bool accept (QgsStyleEntityVisitorInterface *visitor) const override
 Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer. More...
 
int band () const
 Returns the raster band used for rendering the raster. More...
 
QgsRasterBlockblock (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override
 Read block of data using given extent and size. More...
 
ClassData classes () const
 Returns a map of value to classes (colors) used by the renderer. More...
 
QgsPalettedRasterRendererclone () const override
 Clone itself, create deep copy. More...
 
QList< QgsLayerTreeModelLegendNode * > createLegendNodes (QgsLayerTreeLayer *nodeLayer) override
 Creates a set of legend nodes representing the renderer. More...
 
QString label (double idx) const
 Returns optional category label. More...
 
QList< QPair< QString, QColor > > legendSymbologyItems () const override
 Returns symbology items if provided by renderer. More...
 
int nColors () const
 Returns number of colors. More...
 
const QgsPalettedRasterRendereroperator= (const QgsPalettedRasterRenderer &)=delete
 QgsPalettedRasterRenderer cannot be copied. Use clone() instead. More...
 
void setLabel (double idx, const QString &label)
 Set category label. More...
 
void setSourceColorRamp (QgsColorRamp *ramp)
 Set the source color ramp. More...
 
QgsColorRampsourceColorRamp () const
 Gets the source color ramp. More...
 
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. More...
 
QList< int > usesBands () const override
 Returns a list of band numbers used by the renderer. More...
 
void writeXml (QDomDocument &doc, QDomElement &parentElem) const override
 Write base class members to xml. More...
 
- Public Member Functions inherited from QgsRasterRenderer
 QgsRasterRenderer (const QgsRasterRenderer &)=delete
 QgsRasterRenderer cannot be copied. Use clone() instead. More...
 
 QgsRasterRenderer (QgsRasterInterface *input=nullptr, const QString &type=QString())
 Constructor for QgsRasterRenderer. More...
 
 ~QgsRasterRenderer () override
 
int alphaBand () const
 
int bandCount () const override
 Gets number of bands. More...
 
void copyCommonProperties (const QgsRasterRenderer *other, bool copyMinMaxOrigin=true)
 Copies common properties like opacity / transparency data from other renderer. More...
 
Qgis::DataType dataType (int bandNo) const override
 Returns data type for the band specified by number. More...
 
const QgsRasterMinMaxOriginminMaxOrigin () const
 Returns const reference to origin of min/max values. More...
 
QColor nodataColor () const
 Returns the color to use for shading nodata pixels. More...
 
double opacity () const
 Returns the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque). More...
 
const QgsRasterRendereroperator= (const QgsRasterRenderer &)=delete
 QgsRasterRenderer cannot be copied. Use clone() instead. More...
 
const QgsRasterTransparencyrasterTransparency () const
 
void readXml (const QDomElement &rendererElem) override
 Sets base class members from xml. Usually called from create() methods of subclasses. More...
 
void setAlphaBand (int band)
 
bool setInput (QgsRasterInterface *input) override
 Set input. More...
 
void setMinMaxOrigin (const QgsRasterMinMaxOrigin &origin)
 Sets origin of min/max values. More...
 
void setNodataColor (const QColor &color)
 Sets the color to use for shading nodata pixels. More...
 
void setOpacity (double opacity)
 Sets the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque). More...
 
void setRasterTransparency (QgsRasterTransparency *t)
 
virtual QString type () const
 
bool usesTransparency () const
 
- Public Member Functions inherited from QgsRasterInterface
 QgsRasterInterface (QgsRasterInterface *input=nullptr)
 
virtual ~QgsRasterInterface ()=default
 
virtual QgsRasterBandStats bandStatistics (int bandNo, int stats=QgsRasterBandStats::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr)
 Returns the band statistics. 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 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...
 
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...
 
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)
 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 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 int xBlockSize () const
 Gets block size. More...
 
virtual int xSize () const
 Gets raster size. More...
 
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. More...
 
static QgsPalettedRasterRenderer::ClassData classDataFromRaster (QgsRasterInterface *raster, int bandNumber, QgsColorRamp *ramp=nullptr, QgsRasterBlockFeedback *feedback=nullptr)
 Generates class data from a raster, for the specified bandNumber. More...
 
static QgsPalettedRasterRenderer::ClassData classDataFromString (const QString &string)
 Converts a string containing a color table or class data to to paletted renderer class data. More...
 
static QString classDataToString (const QgsPalettedRasterRenderer::ClassData &classes)
 Converts classes to a string representation, using the .clr/gdal color table file format. More...
 
static QgsPalettedRasterRenderer::ClassData colorTableToClassData (const QList< QgsColorRampShader::ColorRampItem > &table)
 Converts a raster color table to paletted renderer class data. More...
 
static QgsRasterRenderercreate (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) More...
 
QRgb renderColorForNodataPixel () const
 Returns the color for the renderer to use to represent nodata pixels. More...
 
- 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. 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 inherited from QgsRasterRenderer
int mAlphaBand = -1
 Read alpha value from band. More...
 
QgsRasterMinMaxOrigin mMinMaxOrigin
 Origin of min/max values. More...
 
double mOpacity = 1.0
 Global alpha value (0-1) More...
 
QgsRasterTransparencymRasterTransparency = nullptr
 Raster transparency per color or value. Overwrites global alpha value. More...
 
QString mType
 
- Protected Attributes inherited from QgsRasterInterface
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

Renderer for paletted raster images.

Definition at line 35 of file qgspalettedrasterrenderer.h.

Member Typedef Documentation

◆ ClassData

Map of value to class properties.

Definition at line 59 of file qgspalettedrasterrenderer.h.

Constructor & Destructor Documentation

◆ QgsPalettedRasterRenderer() [1/2]

QgsPalettedRasterRenderer::QgsPalettedRasterRenderer ( QgsRasterInterface input,
int  bandNumber,
const ClassData classes 
)

Constructor for QgsPalettedRasterRenderer.

Definition at line 39 of file qgspalettedrasterrenderer.cpp.

◆ QgsPalettedRasterRenderer() [2/2]

QgsPalettedRasterRenderer::QgsPalettedRasterRenderer ( const QgsPalettedRasterRenderer )
delete

QgsPalettedRasterRenderer cannot be copied. Use clone() instead.

Member Function Documentation

◆ accept()

bool QgsPalettedRasterRenderer::accept ( QgsStyleEntityVisitorInterface visitor) const
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.

Since
QGIS 3.10

Reimplemented from QgsRasterRenderer.

Definition at line 311 of file qgspalettedrasterrenderer.cpp.

◆ band()

int QgsPalettedRasterRenderer::band ( ) const
inline

Returns the raster band used for rendering the raster.

Since
QGIS 3.0

Definition at line 100 of file qgspalettedrasterrenderer.h.

◆ block()

QgsRasterBlock * QgsPalettedRasterRenderer::block ( int  bandNo,
const QgsRectangle extent,
int  width,
int  height,
QgsRasterBlockFeedback feedback = nullptr 
)
overridevirtual

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.

Implements QgsRasterRenderer.

Definition at line 132 of file qgspalettedrasterrenderer.cpp.

◆ classDataFromFile()

QgsPalettedRasterRenderer::ClassData QgsPalettedRasterRenderer::classDataFromFile ( const QString &  path)
static

Opens a color table file and returns corresponding paletted renderer class data.

See also
classDataFromString()
Since
QGIS 3.0

Definition at line 474 of file qgspalettedrasterrenderer.cpp.

◆ classDataFromRaster()

QgsPalettedRasterRenderer::ClassData QgsPalettedRasterRenderer::classDataFromRaster ( QgsRasterInterface raster,
int  bandNumber,
QgsColorRamp ramp = nullptr,
QgsRasterBlockFeedback feedback = nullptr 
)
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.

Since
QGIS 3.0

Definition at line 506 of file qgspalettedrasterrenderer.cpp.

◆ classDataFromString()

QgsPalettedRasterRenderer::ClassData QgsPalettedRasterRenderer::classDataFromString ( const QString &  string)
static

Converts a string containing a color table or class data to to paletted renderer class data.

See also
classDataFromFile()
classDataToString()
Since
QGIS 3.0

Definition at line 387 of file qgspalettedrasterrenderer.cpp.

◆ classDataToString()

QString QgsPalettedRasterRenderer::classDataToString ( const QgsPalettedRasterRenderer::ClassData classes)
static

Converts classes to a string representation, using the .clr/gdal color table file format.

See also
classDataFromString()
Since
QGIS 3.0

Definition at line 487 of file qgspalettedrasterrenderer.cpp.

◆ classes()

QgsPalettedRasterRenderer::ClassData QgsPalettedRasterRenderer::classes ( ) const

Returns a map of value to classes (colors) used by the renderer.

Definition at line 102 of file qgspalettedrasterrenderer.cpp.

◆ clone()

QgsPalettedRasterRenderer * QgsPalettedRasterRenderer::clone ( ) const
overridevirtual

Clone itself, create deep copy.

Implements QgsRasterRenderer.

Definition at line 47 of file qgspalettedrasterrenderer.cpp.

◆ colorTableToClassData()

QgsPalettedRasterRenderer::ClassData QgsPalettedRasterRenderer::colorTableToClassData ( const QList< QgsColorRampShader::ColorRampItem > &  table)
static

Converts a raster color table to paletted renderer class data.

Since
QGIS 3.0

Definition at line 376 of file qgspalettedrasterrenderer.cpp.

◆ create()

QgsRasterRenderer * QgsPalettedRasterRenderer::create ( const QDomElement &  elem,
QgsRasterInterface input 
)
static

Definition at line 57 of file qgspalettedrasterrenderer.cpp.

◆ createLegendNodes()

QList< QgsLayerTreeModelLegendNode * > QgsPalettedRasterRenderer::createLegendNodes ( QgsLayerTreeLayer nodeLayer)
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.

Since
QGIS 3.18

Reimplemented from QgsRasterRenderer.

Definition at line 335 of file qgspalettedrasterrenderer.cpp.

◆ label()

QString QgsPalettedRasterRenderer::label ( double  idx) const

Returns optional category label.

Since
QGIS 2.1

Definition at line 107 of file qgspalettedrasterrenderer.cpp.

◆ legendSymbologyItems()

QList< QPair< QString, QColor > > QgsPalettedRasterRenderer::legendSymbologyItems ( ) const
overridevirtual

Returns symbology items if provided by renderer.

See also
createLegendNodes()

Reimplemented from QgsRasterRenderer.

Definition at line 323 of file qgspalettedrasterrenderer.cpp.

◆ nColors()

int QgsPalettedRasterRenderer::nColors ( ) const
inline

Returns number of colors.

Definition at line 77 of file qgspalettedrasterrenderer.h.

◆ operator=()

const QgsPalettedRasterRenderer& QgsPalettedRasterRenderer::operator= ( const QgsPalettedRasterRenderer )
delete

QgsPalettedRasterRenderer cannot be copied. Use clone() instead.

◆ setLabel()

void QgsPalettedRasterRenderer::setLabel ( double  idx,
const QString &  label 
)

Set category label.

Since
QGIS 2.1

Definition at line 119 of file qgspalettedrasterrenderer.cpp.

◆ setSourceColorRamp()

void QgsPalettedRasterRenderer::setSourceColorRamp ( QgsColorRamp ramp)

Set the source color ramp.

Ownership is transferred to the renderer.

See also
sourceColorRamp()
Since
QGIS 3.0

Definition at line 366 of file qgspalettedrasterrenderer.cpp.

◆ sourceColorRamp()

QgsColorRamp * QgsPalettedRasterRenderer::sourceColorRamp ( ) const

Gets the source color ramp.

See also
setSourceColorRamp()
Since
QGIS 3.0

Definition at line 371 of file qgspalettedrasterrenderer.cpp.

◆ toSld()

void QgsPalettedRasterRenderer::toSld ( QDomDocument &  doc,
QDomElement &  element,
const QVariantMap &  props = QVariantMap() 
) const
overridevirtual

Used from subclasses to create SLD Rule elements following SLD v1.0 specs.

Since
QGIS 3.6

Reimplemented from QgsRasterRenderer.

Definition at line 258 of file qgspalettedrasterrenderer.cpp.

◆ usesBands()

QList< int > QgsPalettedRasterRenderer::usesBands ( ) const
overridevirtual

Returns a list of band numbers used by the renderer.

Reimplemented from QgsRasterRenderer.

Definition at line 356 of file qgspalettedrasterrenderer.cpp.

◆ writeXml()

void QgsPalettedRasterRenderer::writeXml ( QDomDocument &  doc,
QDomElement &  parentElem 
) const
overridevirtual

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 220 of file qgspalettedrasterrenderer.cpp.


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