QGIS API Documentation
3.10.0-A Coruña (6c816b4204)
|
Renderer for multiband images with the color components. More...
#include <qgsmultibandcolorrenderer.h>
Public Member Functions | |
QgsMultiBandColorRenderer (QgsRasterInterface *input, int redBand, int greenBand, int blueBand, QgsContrastEnhancement *redEnhancement=nullptr, QgsContrastEnhancement *greenEnhancement=nullptr, QgsContrastEnhancement *blueEnhancement=nullptr) | |
QgsMultiBandColorRenderer (const QgsMultiBandColorRenderer &)=delete | |
QgsMultiBandColorRenderer cannot be copied. Use clone() instead. More... | |
~QgsMultiBandColorRenderer () override | |
QgsRasterBlock * | block (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 QgsContrastEnhancement * | blueContrastEnhancement () const |
QgsMultiBandColorRenderer * | clone () const override |
Clone itself, create deep copy. More... | |
int | greenBand () const |
const QgsContrastEnhancement * | greenContrastEnhancement () const |
const QgsMultiBandColorRenderer & | operator= (const QgsMultiBandColorRenderer &)=delete |
QgsMultiBandColorRenderer cannot be copied. Use clone() instead. More... | |
int | redBand () const |
const QgsContrastEnhancement * | redContrastEnhancement () const |
void | setBlueBand (int band) |
void | setBlueContrastEnhancement (QgsContrastEnhancement *ce) |
Takes ownership. More... | |
void | setGreenBand (int band) |
void | setGreenContrastEnhancement (QgsContrastEnhancement *ce) |
Takes ownership. More... | |
void | setRedBand (int band) |
void | setRedContrastEnhancement (QgsContrastEnhancement *ce) |
Takes ownership. More... | |
void | toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props=QgsStringMap()) 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... | |
![]() | |
QgsRasterRenderer (QgsRasterInterface *input=nullptr, const QString &type=QString()) | |
Constructor for QgsRasterRenderer. More... | |
QgsRasterRenderer (const QgsRasterRenderer &)=delete | |
QgsRasterRenderer cannot be copied. Use clone() instead. 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 void | legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const |
Gets symbology items if provided by renderer. More... | |
const QgsRasterMinMaxOrigin & | minMaxOrigin () const |
Returns const reference to origin of min/max values. 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 QgsRasterRenderer & | operator= (const QgsRasterRenderer &)=delete |
QgsRasterRenderer cannot be copied. Use clone() instead. More... | |
const QgsRasterTransparency * | rasterTransparency () 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 | 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 |
![]() | |
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 above in friendly format. 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) |
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 QgsRasterInterface * | input () 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 const QgsRasterInterface * | sourceInput () const |
Gets source / raw input, the first in pipe, usually provider. More... | |
virtual QgsRasterInterface * | sourceInput () |
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 QgsRasterRenderer * | create (const QDomElement &elem, QgsRasterInterface *input) |
Additional Inherited Members | |
![]() | |
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 } |
If you add to this, please also add to capabilitiesString() More... | |
![]() | |
static const QRgb | NODATA_COLOR = qRgba( 0, 0, 0, 0 ) |
![]() | |
void | _writeXml (QDomDocument &doc, QDomElement &rasterRendererElem) const |
Write upper class info into rasterrenderer element (called by writeXml method of subclasses) More... | |
![]() | |
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... | |
![]() | |
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... | |
QgsRasterTransparency * | mRasterTransparency = nullptr |
Raster transparency per color or value. Overwrites global alpha value. More... | |
QString | mType |
![]() | |
QList< QgsRasterHistogram > | mHistograms |
List of cached histograms, all bands mixed. More... | |
QgsRasterInterface * | mInput = nullptr |
bool | mOn = true |
QList< QgsRasterBandStats > | mStatistics |
List of cached statistics, all bands mixed. More... | |
Renderer for multiband images with the color components.
Definition at line 32 of file qgsmultibandcolorrenderer.h.
QgsMultiBandColorRenderer::QgsMultiBandColorRenderer | ( | QgsRasterInterface * | input, |
int | redBand, | ||
int | greenBand, | ||
int | blueBand, | ||
QgsContrastEnhancement * | redEnhancement = nullptr , |
||
QgsContrastEnhancement * | greenEnhancement = nullptr , |
||
QgsContrastEnhancement * | blueEnhancement = nullptr |
||
) |
Definition at line 28 of file qgsmultibandcolorrenderer.cpp.
|
override |
Definition at line 42 of file qgsmultibandcolorrenderer.cpp.
|
delete |
QgsMultiBandColorRenderer 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 134 of file qgsmultibandcolorrenderer.cpp.
|
inline |
Definition at line 55 of file qgsmultibandcolorrenderer.h.
|
inline |
Definition at line 66 of file qgsmultibandcolorrenderer.h.
|
overridevirtual |
Clone itself, create deep copy.
Implements QgsRasterRenderer.
Definition at line 49 of file qgsmultibandcolorrenderer.cpp.
|
static |
Definition at line 88 of file qgsmultibandcolorrenderer.cpp.
|
inline |
Definition at line 53 of file qgsmultibandcolorrenderer.h.
|
inline |
Definition at line 62 of file qgsmultibandcolorrenderer.h.
|
delete |
QgsMultiBandColorRenderer cannot be copied. Use clone() instead.
|
inline |
Definition at line 51 of file qgsmultibandcolorrenderer.h.
|
inline |
Definition at line 58 of file qgsmultibandcolorrenderer.h.
|
inline |
Definition at line 56 of file qgsmultibandcolorrenderer.h.
void QgsMultiBandColorRenderer::setBlueContrastEnhancement | ( | QgsContrastEnhancement * | ce | ) |
Takes ownership.
Definition at line 82 of file qgsmultibandcolorrenderer.cpp.
|
inline |
Definition at line 54 of file qgsmultibandcolorrenderer.h.
void QgsMultiBandColorRenderer::setGreenContrastEnhancement | ( | QgsContrastEnhancement * | ce | ) |
Takes ownership.
Definition at line 76 of file qgsmultibandcolorrenderer.cpp.
|
inline |
Definition at line 52 of file qgsmultibandcolorrenderer.h.
void QgsMultiBandColorRenderer::setRedContrastEnhancement | ( | QgsContrastEnhancement * | ce | ) |
Takes ownership.
Definition at line 70 of file qgsmultibandcolorrenderer.cpp.
|
overridevirtual |
Used from subclasses to create SLD Rule elements following SLD v1.0 specs.
Reimplemented from QgsRasterRenderer.
Definition at line 421 of file qgsmultibandcolorrenderer.cpp.
|
overridevirtual |
Returns a list of band numbers used by the renderer.
Reimplemented from QgsRasterRenderer.
Definition at line 403 of file qgsmultibandcolorrenderer.cpp.
|
overridevirtual |
Write base class members to xml.
Reimplemented from QgsRasterInterface.
Definition at line 368 of file qgsmultibandcolorrenderer.cpp.