QGIS API Documentation  3.23.0-Master (eb871beae0)
Public Member Functions | Static Public Member Functions | List of all members
QgsMultiBandColorRenderer Class Reference

Renderer for multiband images with the color components. More...

#include <qgsmultibandcolorrenderer.h>

Inheritance diagram for QgsMultiBandColorRenderer:
Inheritance graph
[legend]

Public Member Functions

 QgsMultiBandColorRenderer (const QgsMultiBandColorRenderer &)=delete
 QgsMultiBandColorRenderer cannot be copied. Use clone() instead. More...
 
 QgsMultiBandColorRenderer (QgsRasterInterface *input, int redBand, int greenBand, int blueBand, QgsContrastEnhancement *redEnhancement=nullptr, QgsContrastEnhancement *greenEnhancement=nullptr, QgsContrastEnhancement *blueEnhancement=nullptr)
 
 ~QgsMultiBandColorRenderer () override
 
QgsRasterBlockblock (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override
 Read block of data using given extent and size. More...
 
int blueBand () const
 
const QgsContrastEnhancementblueContrastEnhancement () const
 Returns the contrast enhancement to use for the blue channel. More...
 
QgsMultiBandColorRendererclone () const override
 Clone itself, create deep copy. More...
 
QList< QgsLayerTreeModelLegendNode * > createLegendNodes (QgsLayerTreeLayer *nodeLayer) override
 Creates a set of legend nodes representing the renderer. More...
 
int greenBand () const
 
const QgsContrastEnhancementgreenContrastEnhancement () const
 Returns the contrast enhancement to use for the green channel. More...
 
const QgsMultiBandColorRendereroperator= (const QgsMultiBandColorRenderer &)=delete
 QgsMultiBandColorRenderer cannot be copied. Use clone() instead. More...
 
int redBand () const
 
const QgsContrastEnhancementredContrastEnhancement () const
 Returns the contrast enhancement to use for the red channel. More...
 
void setBlueBand (int band)
 
void setBlueContrastEnhancement (QgsContrastEnhancement *ce)
 Sets the contrast enhancement to use for the blue channel. More...
 
void setGreenBand (int band)
 
void setGreenContrastEnhancement (QgsContrastEnhancement *ce)
 Sets the contrast enhancement to use for the green channel. More...
 
void setRedBand (int band)
 
void setRedContrastEnhancement (QgsContrastEnhancement *ce)
 Sets the contrast enhancement to use for the red channel. 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
 
virtual bool accept (QgsStyleEntityVisitorInterface *visitor) const
 Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer. More...
 
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...
 
virtual QList< QPair< QString, QColor > > legendSymbologyItems () const
 Returns symbology items if provided by renderer. 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 QgsRasterRenderercreate (const QDomElement &elem, QgsRasterInterface *input)
 

Additional Inherited Members

- 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...
 
- 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 multiband images with the color components.

Definition at line 32 of file qgsmultibandcolorrenderer.h.

Constructor & Destructor Documentation

◆ QgsMultiBandColorRenderer() [1/2]

QgsMultiBandColorRenderer::QgsMultiBandColorRenderer ( QgsRasterInterface input,
int  redBand,
int  greenBand,
int  blueBand,
QgsContrastEnhancement redEnhancement = nullptr,
QgsContrastEnhancement greenEnhancement = nullptr,
QgsContrastEnhancement blueEnhancement = nullptr 
)

Definition at line 30 of file qgsmultibandcolorrenderer.cpp.

◆ ~QgsMultiBandColorRenderer()

QgsMultiBandColorRenderer::~QgsMultiBandColorRenderer ( )
override

Definition at line 44 of file qgsmultibandcolorrenderer.cpp.

◆ QgsMultiBandColorRenderer() [2/2]

QgsMultiBandColorRenderer::QgsMultiBandColorRenderer ( const QgsMultiBandColorRenderer )
delete

QgsMultiBandColorRenderer cannot be copied. Use clone() instead.

Member Function Documentation

◆ block()

QgsRasterBlock * QgsMultiBandColorRenderer::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 136 of file qgsmultibandcolorrenderer.cpp.

◆ blueBand()

int QgsMultiBandColorRenderer::blueBand ( ) const
inline

Definition at line 55 of file qgsmultibandcolorrenderer.h.

◆ blueContrastEnhancement()

const QgsContrastEnhancement* QgsMultiBandColorRenderer::blueContrastEnhancement ( ) const
inline

Returns the contrast enhancement to use for the blue channel.

See also
setBlueContrastEnhancement()
redContrastEnhancement()
greenContrastEnhancement()

Definition at line 105 of file qgsmultibandcolorrenderer.h.

◆ clone()

QgsMultiBandColorRenderer * QgsMultiBandColorRenderer::clone ( ) const
overridevirtual

Clone itself, create deep copy.

Implements QgsRasterRenderer.

Definition at line 51 of file qgsmultibandcolorrenderer.cpp.

◆ create()

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

Definition at line 90 of file qgsmultibandcolorrenderer.cpp.

◆ createLegendNodes()

QList< QgsLayerTreeModelLegendNode * > QgsMultiBandColorRenderer::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 444 of file qgsmultibandcolorrenderer.cpp.

◆ greenBand()

int QgsMultiBandColorRenderer::greenBand ( ) const
inline

Definition at line 53 of file qgsmultibandcolorrenderer.h.

◆ greenContrastEnhancement()

const QgsContrastEnhancement* QgsMultiBandColorRenderer::greenContrastEnhancement ( ) const
inline

Returns the contrast enhancement to use for the green channel.

See also
setGreenContrastEnhancement()
redContrastEnhancement()
blueContrastEnhancement()

Definition at line 85 of file qgsmultibandcolorrenderer.h.

◆ operator=()

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

QgsMultiBandColorRenderer cannot be copied. Use clone() instead.

◆ redBand()

int QgsMultiBandColorRenderer::redBand ( ) const
inline

Definition at line 51 of file qgsmultibandcolorrenderer.h.

◆ redContrastEnhancement()

const QgsContrastEnhancement* QgsMultiBandColorRenderer::redContrastEnhancement ( ) const
inline

Returns the contrast enhancement to use for the red channel.

See also
setRedContrastEnhancement()
greenContrastEnhancement()
blueContrastEnhancement()

Definition at line 65 of file qgsmultibandcolorrenderer.h.

◆ setBlueBand()

void QgsMultiBandColorRenderer::setBlueBand ( int  band)
inline

Definition at line 56 of file qgsmultibandcolorrenderer.h.

◆ setBlueContrastEnhancement()

void QgsMultiBandColorRenderer::setBlueContrastEnhancement ( QgsContrastEnhancement ce)

Sets the contrast enhancement to use for the blue channel.

Ownership of the enhancement is transferred.

See also
blueContrastEnhancement()
setRedContrastEnhancement()
setGreenContrastEnhancement()

Definition at line 84 of file qgsmultibandcolorrenderer.cpp.

◆ setGreenBand()

void QgsMultiBandColorRenderer::setGreenBand ( int  band)
inline

Definition at line 54 of file qgsmultibandcolorrenderer.h.

◆ setGreenContrastEnhancement()

void QgsMultiBandColorRenderer::setGreenContrastEnhancement ( QgsContrastEnhancement ce)

Sets the contrast enhancement to use for the green channel.

Ownership of the enhancement is transferred.

See also
greenContrastEnhancement()
setRedContrastEnhancement()
setBlueContrastEnhancement()

Definition at line 78 of file qgsmultibandcolorrenderer.cpp.

◆ setRedBand()

void QgsMultiBandColorRenderer::setRedBand ( int  band)
inline

Definition at line 52 of file qgsmultibandcolorrenderer.h.

◆ setRedContrastEnhancement()

void QgsMultiBandColorRenderer::setRedContrastEnhancement ( QgsContrastEnhancement ce)

Sets the contrast enhancement to use for the red channel.

Ownership of the enhancement is transferred.

See also
redContrastEnhancement()
setGreenContrastEnhancement()
setBlueContrastEnhancement()

Definition at line 72 of file qgsmultibandcolorrenderer.cpp.

◆ toSld()

void QgsMultiBandColorRenderer::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 463 of file qgsmultibandcolorrenderer.cpp.

◆ usesBands()

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

Returns a list of band numbers used by the renderer.

Reimplemented from QgsRasterRenderer.

Definition at line 426 of file qgsmultibandcolorrenderer.cpp.

◆ writeXml()

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

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 391 of file qgsmultibandcolorrenderer.cpp.


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