QGIS API Documentation  2.99.0-Master (5169e0d)
qgsrasterlayer.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsrasterlayer.h - description
3  -------------------
4  begin : Fri Jun 28 2002
5  copyright : (C) 2004 by T.Sutton, Gary E.Sherman, Steve Halasz
6  email : [email protected]
7 ***************************************************************************/
8 /*
9  * Peter J. Ersts - contributed to the refactoring and maintenance of this class
10  * B. Morley - added functions to convert this class to a data provider interface
11  * Frank Warmerdam - contributed bug fixes and migrated class to use all GDAL_C_API calls
12  */
13 /***************************************************************************
14  * *
15  * This program is free software; you can redistribute it and/or modify *
16  * it under the terms of the GNU General Public License as published by *
17  * the Free Software Foundation; either version 2 of the License, or *
18  * (at your option) any later version. *
19  * *
20  ***************************************************************************/
21 #ifndef QGSRASTERLAYER_H
22 #define QGSRASTERLAYER_H
23 
24 #include "qgis_core.h"
25 #include <QColor>
26 #include <QDateTime>
27 #include <QList>
28 #include <QMap>
29 #include <QPair>
30 #include <QVector>
31 
32 #include "qgis.h"
33 #include "qgsmaplayer.h"
34 #include "qgsraster.h"
35 #include "qgsrasterdataprovider.h"
36 #include "qgsrasterpipe.h"
37 #include "qgsrasterviewport.h"
38 #include "qgsrasterminmaxorigin.h"
39 #include "qgscontrastenhancement.h"
40 
41 class QgsMapToPixel;
42 class QgsRasterRenderer;
43 class QgsRectangle;
44 class QImage;
45 class QLibrary;
46 class QPixmap;
47 class QSlider;
48 
49 typedef QList < QPair< QString, QColor > > QgsLegendColorList;
50 
138 class CORE_EXPORT QgsRasterLayer : public QgsMapLayer
139 {
140  Q_OBJECT
141  public:
142 
144  static const double SAMPLE_SIZE;
145 
148 
151 
154 
157 
160 
163 
165  QgsRasterLayer();
166 
183  QgsRasterLayer( const QString &uri,
184  const QString &baseName = QString(),
185  const QString &providerKey = "gdal",
186  bool loadDefaultStyleFlag = true );
187 
188  ~QgsRasterLayer();
189 
192  {
197  UserDefinedShader
198  };
199 
202  {
206  ColorLayer
207  };
208 
214  static bool isValidRasterFileName( const QString &fileNameQString, QString &retError );
215  static bool isValidRasterFileName( const QString &fileNameQString );
216 
218  static QDateTime lastModified( const QString &name );
219 
221  void setDataProvider( const QString &provider );
222 
224  LayerType rasterType() { return mRasterType; }
225 
227  void setRenderer( QgsRasterRenderer *renderer );
228  QgsRasterRenderer *renderer() const { return mPipe.renderer(); }
229 
231  QgsRasterResampleFilter *resampleFilter() const { return mPipe.resampleFilter(); }
232 
233  QgsBrightnessContrastFilter *brightnessFilter() const { return mPipe.brightnessFilter(); }
234  QgsHueSaturationFilter *hueSaturationFilter() const { return mPipe.hueSaturationFilter(); }
235 
237  QgsRasterPipe *pipe() { return &mPipe; }
238 
240  int width() const;
241 
243  int height() const;
244 
246  int bandCount() const;
247 
249  QString bandName( int bandNoInt ) const;
250 
252 
256  const QgsRasterDataProvider *dataProvider() const override;
257 
259  virtual void reload() override;
260 
264  virtual QgsMapLayerRenderer *createMapRenderer( QgsRenderContext &rendererContext ) override;
265 
267  void draw( QPainter *theQPainter,
268  QgsRasterViewPort *myRasterViewPort,
269  const QgsMapToPixel *qgsMapToPixel = nullptr );
270 
272  QgsLegendColorList legendSymbologyItems() const;
273 
274  virtual bool isSpatial() const override { return true; }
275 
276  QString htmlMetadata() const override;
277 
279  QPixmap paletteAsPixmap( int bandNumber = 1 );
280 
282  QString providerType() const;
283 
285  double rasterUnitsPerPixelX() const;
287  double rasterUnitsPerPixelY() const;
288 
297  void setContrastEnhancement( QgsContrastEnhancement::ContrastEnhancementAlgorithm algorithm,
299  const QgsRectangle &extent = QgsRectangle(),
300  int sampleSize = SAMPLE_SIZE,
301  bool generateLookupTableFlag = true );
302 
306  // Used by QgisApp::legendLayerStretchUsingCurrentExtent()
307  void refreshContrastEnhancement( const QgsRectangle &extent );
308 
312  // Used by QgsRasterLayerRenderer
313  void refreshRendererIfNeeded( QgsRasterRenderer *rasterRenderer, const QgsRectangle &extent );
314 
318  bool defaultContrastEnhancementSettings(
320  QgsRasterMinMaxOrigin::Limits &myLimits ) const;
321 
323  void setDefaultContrastEnhancement();
324 
326  virtual QStringList subLayers() const override;
327 
330  QImage previewAsImage( QSize size, const QColor &bgColor = Qt::white,
331  QImage::Format format = QImage::Format_ARGB32_Premultiplied );
332 
339  virtual void setLayerOrder( const QStringList &layers ) override;
340 
344  virtual void setSubLayerVisibility( const QString &name, bool vis ) override;
345 
347  virtual QDateTime timestamp() const override;
348 
349  public slots:
350  void showStatusMessage( const QString &message );
351 
352  protected:
354  bool readSymbology( const QDomNode &node, QString &errorMessage ) override;
355 
357  bool readStyle( const QDomNode &node, QString &errorMessage ) override;
358 
360  bool readXml( const QDomNode &layer_node ) override;
361 
363  bool writeSymbology( QDomNode &, QDomDocument &doc, QString &errorMessage ) const override;
364 
366  bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage ) const override;
367 
369  bool writeXml( QDomNode &layer_node, QDomDocument &doc ) const override;
370 
371  private:
373  void init();
374 
376  void closeDataProvider();
377 
379  bool update();
380 
382  void setRendererForDrawingStyle( QgsRaster::DrawingStyle drawingStyle );
383 
384  void setContrastEnhancement( QgsContrastEnhancement::ContrastEnhancementAlgorithm algorithm,
386  const QgsRectangle &extent,
387  int sampleSize,
388  bool generateLookupTableFlag,
389  QgsRasterRenderer *rasterRenderer );
390 
391  void computeMinMax( int band,
392  const QgsRasterMinMaxOrigin &mmo,
394  const QgsRectangle &extent,
395  int sampleSize,
396  double &min, double &max );
397 
399  const QString QSTRING_NOT_SET;
400  const QString TRSTRING_NOT_SET;
401 
403  QgsRasterDataProvider *mDataProvider = nullptr;
404 
406  QDateTime mLastModified;
407 
408  QgsRasterViewPort mLastViewPort;
409 
411  QString mProviderKey;
412 
413  LayerType mRasterType;
414 
415  QgsRasterPipe mPipe;
416 
418  QgsRectangle mLastRectangleUsedByRefreshContrastEnhancementIfNeeded;
419 };
420 
421 #endif
virtual QStringList subLayers() const
Returns the sublayers of this layer.
A rectangle specified with double values.
Definition: qgsrectangle.h:38
Base class for all map layer types.
Definition: qgsmaplayer.h:53
Base class for processing modules.
Definition: qgsrasterpipe.h:44
static const QgsContrastEnhancement::ContrastEnhancementAlgorithm MULTIPLE_BAND_MULTI_BYTE_ENHANCEMENT_ALGORITHM
Default enhancement algorithm for multiple band raster of type different from Byte.
QgsHueSaturationFilter * hueSaturationFilter() const
DrawingStyle
This enumerator describes the different kinds of drawing we can do.
Definition: qgsraster.h:104
This class provides qgis with the ability to render raster datasets onto the mapcanvas.
QgsRasterPipe * pipe()
Get raster pipe.
virtual bool readSymbology(const QDomNode &node, QString &errorMessage)=0
Read the symbology for the current layer from the Dom node supplied.
virtual void reload()
Synchronises with changes in the datasource.
Definition: qgsmaplayer.h:338
virtual bool isSpatial() const override
Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated w...
Resample filter pipe for rasters.
QgsRasterRenderer * renderer() const
static const double SAMPLE_SIZE
Default sample size (number of pixels) for estimated statistics/histogram calculation.
virtual QDateTime timestamp() const
Time stamp of data source in the moment when data/metadata were loaded by provider.
Definition: qgsmaplayer.h:742
virtual bool writeSymbology(QDomNode &node, QDomDocument &doc, QString &errorMessage) const =0
Write the symbology for the layer into the docment provided.
virtual QString htmlMetadata() const
Obtain a formatted HTML string containing assorted metadata for this layer.
QgsBrightnessContrastFilter * brightnessFilter() const
ColorShadingAlgorithm
This enumerator describes the types of shading that can be used.
static const QgsRasterMinMaxOrigin::Limits MULTIPLE_BAND_SINGLE_BYTE_MIN_MAX_LIMITS
Default enhancement limits for multiple band raster of type Byte.
Perform transforms between map coordinates and device coordinates.
Definition: qgsmaptopixel.h:34
This class describes the origin of min/max values.
virtual bool writeXml(QDomNode &layer_node, QDomDocument &document) const
Called by writeLayerXML(), used by children to write state specific to them to project files...
virtual void setSubLayerVisibility(const QString &name, bool visible)
Set the visibility of the given sublayer name.
static const QgsContrastEnhancement::ContrastEnhancementAlgorithm SINGLE_BAND_ENHANCEMENT_ALGORITHM
Default enhancement algorithm for single band raster.
LayerType rasterType()
Accessor for raster layer type (which is a read only property)
double ANALYSIS_EXPORT min(double x, double y)
Returns the minimum of two doubles or the first argument if both are equal.
Definition: MathUtils.cc:452
virtual bool readStyle(const QDomNode &node, QString &errorMessage)
Read the style for the current layer from the Dom node supplied.
virtual bool writeStyle(QDomNode &node, QDomDocument &doc, QString &errorMessage) const
Write just the style information for the layer into the document.
double ANALYSIS_EXPORT max(double x, double y)
Returns the maximum of two doubles or the first argument if both are equal.
Definition: MathUtils.cc:437
static const QgsRasterMinMaxOrigin::Limits SINGLE_BAND_MIN_MAX_LIMITS
Default enhancement limits for single band raster.
Limits
This enumerator describes the limits used to compute min/max values.
QList< QPair< QString, QColor > > QgsLegendColorList
ContrastEnhancementAlgorithm
This enumerator describes the types of contrast enhancement algorithms that can be used...
Contains information about the context of a rendering operation.
QgsRasterResampleFilter * resampleFilter() const
Set raster resample filter. Takes ownership of the resample filter object.
virtual bool readXml(const QDomNode &layer_node)
Called by readLayerXML(), used by children to read state specific to them from project files...
Brightness/contrast filter pipe for rasters.
Color and saturation filter pipe for rasters.
Base class for utility classes that encapsulate information necessary for rendering of map layers...
virtual QgsMapLayerRenderer * createMapRenderer(QgsRenderContext &rendererContext)=0
Return new instance of QgsMapLayerRenderer that will be used for rendering of given context...
This class provides details of the viewable area that a raster will be rendered into.
LayerType
This enumerator describes the type of raster layer.
virtual void setLayerOrder(const QStringList &layers)
Reorders the previously selected sublayers of this layer from bottom to top.
Raster renderer pipe that applies colors to a raster.
static const QgsContrastEnhancement::ContrastEnhancementAlgorithm MULTIPLE_BAND_SINGLE_BYTE_ENHANCEMENT_ALGORITHM
Default enhancement algorithm for multiple band raster of type Byte.
virtual QgsDataProvider * dataProvider()
Returns the layer&#39;s data provider.
Definition: qgsmaplayer.h:135
static const QgsRasterMinMaxOrigin::Limits MULTIPLE_BAND_MULTI_BYTE_MIN_MAX_LIMITS
Default enhancement limits for multiple band raster of type different from Byte.
Base class for raster data providers.