QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
Public Types | Public Member Functions | Static Public Member Functions | List of all members
QgsSingleBandGrayRenderer Class Reference

Raster renderer pipe for single band gray. More...

#include <qgssinglebandgrayrenderer.h>

Inheritance diagram for QgsSingleBandGrayRenderer:
Inheritance graph
[legend]

Public Types

enum  Gradient { BlackToWhite , WhiteToBlack }
 
- 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

 QgsSingleBandGrayRenderer (const QgsSingleBandGrayRenderer &)=delete
 QgsSingleBandGrayRenderer cannot be copied. Use clone() instead. More...
 
 QgsSingleBandGrayRenderer (QgsRasterInterface *input, int grayBand)
 
QgsRasterBlockblock (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override
 Read block of data using given extent and size. More...
 
QgsSingleBandGrayRendererclone () const override
 Clone itself, create deep copy. More...
 
const QgsContrastEnhancementcontrastEnhancement () const
 
QList< QgsLayerTreeModelLegendNode * > createLegendNodes (QgsLayerTreeLayer *nodeLayer) override
 Creates a set of legend nodes representing the renderer. More...
 
Qgis::RasterRendererFlags flags () const override
 Returns flags which dictate renderer behavior. More...
 
Gradient gradient () const
 
Q_DECL_DEPRECATED int grayBand () const
 
int inputBand () const override
 Returns the input band for the renderer, or -1 if no input band is available. More...
 
const QgsColorRampLegendNodeSettingslegendSettings () const
 Returns the color ramp shader legend settings. More...
 
QList< QPair< QString, QColor > > legendSymbologyItems () const override
 Returns symbology items if provided by renderer. More...
 
const QgsSingleBandGrayRendereroperator= (const QgsSingleBandGrayRenderer &)=delete
 QgsSingleBandGrayRenderer cannot be copied. Use clone() instead. More...
 
void setContrastEnhancement (QgsContrastEnhancement *ce)
 Takes ownership. More...
 
void setGradient (Gradient gradient)
 
Q_DECL_DEPRECATED void setGrayBand (int band)
 
bool setInputBand (int band) override
 Attempts to set the input band for the renderer. More...
 
void setLegendSettings (QgsColorRampLegendNodeSettings *settings)
 Sets the color ramp shader legend settings. 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...
 
virtual bool canCreateRasterAttributeTable () const
 Returns true if the renderer is suitable for attribute table creation. 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
 Returns a unique string representation of the renderer type. More...
 
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. More...
 
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. 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...
 
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). More...
 
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). 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

- 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...
 
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. More...
 
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. 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

Raster renderer pipe for single band gray.

Definition at line 35 of file qgssinglebandgrayrenderer.h.

Member Enumeration Documentation

◆ Gradient

Enumerator
BlackToWhite 
WhiteToBlack 

Definition at line 38 of file qgssinglebandgrayrenderer.h.

Constructor & Destructor Documentation

◆ QgsSingleBandGrayRenderer() [1/2]

QgsSingleBandGrayRenderer::QgsSingleBandGrayRenderer ( QgsRasterInterface input,
int  grayBand 
)

Definition at line 32 of file qgssinglebandgrayrenderer.cpp.

◆ QgsSingleBandGrayRenderer() [2/2]

QgsSingleBandGrayRenderer::QgsSingleBandGrayRenderer ( const QgsSingleBandGrayRenderer )
delete

QgsSingleBandGrayRenderer cannot be copied. Use clone() instead.

Member Function Documentation

◆ block()

QgsRasterBlock * QgsSingleBandGrayRenderer::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 97 of file qgssinglebandgrayrenderer.cpp.

◆ clone()

QgsSingleBandGrayRenderer * QgsSingleBandGrayRenderer::clone ( ) const
overridevirtual

Clone itself, create deep copy.

Implements QgsRasterRenderer.

Definition at line 41 of file qgssinglebandgrayrenderer.cpp.

◆ contrastEnhancement()

