Branch data Line data Source code
1 : : /***************************************************************************
2 : : qgsrasterdataprovider.h - DataProvider Interface for raster layers
3 : : --------------------------------------
4 : : Date : Mar 11, 2005
5 : : Copyright : (C) 2005 by Brendan Morley
6 : : email : morb at ozemail dot com dot au
7 : :
8 : : async legend fetcher : Sandro Santilli < strk at keybit dot net >
9 : :
10 : : ***************************************************************************/
11 : :
12 : : /***************************************************************************
13 : : * *
14 : : * This program is free software; you can redistribute it and/or modify *
15 : : * it under the terms of the GNU General Public License as published by *
16 : : * the Free Software Foundation; either version 2 of the License, or *
17 : : * (at your option) any later version. *
18 : : * *
19 : : ***************************************************************************/
20 : :
21 : : /* Thank you to Marco Hugentobler for the original vector DataProvider */
22 : :
23 : : #ifndef QGSRASTERDATAPROVIDER_H
24 : : #define QGSRASTERDATAPROVIDER_H
25 : :
26 : : #include "qgis_core.h"
27 : : #include "qgis_sip.h"
28 : : #include <cmath>
29 : :
30 : : #include <QDateTime>
31 : : #include <QVariant>
32 : : #include <QImage>
33 : :
34 : : #include "qgscolorrampshader.h"
35 : : #include "qgsdataprovider.h"
36 : : #include "qgsraster.h"
37 : : #include "qgsfields.h"
38 : : #include "qgsrasterinterface.h"
39 : : #include "qgsrasterpyramid.h"
40 : : #include "qgsrasterrange.h"
41 : : #include "qgsrectangle.h"
42 : : #include "qgsrasteriterator.h"
43 : : #include "qgsrasterdataprovidertemporalcapabilities.h"
44 : :
45 : : class QImage;
46 : : class QByteArray;
47 : :
48 : : class QgsPointXY;
49 : : class QgsRasterIdentifyResult;
50 : : class QgsMapSettings;
51 : :
52 : : /**
53 : : * \brief Handles asynchronous download of images
54 : : * \ingroup core
55 : : * \since QGIS 2.8
56 : : */
57 : : class CORE_EXPORT QgsImageFetcher : public QObject
58 : : {
59 : : Q_OBJECT
60 : : public:
61 : : //! Constructor
62 : : QgsImageFetcher( QObject *parent = nullptr ) : QObject( parent ) {}
63 : :
64 : : /**
65 : : * Starts the image download
66 : : * \note Make sure to connect to "finish" and "error" before starting
67 : : */
68 : : virtual void start() = 0;
69 : :
70 : : signals:
71 : :
72 : : /**
73 : : * Emitted when the download completes
74 : : * \param legend The downloaded legend image
75 : : */
76 : : void finish( const QImage &legend );
77 : : //! Emitted to report progress
78 : : void progress( qint64 received, qint64 total );
79 : : //! Emitted when an error occurs
80 : : void error( const QString &msg );
81 : : };
82 : :
83 : :
84 : : /**
85 : : * \ingroup core
86 : : * \brief Base class for raster data providers.
87 : : */
88 : 0 : class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRasterInterface
89 : : {
90 : 0 : Q_OBJECT
91 : :
92 : : public:
93 : :
94 : : /**
95 : : * Enumeration with capabilities that raster providers might implement.
96 : : * \since QGIS 3.0
97 : : */
98 : : enum ProviderCapability
99 : : {
100 : : NoProviderCapabilities = 0, //!< Provider has no capabilities
101 : : ReadLayerMetadata = 1 << 1, //!< Provider can read layer metadata from data store. Since QGIS 3.0. See QgsDataProvider::layerMetadata()
102 : : WriteLayerMetadata = 1 << 2, //!< Provider can write layer metadata to the data store. Since QGIS 3.0. See QgsDataProvider::writeLayerMetadata()
103 : : ProviderHintBenefitsFromResampling = 1 << 3, //!< Provider benefits from resampling and should apply user default resampling settings (since QGIS 3.10)
104 : : ProviderHintCanPerformProviderResampling = 1 << 4, //!< Provider can perform resampling (to be opposed to post rendering resampling) (since QGIS 3.16)
105 : : ReloadData = 1 << 5 //!< Is able to force reload data / clear local caches. Since QGIS 3.18, see QgsDataProvider::reloadProviderData()
106 : : };
107 : :
108 : : //! Provider capabilities
109 : : Q_DECLARE_FLAGS( ProviderCapabilities, ProviderCapability )
110 : :
111 : : QgsRasterDataProvider();
112 : :
113 : : /**
114 : : * Constructor for QgsRasterDataProvider.
115 : : *
116 : : * The \a uri argument gives a provider-specific uri indicating the underlying data
117 : : * source and it's parameters.
118 : : *
119 : : * The \a options argument specifies generic provider options and since QGIS 3.16 creation flags are specified within the \a flags value.
120 : : */
121 : : QgsRasterDataProvider( const QString &uri,
122 : : const QgsDataProvider::ProviderOptions &providerOptions = QgsDataProvider::ProviderOptions(),
123 : : QgsDataProvider::ReadFlags flags = QgsDataProvider::ReadFlags() );
124 : :
125 : : QgsRasterDataProvider *clone() const override = 0;
126 : :
127 : : /**
128 : : * Returns flags containing the supported capabilities of the data provider.
129 : : * \since QGIS 3.0
130 : : */
131 : : virtual QgsRasterDataProvider::ProviderCapabilities providerCapabilities() const;
132 : :
133 : : /* It makes no sense to set input on provider */
134 : : bool setInput( QgsRasterInterface *input ) override { Q_UNUSED( input ) return false; }
135 : :
136 : : QgsRectangle extent() const override = 0;
137 : :
138 : : //! Returns data type for the band specified by number
139 : : Qgis::DataType dataType( int bandNo ) const override = 0;
140 : :
141 : : /**
142 : : * Returns the fields of the raster layer for data providers that expose them,
143 : : * the default implementation returns an empty list.
144 : : * \since QGIS 3.14
145 : : */
146 : : virtual QgsFields fields() const { return QgsFields(); };
147 : :
148 : : /**
149 : : * Returns source data type for the band specified by number,
150 : : * source data type may be shorter than dataType
151 : : */
152 : : Qgis::DataType sourceDataType( int bandNo ) const override = 0;
153 : :
154 : : //! Returns data type for the band specified by number
155 : : virtual int colorInterpretation( int bandNo ) const;
156 : :
157 : 0 : QString colorName( int colorInterpretation ) const
158 : : {
159 : : // Modified copy from GDAL
160 : 0 : switch ( colorInterpretation )
161 : : {
162 : : case QgsRaster::UndefinedColorInterpretation:
163 : 0 : return QStringLiteral( "Undefined" );
164 : :
165 : : case QgsRaster::GrayIndex:
166 : 0 : return QStringLiteral( "Gray" );
167 : :
168 : : case QgsRaster::PaletteIndex:
169 : 0 : return QStringLiteral( "Palette" );
170 : :
171 : : case QgsRaster::RedBand:
172 : 0 : return QStringLiteral( "Red" );
173 : :
174 : : case QgsRaster::GreenBand:
175 : 0 : return QStringLiteral( "Green" );
176 : :
177 : : case QgsRaster::BlueBand:
178 : 0 : return QStringLiteral( "Blue" );
179 : :
180 : : case QgsRaster::AlphaBand:
181 : 0 : return QStringLiteral( "Alpha" );
182 : :
183 : : case QgsRaster::HueBand:
184 : 0 : return QStringLiteral( "Hue" );
185 : :
186 : : case QgsRaster::SaturationBand:
187 : 0 : return QStringLiteral( "Saturation" );
188 : :
189 : : case QgsRaster::LightnessBand:
190 : 0 : return QStringLiteral( "Lightness" );
191 : :
192 : : case QgsRaster::CyanBand:
193 : 0 : return QStringLiteral( "Cyan" );
194 : :
195 : : case QgsRaster::MagentaBand:
196 : 0 : return QStringLiteral( "Magenta" );
197 : :
198 : : case QgsRaster::YellowBand:
199 : 0 : return QStringLiteral( "Yellow" );
200 : :
201 : : case QgsRaster::BlackBand:
202 : 0 : return QStringLiteral( "Black" );
203 : :
204 : : case QgsRaster::YCbCr_YBand:
205 : 0 : return QStringLiteral( "YCbCr_Y" );
206 : :
207 : : case QgsRaster::YCbCr_CbBand:
208 : 0 : return QStringLiteral( "YCbCr_Cb" );
209 : :
210 : : case QgsRaster::YCbCr_CrBand:
211 : 0 : return QStringLiteral( "YCbCr_Cr" );
212 : :
213 : : default:
214 : 0 : return QStringLiteral( "Unknown" );
215 : : }
216 : 0 : }
217 : : //! Reload data (data could change)
218 : : virtual bool reload() { return true; }
219 : :
220 : : QString colorInterpretationName( int bandNo ) const override;
221 : :
222 : : /**
223 : : * Read band scale for raster value
224 : : * \since QGIS 2.3
225 : : */
226 : : virtual double bandScale( int bandNo ) const { Q_UNUSED( bandNo ) return 1.0; }
227 : :
228 : : /**
229 : : * Read band offset for raster value
230 : : * \since QGIS 2.3
231 : : */
232 : : virtual double bandOffset( int bandNo ) const { Q_UNUSED( bandNo ) return 0.0; }
233 : :
234 : : // TODO: remove or make protected all readBlock working with void*
235 : :
236 : : //! Read block of data using given extent and size.
237 : : QgsRasterBlock *block( int bandNo, const QgsRectangle &boundingBox, int width, int height, QgsRasterBlockFeedback *feedback = nullptr ) override SIP_FACTORY;
238 : :
239 : : //! Returns TRUE if source band has no data value
240 : 0 : virtual bool sourceHasNoDataValue( int bandNo ) const { return mSrcHasNoDataValue.value( bandNo - 1 ); }
241 : :
242 : : //! Returns the source nodata value usage
243 : 0 : virtual bool useSourceNoDataValue( int bandNo ) const { return mUseSrcNoDataValue.value( bandNo - 1 ); }
244 : :
245 : : //! Sets the source nodata value usage
246 : : virtual void setUseSourceNoDataValue( int bandNo, bool use );
247 : :
248 : : //! Value representing no data value.
249 : 0 : virtual double sourceNoDataValue( int bandNo ) const { return mSrcNoDataValue.value( bandNo - 1 ); }
250 : :
251 : : virtual void setUserNoDataValue( int bandNo, const QgsRasterRangeList &noData );
252 : :
253 : : //! Returns a list of user no data value ranges.
254 : 0 : virtual QgsRasterRangeList userNoDataValues( int bandNo ) const { return mUserNoDataValue.value( bandNo - 1 ); }
255 : :
256 : : virtual QList<QgsColorRampShader::ColorRampItem> colorTable( int bandNo ) const
257 : : { Q_UNUSED( bandNo ) return QList<QgsColorRampShader::ColorRampItem>(); }
258 : :
259 : : /**
260 : : * \brief Returns the sublayers of this layer - useful for providers that manage
261 : : * their own layers, such as WMS
262 : : */
263 : : QStringList subLayers() const override
264 : : {
265 : : return QStringList();
266 : : }
267 : :
268 : : QgsRasterDataProviderTemporalCapabilities *temporalCapabilities() override;
269 : : const QgsRasterDataProviderTemporalCapabilities *temporalCapabilities() const override SIP_SKIP;
270 : :
271 : : //! \brief Returns whether the provider supplies a legend graphic
272 : : virtual bool supportsLegendGraphic() const { return false; }
273 : :
274 : : /**
275 : : * Returns the legend rendered as pixmap
276 : : *
277 : : * This is useful for layers which need to get legend layers remotely as WMS.
278 : : *
279 : : * \param scale Optional parameter that is the Scale of the layer
280 : : * \param forceRefresh Optional bool parameter to force refresh getLegendGraphic call
281 : : * \param visibleExtent Visible extent for providers supporting contextual legends, in layer CRS
282 : : * \note Parameter visibleExtent added in QGIS 2.8
283 : : * \note Not available in Python bindings
284 : : */
285 : : virtual QImage getLegendGraphic( double scale = 0, bool forceRefresh = false, const QgsRectangle *visibleExtent = nullptr ) SIP_SKIP
286 : : {
287 : : Q_UNUSED( scale )
288 : : Q_UNUSED( forceRefresh )
289 : : Q_UNUSED( visibleExtent )
290 : : return QImage();
291 : : }
292 : :
293 : : /**
294 : : * Returns a new image downloader for the raster legend.
295 : : *
296 : : * \param mapSettings map settings for legend providers supporting
297 : : * contextual legends.
298 : : *
299 : : * \returns a download handler or NULLPTR if the provider does not support
300 : : * legend at all. Ownership of the returned object is transferred
301 : : * to caller.
302 : : *
303 : : *
304 : : * \since QGIS 2.8
305 : : */
306 : : virtual QgsImageFetcher *getLegendGraphicFetcher( const QgsMapSettings *mapSettings ) SIP_FACTORY
307 : : {
308 : : Q_UNUSED( mapSettings )
309 : : return nullptr;
310 : : }
311 : :
312 : : /**
313 : : * Creates pyramid overviews.
314 : : *
315 : : * \param pyramidList a list of QgsRasterPyramids to create overviews for. The QgsRasterPyramid::setBuild() flag
316 : : * should be set to TRUE for every layer where pyramids are desired.
317 : : * \param resamplingMethod resampling method to use when creating the pyramids. The pyramidResamplingMethods() method
318 : : * can be used to retrieve a list of valid resampling methods available for specific raster data providers.
319 : : * \param format raster pyramid format.
320 : : * \param configOptions optional configuration options which are passed to the specific data provider
321 : : * for use during pyramid creation.
322 : : * \param feedback optional feedback argument for progress reports and cancellation support.
323 : : *
324 : : * \see buildPyramidList()
325 : : * \see hasPyramids()
326 : : * \see pyramidResamplingMethods()
327 : : */
328 : : virtual QString buildPyramids( const QList<QgsRasterPyramid> &pyramidList,
329 : : const QString &resamplingMethod = "NEAREST",
330 : : QgsRaster::RasterPyramidsFormat format = QgsRaster::PyramidsGTiff,
331 : : const QStringList &configOptions = QStringList(),
332 : : QgsRasterBlockFeedback *feedback = nullptr )
333 : : {
334 : : Q_UNUSED( pyramidList )
335 : : Q_UNUSED( resamplingMethod )
336 : : Q_UNUSED( format )
337 : : Q_UNUSED( configOptions )
338 : : Q_UNUSED( feedback )
339 : : return QStringLiteral( "FAILED_NOT_SUPPORTED" );
340 : : }
341 : :
342 : : /**
343 : : * Returns the raster layers pyramid list.
344 : : *
345 : : * This method returns a list of pyramid layers which are valid for the data provider. The returned list
346 : : * is a complete list of all possible layers, and includes both pyramids layers which currently exist and
347 : : * layers which have not yet been constructed. To know which of the pyramid layers
348 : : * ACTUALLY exists you need to look at the QgsRasterPyramid::getExists() member for each value in the
349 : : * list.
350 : : *
351 : : * The returned list is suitable for passing to the buildPyramids() method. First, modify the returned list
352 : : * by calling `QgsRasterPyramid::setBuild( TRUE )` for every layer you want to create pyramids for, and then
353 : : * pass the modified list to buildPyramids().
354 : : *
355 : : * \param overviewList used to construct the pyramid list (optional), when empty the list is defined by the provider.
356 : : *
357 : : * \see buildPyramids()
358 : : * \see hasPyramids()
359 : : */
360 : : virtual QList<QgsRasterPyramid> buildPyramidList( const QList<int> &overviewList = QList<int>() )
361 : : { Q_UNUSED( overviewList ) return QList<QgsRasterPyramid>(); }
362 : :
363 : : /**
364 : : * Returns TRUE if raster has at least one existing pyramid.
365 : : *
366 : : * The buildPyramidList() method can be used to retrieve additional details about potential and existing
367 : : * pyramid layers.
368 : : *
369 : : * \see buildPyramidList()
370 : : * \see buildPyramids()
371 : : */
372 : : bool hasPyramids();
373 : :
374 : : /**
375 : : * Returns metadata in a format suitable for feeding directly
376 : : * into a subset of the GUI raster properties "Metadata" tab.
377 : : */
378 : : virtual QString htmlMetadata() = 0;
379 : :
380 : : /**
381 : : * Identify raster value(s) found on the point position. The context
382 : : * parameters extent, width and height are important to identify
383 : : * on the same zoom level as a displayed map and to do effective
384 : : * caching (WCS). If context params are not specified the highest
385 : : * resolution is used. capabilities() may be used to test if format
386 : : * is supported by provider. Values are set to 'no data' or empty string
387 : : * if point is outside data source extent.
388 : : *
389 : : * \param point coordinates in data source CRS
390 : : * \param format result format
391 : : * \param boundingBox context bounding box
392 : : * \param width context width
393 : : * \param height context height
394 : : * \param dpi context dpi
395 : : * \return QgsRaster::IdentifyFormatValue: map of values for each band, keys are band numbers
396 : : * (from 1).
397 : : * QgsRaster::IdentifyFormatFeature: map of QgsRasterFeatureList for each sublayer
398 : : * QgsRaster::IdentifyFormatHtml: map of HTML strings for each sublayer (WMS).
399 : : * Empty if failed or there are no results.
400 : : * \note The arbitraryness of the returned document is enforced by WMS standards
401 : : * up to at least v1.3.0
402 : : * \see sample(), which is much more efficient for simple "value at point" queries.
403 : : */
404 : : virtual QgsRasterIdentifyResult identify( const QgsPointXY &point, QgsRaster::IdentifyFormat format, const QgsRectangle &boundingBox = QgsRectangle(), int width = 0, int height = 0, int dpi = 96 );
405 : :
406 : : /**
407 : : * Samples a raster value from the specified \a band found at the \a point position. The context
408 : : * parameters \a boundingBox, \a width and \a height are important to identify
409 : : * on the same zoom level as a displayed map and to do effective
410 : : * caching (WCS). If context params are not specified the highest
411 : : * resolution is used.
412 : : *
413 : : * If \a ok is specified and the point is outside data source extent, or an invalid
414 : : * band number was specified, then \a ok will be set to FALSE. In this case the function will return
415 : : * a NaN value.
416 : : *
417 : : * \see identify(), which is much more flexible but considerably less efficient.
418 : : * \since QGIS 3.4
419 : : */
420 : : virtual double sample( const QgsPointXY &point, int band,
421 : : bool *ok SIP_OUT = nullptr,
422 : : const QgsRectangle &boundingBox = QgsRectangle(), int width = 0, int height = 0, int dpi = 96 );
423 : :
424 : : /**
425 : : * \brief Returns the caption error text for the last error in this provider
426 : : *
427 : : * If an operation returns 0 (e.g. draw()), this function
428 : : * returns the text of the error associated with the failure.
429 : : * Interactive users of this provider can then, for example,
430 : : * call a QMessageBox to display the contents.
431 : : */
432 : : virtual QString lastErrorTitle() = 0;
433 : :
434 : : /**
435 : : * \brief Returns the verbose error text for the last error in this provider
436 : : *
437 : : * If an operation returns 0 (e.g. draw()), this function
438 : : * returns the text of the error associated with the failure.
439 : : * Interactive users of this provider can then, for example,
440 : : * call a QMessageBox to display the contents.
441 : : *
442 : : */
443 : : virtual QString lastError() = 0;
444 : :
445 : : //! Returns the format of the error text for the last error in this provider
446 : : virtual QString lastErrorFormat();
447 : :
448 : : //! Returns the dpi of the output device.
449 : : int dpi() const { return mDpi; }
450 : :
451 : : //! Sets the output device resolution.
452 : 0 : void setDpi( int dpi ) { mDpi = dpi; }
453 : :
454 : : //! Time stamp of data source in the moment when data/metadata were loaded by provider
455 : : QDateTime timestamp() const override { return mTimestamp; }
456 : :
457 : : //! Current time stamp of data source
458 : : QDateTime dataTimestamp() const override { return QDateTime(); }
459 : :
460 : : /**
461 : : * Checks whether the provider is in editing mode, i.e. raster write operations will be accepted.
462 : : * By default providers are not editable. Use setEditable() method to enable/disable editing.
463 : : * \see setEditable(), writeBlock()
464 : : * \since QGIS 3.0
465 : : */
466 : : virtual bool isEditable() const { return false; }
467 : :
468 : : /**
469 : : * Turns on/off editing mode of the provider. When in editing mode, it is possible
470 : : * to overwrite data of the provider using writeBlock() calls.
471 : : * \returns TRUE if the switch to/from editing mode was successful
472 : : * \note Only some providers support editing mode and even those may fail to turn
473 : : * the underlying data source into editing mode, so it is necessary to check the return
474 : : * value whether the operation was successful.
475 : : * \see isEditable(), writeBlock()
476 : : * \since QGIS 3.0
477 : : */
478 : : virtual bool setEditable( bool enabled ) { Q_UNUSED( enabled ) return false; }
479 : :
480 : : // TODO: add data type (may be different from band type)
481 : :
482 : : //! Writes into the provider datasource
483 : : virtual bool write( void *data, int band, int width, int height, int xOffset, int yOffset )
484 : : {
485 : : Q_UNUSED( data )
486 : : Q_UNUSED( band )
487 : : Q_UNUSED( width )
488 : : Q_UNUSED( height )
489 : : Q_UNUSED( xOffset )
490 : : Q_UNUSED( yOffset )
491 : : return false;
492 : : }
493 : :
494 : : /**
495 : : * Writes pixel data from a raster block into the provider data source.
496 : : *
497 : : * This will override previously stored pixel values. It is assumed that cells in the passed
498 : : * raster block are aligned with the cells of the data source. If raster block does not cover
499 : : * the whole area of the data source, only a subset of pixels covered by the raster block
500 : : * will be overwritten. By default, writing of raster data starts from the first cell
501 : : * of the raster - it is possible to set offset in pixels by specifying non-zero
502 : : * xOffset and yOffset values.
503 : : *
504 : : * Writing is supported only by some data providers. Provider has to be in editing mode
505 : : * in order to allow write operations.
506 : : * \see isEditable(), setEditable()
507 : : * \returns TRUE on success
508 : : * \since QGIS 3.0
509 : : */
510 : : bool writeBlock( QgsRasterBlock *block, int band, int xOffset = 0, int yOffset = 0 );
511 : :
512 : : //! Creates a new dataset with mDataSourceURI
513 : : static QgsRasterDataProvider *create( const QString &providerKey,
514 : : const QString &uri,
515 : : const QString &format, int nBands,
516 : : Qgis::DataType type,
517 : : int width, int height, double *geoTransform,
518 : : const QgsCoordinateReferenceSystem &crs,
519 : : const QStringList &createOptions = QStringList() );
520 : :
521 : : /**
522 : : * Set no data value on created dataset
523 : : * \param bandNo band number
524 : : * \param noDataValue no data value
525 : : */
526 : : virtual bool setNoDataValue( int bandNo, double noDataValue ) { Q_UNUSED( bandNo ) Q_UNUSED( noDataValue ); return false; }
527 : :
528 : : //! Remove dataset
529 : : virtual bool remove() { return false; }
530 : :
531 : : /**
532 : : * Returns a list of pyramid resampling method name and label pairs
533 : : * for given provider
534 : : */
535 : : static QList<QPair<QString, QString> > pyramidResamplingMethods( const QString &providerKey );
536 : :
537 : : /**
538 : : * Validates creation options for a specific dataset and destination format.
539 : : * \note used by GDAL provider only
540 : : * \note see also validateCreationOptionsFormat() in gdal provider for validating options based on format only
541 : : */
542 : : virtual QString validateCreationOptions( const QStringList &createOptions, const QString &format )
543 : : { Q_UNUSED( createOptions ) Q_UNUSED( format ); return QString(); }
544 : :
545 : : /**
546 : : * Validates pyramid creation options for a specific dataset and destination format
547 : : * \note used by GDAL provider only
548 : : */
549 : : virtual QString validatePyramidsConfigOptions( QgsRaster::RasterPyramidsFormat pyramidsFormat,
550 : : const QStringList &configOptions, const QString &fileFormat )
551 : : { Q_UNUSED( pyramidsFormat ) Q_UNUSED( configOptions ); Q_UNUSED( fileFormat ); return QString(); }
552 : :
553 : : static QString identifyFormatName( QgsRaster::IdentifyFormat format );
554 : : static QgsRaster::IdentifyFormat identifyFormatFromName( const QString &formatName );
555 : : static QString identifyFormatLabel( QgsRaster::IdentifyFormat format );
556 : : static Capability identifyFormatToCapability( QgsRaster::IdentifyFormat format );
557 : :
558 : : /**
559 : : * Step width for raster iterations.
560 : : * \see stepHeight()
561 : : * \since QGIS 3.0
562 : : */
563 : : virtual int stepWidth() const { return QgsRasterIterator::DEFAULT_MAXIMUM_TILE_WIDTH; }
564 : :
565 : : /**
566 : : * Step height for raster iterations.
567 : : * \see stepWidth()
568 : : * \since QGIS 3.0
569 : : */
570 : : virtual int stepHeight() const { return QgsRasterIterator::DEFAULT_MAXIMUM_TILE_HEIGHT; }
571 : :
572 : : /**
573 : : * Returns a list of native resolutions if available, i.e. map units per pixel at which the raster source
574 : : * was originally created.
575 : : *
576 : : * Resolutions are calculated in the provider's crs().
577 : : *
578 : : * \since QGIS 3.8.0
579 : : */
580 : : virtual QList< double > nativeResolutions() const;
581 : :
582 : : /**
583 : : * Returns TRUE if the extents reported by the data provider are not reliable
584 : : * and it's possible that there is renderable content outside of these extents.
585 : : *
586 : : * \since QGIS 3.10.0
587 : : */
588 : : virtual bool ignoreExtents() const;
589 : :
590 : : /**
591 : : * Types of transformation in transformCoordinates() function.
592 : : * \since QGIS 3.14
593 : : */
594 : : enum TransformType
595 : : {
596 : : TransformImageToLayer, //!< Transforms image coordinates to layer (georeferenced) coordinates
597 : : TransformLayerToImage, //!< Transforms layer (georeferenced) coordinates to image coordinates
598 : : };
599 : :
600 : : /**
601 : : * Transforms coordinates between source image coordinate space [0..width]x[0..height] and
602 : : * layer coordinate space (georeferenced coordinates). Often this transformation is a simple
603 : : * 2D affine transformation (offset and scaling), but rasters with different georeferencing
604 : : * methods like GCPs (ground control points) or RPCs (rational polynomial coefficients) may
605 : : * require a more complex transform.
606 : : *
607 : : * If the transform fails (input coordinates are outside of the valid range or data provider
608 : : * does not support this functionality), an empty point is returned.
609 : : *
610 : : * \since QGIS 3.14
611 : : */
612 : : virtual QgsPoint transformCoordinates( const QgsPoint &point, TransformType type );
613 : :
614 : :
615 : : /**
616 : : * Enable or disable provider-level resampling.
617 : : *
618 : : * \return TRUE if success
619 : : * \since QGIS 3.16
620 : : */
621 : : virtual bool enableProviderResampling( bool enable ) { Q_UNUSED( enable ); return false; }
622 : :
623 : : /**
624 : : * Returns whether provider-level resampling is enabled.
625 : : *
626 : : * \note Resampling is effective only if zoomedInResamplingMethod() and/or
627 : : * zoomedOutResamplingMethod() return non-nearest resampling.
628 : : *
629 : : * \see zoomedInResamplingMethod()
630 : : * \see zoomedOutResamplingMethod()
631 : : * \see maxOversampling()
632 : : *
633 : : * \since QGIS 3.16
634 : : */
635 : : bool isProviderResamplingEnabled() const { return mProviderResamplingEnabled; }
636 : :
637 : : /**
638 : : * Resampling method for provider-level resampling.
639 : : * \since QGIS 3.16
640 : : */
641 : : enum class ResamplingMethod
642 : : {
643 : : Nearest, //!< Nearest-neighbour resampling
644 : : Bilinear, //!< Bilinear (2x2 kernel) resampling
645 : : Cubic,//!< Cubic Convolution Approximation (4x4 kernel) resampling
646 : : CubicSpline, //!< Cubic B-Spline Approximation (4x4 kernel)
647 : : Lanczos, //!< Lanczos windowed sinc interpolation (6x6 kernel)
648 : : Average, //!< Average resampling
649 : : Mode, //!< Mode (selects the value which appears most often of all the sampled points)
650 : : Gauss //!< Gauss blurring
651 : : };
652 : :
653 : : /**
654 : : * Set resampling method to apply for zoomed-in operations.
655 : : *
656 : : * \return TRUE if success
657 : : * \since QGIS 3.16
658 : : */
659 : : virtual bool setZoomedInResamplingMethod( ResamplingMethod method ) { Q_UNUSED( method ); return false; }
660 : :
661 : : /**
662 : : * Returns resampling method for zoomed-in operations.
663 : : * \since QGIS 3.16
664 : : */
665 : : ResamplingMethod zoomedInResamplingMethod() const { return mZoomedInResamplingMethod; }
666 : :
667 : : /**
668 : : * Set resampling method to apply for zoomed-out operations.
669 : : *
670 : : * \return TRUE if success
671 : : * \since QGIS 3.16
672 : : */
673 : : virtual bool setZoomedOutResamplingMethod( ResamplingMethod method ) { Q_UNUSED( method ); return false; }
674 : :
675 : : /**
676 : : * Returns resampling method for zoomed-out operations.
677 : : * \since QGIS 3.16
678 : : */
679 : : ResamplingMethod zoomedOutResamplingMethod() const { return mZoomedOutResamplingMethod; }
680 : :
681 : : /**
682 : : * Sets maximum oversampling factor for zoomed-out operations.
683 : : *
684 : : * \return TRUE if success
685 : : * \since QGIS 3.16
686 : : */
687 : : virtual bool setMaxOversampling( double factor ) { Q_UNUSED( factor ); return false; }
688 : :
689 : : /**
690 : : * Returns maximum oversampling factor for zoomed-out operations.
691 : : * \since QGIS 3.16
692 : : */
693 : : double maxOversampling() const { return mMaxOversampling; }
694 : :
695 : : void readXml( const QDomElement &filterElem ) override;
696 : :
697 : : void writeXml( QDomDocument &doc, QDomElement &parentElem ) const override;
698 : :
699 : : signals:
700 : :
701 : : /**
702 : : * Emit a message to be displayed on status bar, usually used by network providers (WMS,WCS)
703 : : * \since QGIS 2.14
704 : : */
705 : : void statusChanged( const QString & ) const;
706 : :
707 : : protected:
708 : :
709 : : /**
710 : : * Reads a block of raster data into \a data.
711 : : * \returns TRUE if the block was successfully read, or FALSE if an error occurred and the block could not be read.
712 : : * \note not available in Python bindings
713 : : */
714 : : virtual bool readBlock( int bandNo, int xBlock, int yBlock, void *data ) SIP_SKIP
715 : : { Q_UNUSED( bandNo ) Q_UNUSED( xBlock ); Q_UNUSED( yBlock ); Q_UNUSED( data ); return false; }
716 : :
717 : : /**
718 : : * Reads a block of raster data into \a data, using the given extent and size.
719 : : * \returns TRUE if the block was successfully read, or FALSE if an error occurred and the block could not be read.
720 : : * \note not available in Python bindings
721 : : */
722 : : virtual bool readBlock( int bandNo, QgsRectangle const &viewExtent, int width, int height, void *data, QgsRasterBlockFeedback *feedback = nullptr ) SIP_SKIP
723 : : { Q_UNUSED( bandNo ) Q_UNUSED( viewExtent ); Q_UNUSED( width ); Q_UNUSED( height ); Q_UNUSED( data ); Q_UNUSED( feedback ); return false; }
724 : :
725 : : //! Returns TRUE if user no data contains value
726 : : bool userNoDataValuesContains( int bandNo, double value ) const;
727 : :
728 : : //! Copy member variables from other raster data provider. Useful for implementation of clone() method in subclasses
729 : : void copyBaseSettings( const QgsRasterDataProvider &other );
730 : :
731 : : /**
732 : : * Dots per inch. Extended WMS (e.g. QGIS mapserver) support DPI dependent output and therefore
733 : : are suited for printing. A value of -1 means it has not been set
734 : : */
735 : : int mDpi = -1;
736 : :
737 : : /**
738 : : * Source no data value is available and is set to be used or internal no data
739 : : * is available. Used internally only
740 : : */
741 : : //bool hasNoDataValue ( int bandNo );
742 : :
743 : : //! \brief Cell value representing original source no data. e.g. -9999, indexed from 0
744 : : QList<double> mSrcNoDataValue;
745 : :
746 : : //! \brief Source no data value exists.
747 : : QList<bool> mSrcHasNoDataValue;
748 : :
749 : : /**
750 : : * \brief Use source nodata value. User can disable usage of source nodata
751 : : * value as nodata. It may happen that a value is wrongly given by GDAL
752 : : * as nodata (e.g. 0) and it has to be treated as regular value.
753 : : */
754 : : QList<bool> mUseSrcNoDataValue;
755 : :
756 : : /**
757 : : * \brief List of lists of user defined additional no data values
758 : : * for each band, indexed from 0
759 : : */
760 : : QList< QgsRasterRangeList > mUserNoDataValue;
761 : :
762 : : mutable QgsRectangle mExtent;
763 : :
764 : : //! Whether provider resampling is enabled.
765 : : bool mProviderResamplingEnabled = false;
766 : :
767 : : //! Resampling method for zoomed in pixel extraction
768 : : ResamplingMethod mZoomedInResamplingMethod = ResamplingMethod::Nearest;
769 : :
770 : : //! Resampling method for zoomed out pixel extraction
771 : : ResamplingMethod mZoomedOutResamplingMethod = ResamplingMethod::Nearest;
772 : :
773 : : //! Maximum boundary for oversampling (to avoid too much data traffic). Default: 2.0
774 : : double mMaxOversampling = 2.0;
775 : :
776 : : private:
777 : :
778 : : /**
779 : : * Data provider temporal properties
780 : : */
781 : : std::unique_ptr< QgsRasterDataProviderTemporalCapabilities > mTemporalCapabilities;
782 : :
783 : : };
784 : :
785 : 0 : Q_DECLARE_OPERATORS_FOR_FLAGS( QgsRasterDataProvider::ProviderCapabilities )
786 : :
787 : : // clazy:excludeall=qstring-allocations
788 : :
789 : : #endif
|
