QGIS API Documentation  2.99.0-Master (3450a9f)
qgssinglebandgrayrenderer.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgssinglebandgrayrenderer.h
3  ---------------------------
4  begin : December 2011
5  copyright : (C) 2011 by Marco Hugentobler
6  email : marco at sourcepole dot ch
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSSINGLEBANDGRAYRENDERER_H
19 #define QGSSINGLEBANDGRAYRENDERER_H
20 
21 #include "qgis_core.h"
22 #include "qgsrasterrenderer.h"
23 #include <memory>
24 
26 class QDomElement;
27 
32 {
33  public:
34  enum Gradient
35  {
37  WhiteToBlack
38  };
39 
40  QgsSingleBandGrayRenderer( QgsRasterInterface *input, int grayBand );
41 
46 
47  QgsSingleBandGrayRenderer *clone() const override;
48 
49  static QgsRasterRenderer *create( const QDomElement &elem, QgsRasterInterface *input );
50 
51  QgsRasterBlock *block( int bandNo, QgsRectangle const &extent, int width, int height, QgsRasterBlockFeedback *feedback = nullptr ) override;
52 
53  int grayBand() const { return mGrayBand; }
54  void setGrayBand( int band ) { mGrayBand = band; }
55  const QgsContrastEnhancement *contrastEnhancement() const { return mContrastEnhancement.get(); }
57  void setContrastEnhancement( QgsContrastEnhancement *ce );
58 
59  void setGradient( Gradient gradient ) { mGradient = gradient; }
60  Gradient gradient() const { return mGradient; }
61 
62  void writeXml( QDomDocument &doc, QDomElement &parentElem ) const override;
63 
64  void legendSymbologyItems( QList< QPair< QString, QColor > > &symbolItems ) const override;
65 
66  QList<int> usesBands() const override;
67 
68  private:
69  int mGrayBand;
70  Gradient mGradient;
71  std::unique_ptr< QgsContrastEnhancement > mContrastEnhancement;
72 
73 };
74 
75 #endif // QGSSINGLEBANDGRAYRENDERER_H
A rectangle specified with double values.
Definition: qgsrectangle.h:38
virtual QList< int > usesBands() const
Returns a list of band numbers used by the renderer.
const QgsContrastEnhancement * contrastEnhancement() const
Raster data container.
Raster renderer pipe for single band gray.
void setGradient(Gradient gradient)
Base class for processing filters like renderers, reprojector, resampler etc.
const QgsRasterRenderer & operator=(const QgsRasterRenderer &)=delete
QgsRasterRenderer cannot be copied. Use clone() instead.
QgsRasterRenderer * clone() const override=0
Clone itself, create deep copy.
Manipulates raster pixel values so that they enhanceContrast or clip into a specified numerical range...
virtual void legendSymbologyItems(QList< QPair< QString, QColor > > &symbolItems) const
Get symbology items if provided by renderer.
virtual void writeXml(QDomDocument &doc, QDomElement &parentElem) const
Write base class members to xml.
Feedback object tailored for raster block reading.
Raster renderer pipe that applies colors to a raster.
virtual QgsRasterBlock * block(int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override=0
Read block of data using given extent and size.