const QgsContrastEnhancement* QgsSingleBandGrayRenderer::contrastEnhancement ( ) const
inline

Definition at line 71 of file qgssinglebandgrayrenderer.h.

◆ create()

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

Definition at line 60 of file qgssinglebandgrayrenderer.cpp.

◆ createLegendNodes()

QList< QgsLayerTreeModelLegendNode * > QgsSingleBandGrayRenderer::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 269 of file qgssinglebandgrayrenderer.cpp.

◆ flags()

Qgis::RasterRendererFlags QgsSingleBandGrayRenderer::flags ( ) const
overridevirtual

Returns flags which dictate renderer behavior.

Since
QGIS 3.28

Reimplemented from QgsRasterRenderer.

Definition at line 55 of file qgssinglebandgrayrenderer.cpp.

◆ gradient()

Gradient QgsSingleBandGrayRenderer::gradient ( ) const
inline

Definition at line 76 of file qgssinglebandgrayrenderer.h.

◆ grayBand()

Q_DECL_DEPRECATED int QgsSingleBandGrayRenderer::grayBand ( ) const
inline
Deprecated:
since QGIS 3.38 use inputBand() instead

Definition at line 61 of file qgssinglebandgrayrenderer.h.

◆ inputBand()

int QgsSingleBandGrayRenderer::inputBand ( ) const
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).

See also
setInputBand()
usesBands()
Since
QGIS 3.38

Reimplemented from QgsRasterRenderer.

Definition at line 200 of file qgssinglebandgrayrenderer.cpp.

◆ legendSettings()

const QgsColorRampLegendNodeSettings * QgsSingleBandGrayRenderer::legendSettings ( ) const

Returns the color ramp shader legend settings.

See also
setLegendSettings()
Since
QGIS 3.18

Definition at line 450 of file qgssinglebandgrayrenderer.cpp.

◆ legendSymbologyItems()

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

Returns symbology items if provided by renderer.

See also
createLegendNodes()

Reimplemented from QgsRasterRenderer.

Definition at line 256 of file qgssinglebandgrayrenderer.cpp.

◆ operator=()

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

QgsSingleBandGrayRenderer cannot be copied. Use clone() instead.

◆ setContrastEnhancement()

void QgsSingleBandGrayRenderer::setContrastEnhancement ( QgsContrastEnhancement ce)

Takes ownership.

Definition at line 92 of file qgssinglebandgrayrenderer.cpp.

◆ setGradient()

void QgsSingleBandGrayRenderer::setGradient ( Gradient  gradient)
inline

Definition at line 75 of file qgssinglebandgrayrenderer.h.

◆ setGrayBand()

void QgsSingleBandGrayRenderer::setGrayBand ( int  band)
Deprecated:
since QGIS 3.38 use setInputBand() instead

Definition at line 195 of file qgssinglebandgrayrenderer.cpp.

◆ setInputBand()

bool QgsSingleBandGrayRenderer::setInputBand ( int  band)
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.

Note
Not all renderers support setting the input band.
See also
inputBand()
usesBands()
Since
QGIS 3.38

Reimplemented from QgsRasterRenderer.

Definition at line 205 of file qgssinglebandgrayrenderer.cpp.

◆ setLegendSettings()

void QgsSingleBandGrayRenderer::setLegendSettings ( QgsColorRampLegendNodeSettings settings)

Sets the color ramp shader legend settings.

Ownership of settings is transferred.

See also
legendSettings()
Since
QGIS 3.18

Definition at line 455 of file qgssinglebandgrayrenderer.cpp.

◆ toSld()

void QgsSingleBandGrayRenderer::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 300 of file qgssinglebandgrayrenderer.cpp.

◆ usesBands()

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

Returns a list of band numbers used by the renderer.

See also
setInputBand()

Reimplemented from QgsRasterRenderer.

Definition at line 290 of file qgssinglebandgrayrenderer.cpp.

◆ writeXml()

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

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 220 of file qgssinglebandgrayrenderer.cpp.


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