QGIS API Documentation
2.18.21-Las Palmas (9fba24a)
|
Raster renderer pipe for single band pseudocolor. More...
#include <qgssinglebandpseudocolorrenderer.h>
Public Member Functions | |
QgsSingleBandPseudoColorRenderer (QgsRasterInterface *input, int band, QgsRasterShader *shader) | |
Note: takes ownership of QgsRasterShader. More... | |
~QgsSingleBandPseudoColorRenderer () | |
int | band () const |
Returns the band used by the renderer. More... | |
QgsRasterBlock * | block (int bandNo, const QgsRectangle &extent, int width, int height) override |
Read block of data using given extent and size. More... | |
QgsRasterBlock * | block2 (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override |
Read block of data using given extent and size. More... | |
double | classificationMax () const |
double | classificationMin () const |
int | classificationMinMaxOrigin () const |
QgsSingleBandPseudoColorRenderer * | clone () const override |
Clone itself, create deep copy. More... | |
void | legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const override |
Get symbology items if provided by renderer. More... | |
void | setBand (int bandNo) |
Sets the band used by the renderer. More... | |
void | setClassificationMax (double max) |
void | setClassificationMin (double min) |
void | setClassificationMinMaxOrigin (int origin) |
void | setShader (QgsRasterShader *shader) |
Takes ownership of the shader. More... | |
QgsRasterShader * | shader () |
const QgsRasterShader * | shader () const |
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="") | |
virtual | ~QgsRasterRenderer () |
int | alphaBand () const |
virtual int | bandCount () const override |
Get number of bands. More... | |
void | copyCommonProperties (const QgsRasterRenderer *other) |
Copies common properties like opacity / transparency data from other renderer. More... | |
virtual QGis::DataType | dataType (int bandNo) const override |
Returns data type for the band specified by number. More... | |
double | opacity () const |
const QgsRasterTransparency * | rasterTransparency () const |
void | readXML (const QDomElement &rendererElem) override |
Sets base class members from xml. More... | |
void | setAlphaBand (int band) |
virtual bool | setInput (QgsRasterInterface *input) override |
Set input. More... | |
void | setOpacity (double opacity) |
void | setRasterTransparency (QgsRasterTransparency *t) |
virtual QString | type () const |
bool | usesTransparency () const |
![]() | |
QgsRasterInterface (QgsRasterInterface *input=nullptr) | |
virtual | ~QgsRasterInterface () |
virtual QgsRasterBandStats | bandStatistics (int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0) |
Get 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 theBandNo, double theLowerCount, double theUpperCount, double &theLowerValue, double &theUpperValue, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0) |
Find values for cumulative pixel count cut. More... | |
int | dataTypeSize (int bandNo) |
virtual QgsRectangle | extent () |
Get the extent of the interface. More... | |
virtual QString | generateBandName (int theBandNumber) const |
helper function to create zero padded band names More... | |
virtual bool | hasHistogram (int theBandNo, int theBinCount, double theMinimum=std::numeric_limits< double >::quiet_NaN(), double theMaximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0, bool theIncludeOutOfRange=false) |
Returns true if histogram is available (cached, already calculated), the parameters are the same as in histogram() More... | |
virtual bool | hasStatistics (int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0) |
Returns true if histogram is available (cached, already calculated). More... | |
virtual QgsRasterHistogram | histogram (int theBandNo, int theBinCount=0, double theMinimum=std::numeric_limits< double >::quiet_NaN(), double theMaximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0, bool theIncludeOutOfRange=false) |
Get histogram. More... | |
virtual QgsRasterInterface * | input () const |
Current input. More... | |
virtual bool | on () const |
Is on/off. More... | |
virtual void | setOn (bool on) |
Set on/off. More... | |
virtual QGis::DataType | srcDataType (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 * | srcInput () const |
Get source / raw input, the first in pipe, usually provider. More... | |
virtual QgsRasterInterface * | srcInput () |
virtual int | xBlockSize () const |
Get block size. More... | |
virtual int | xSize () const |
Get raster size. More... | |
virtual int | yBlockSize () const |
virtual int | ySize () const |
Static Public Member Functions | |
static QgsRasterRenderer * | create (const QDomElement &elem, QgsRasterInterface *input) |
![]() | |
static int | minMaxOriginFromName (const QString &theName) |
static QString | minMaxOriginLabel (int theOrigin) |
static QString | minMaxOriginName (int theOrigin) |
Additional Inherited Members | |
![]() | |
enum | MinMaxOrigin { MinMaxUnknown = 0, MinMaxUser = 1, MinMaxMinMax = 1 << 1, MinMaxCumulativeCut = 1 << 2, MinMaxStdDev = 1 << 3, MinMaxFullExtent = 1 << 4, MinMaxSubExtent = 1 << 5, MinMaxEstimated = 1 << 6, MinMaxExact = 1 << 7 } |
![]() | |
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 &theHistogram, int theBandNo, int theBinCount=0, double theMinimum=std::numeric_limits< double >::quiet_NaN(), double theMaximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0, bool theIncludeOutOfRange=false) |
Fill in histogram defaults if not specified. More... | |
void | initStatistics (QgsRasterBandStats &theStatistics, int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theBinCount=0) |
Fill in statistics defaults if not specified. More... | |
![]() | |
int | mAlphaBand |
Read alpha value from band. More... | |
double | mOpacity |
Global alpha value (0-1) More... | |
QgsRasterTransparency * | mRasterTransparency |
Raster transparency per color or value. More... | |
QString | mType |
![]() | |
QList< QgsRasterHistogram > | mHistograms |
List of cached histograms, all bands mixed. More... | |
QgsRasterInterface * | mInput |
bool | mOn |
QList< QgsRasterBandStats > | mStatistics |
List of cached statistics, all bands mixed. More... | |
Raster renderer pipe for single band pseudocolor.
Definition at line 29 of file qgssinglebandpseudocolorrenderer.h.
QgsSingleBandPseudoColorRenderer::QgsSingleBandPseudoColorRenderer | ( | QgsRasterInterface * | input, |
int | band, | ||
QgsRasterShader * | shader | ||
) |
Note: takes ownership of QgsRasterShader.
Definition at line 26 of file qgssinglebandpseudocolorrenderer.cpp.
QgsSingleBandPseudoColorRenderer::~QgsSingleBandPseudoColorRenderer | ( | ) |
Definition at line 36 of file qgssinglebandpseudocolorrenderer.cpp.
|
inline |
Returns the band used by the renderer.
Definition at line 57 of file qgssinglebandpseudocolorrenderer.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 |
Implements QgsRasterInterface.
Definition at line 110 of file qgssinglebandpseudocolorrenderer.cpp.
|
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 |
Reimplemented from QgsRasterInterface.
Definition at line 115 of file qgssinglebandpseudocolorrenderer.cpp.
|
inline |
Definition at line 66 of file qgssinglebandpseudocolorrenderer.h.
|
inline |
Definition at line 65 of file qgssinglebandpseudocolorrenderer.h.
|
inline |
Definition at line 69 of file qgssinglebandpseudocolorrenderer.h.
|
overridevirtual |
Clone itself, create deep copy.
Implements QgsRasterRenderer.
Definition at line 50 of file qgssinglebandpseudocolorrenderer.cpp.
|
static |
Definition at line 83 of file qgssinglebandpseudocolorrenderer.cpp.
|
overridevirtual |
Get symbology items if provided by renderer.
Reimplemented from QgsRasterRenderer.
Definition at line 236 of file qgssinglebandpseudocolorrenderer.cpp.
void QgsSingleBandPseudoColorRenderer::setBand | ( | int | bandNo | ) |
Sets the band used by the renderer.
Definition at line 41 of file qgssinglebandpseudocolorrenderer.cpp.
|
inline |
Definition at line 68 of file qgssinglebandpseudocolorrenderer.h.
|
inline |
Definition at line 67 of file qgssinglebandpseudocolorrenderer.h.
|
inline |
Definition at line 70 of file qgssinglebandpseudocolorrenderer.h.
void QgsSingleBandPseudoColorRenderer::setShader | ( | QgsRasterShader * | shader | ) |
Takes ownership of the shader.
Definition at line 77 of file qgssinglebandpseudocolorrenderer.cpp.
|
inline |
Definition at line 44 of file qgssinglebandpseudocolorrenderer.h.
|
inline |
Definition at line 46 of file qgssinglebandpseudocolorrenderer.h.
|
overridevirtual |
Returns a list of band numbers used by the renderer.
Reimplemented from QgsRasterRenderer.
Definition at line 248 of file qgssinglebandpseudocolorrenderer.cpp.
|
overridevirtual |
Write base class members to xml.
Reimplemented from QgsRasterInterface.
Definition at line 215 of file qgssinglebandpseudocolorrenderer.cpp.