QGIS API Documentation  2.17.0-Master (0497e4a)
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 "qgsrasterrenderer.h"
22 
24 class QDomElement;
25 
30 {
31  public:
32  enum Gradient
33  {
35  WhiteToBlack
36  };
37 
38  QgsSingleBandGrayRenderer( QgsRasterInterface* input, int grayBand );
40  QgsSingleBandGrayRenderer * clone() const override;
41 
42  static QgsRasterRenderer* create( const QDomElement& elem, QgsRasterInterface* input );
43 
44  QgsRasterBlock *block( int bandNo, QgsRectangle const & extent, int width, int height ) override;
45  QgsRasterBlock *block2( int bandNo, QgsRectangle const & extent, int width, int height, QgsRasterBlockFeedback* feedback = nullptr ) override;
46 
47  int grayBand() const { return mGrayBand; }
48  void setGrayBand( int band ) { mGrayBand = band; }
49  const QgsContrastEnhancement* contrastEnhancement() const { return mContrastEnhancement; }
51  void setContrastEnhancement( QgsContrastEnhancement* ce );
52 
53  void setGradient( Gradient theGradient ) { mGradient = theGradient; }
54  Gradient gradient() const { return mGradient; }
55 
56  void writeXML( QDomDocument& doc, QDomElement& parentElem ) const override;
57 
58  void legendSymbologyItems( QList< QPair< QString, QColor > >& symbolItems ) const override;
59 
60  QList<int> usesBands() const override;
61 
62  private:
63  int mGrayBand;
64  Gradient mGradient;
65  QgsContrastEnhancement* mContrastEnhancement;
66 
68  const QgsSingleBandGrayRenderer& operator=( const QgsSingleBandGrayRenderer& );
69 };
70 
71 #endif // QGSSINGLEBANDGRAYRENDERER_H
A rectangle specified with double values.
Definition: qgsrectangle.h:35
virtual QList< int > usesBands() const
Returns a list of band numbers used by the renderer.
const QgsContrastEnhancement * contrastEnhancement() const
virtual QgsRasterBlock * block2(int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr)
Read block of data using given extent and size.
Raster data container.
virtual void writeXML(QDomDocument &doc, QDomElement &parentElem) const
Write base class members to xml.
Raster renderer pipe for single band gray.
Base class for processing filters like renderers, reprojector, resampler etc.
void setGradient(Gradient theGradient)
virtual QgsRasterBlock * block(int bandNo, const QgsRectangle &extent, int width, int height)=0
Read block of data using given extent and size.
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.
Feedback object tailored for raster block reading.
Raster renderer pipe that applies colors to a raster.