23 #ifndef QGSRASTERDATAPROVIDER_H 24 #define QGSRASTERDATAPROVIDER_H 68 virtual void start() = 0;
72 void finish(
const QImage& legend );
73 void progress( qint64 received, qint64 total );
74 void error(
const QString& msg );
104 virtual QImage* draw(
const QgsRectangle & viewExtent,
int pixelWidth,
int pixelHeight ) = 0;
122 Q_UNUSED( theBandNo );
129 switch ( colorInterpretation )
191 return colorName( colorInterpretation( theBandNo ) );
197 virtual double bandScale(
int bandNo )
const { Q_UNUSED( bandNo );
return 1.0; }
201 virtual double bandOffset(
int bandNo )
const { Q_UNUSED( bandNo );
return 0.0; }
209 virtual bool srcHasNoDataValue(
int bandNo )
const {
return mSrcHasNoDataValue.value( bandNo -1 ); }
212 virtual bool useSrcNoDataValue(
int bandNo )
const {
return mUseSrcNoDataValue.value( bandNo -1 ); }
215 virtual void setUseSrcNoDataValue(
int bandNo,
bool use );
218 virtual double srcNoDataValue(
int bandNo )
const {
return mSrcNoDataValue.value( bandNo -1 ); }
246 Q_UNUSED( forceRefresh );
247 Q_UNUSED( visibleExtent );
266 Q_UNUSED( mapSettings );
272 const QString & theResamplingMethod =
"NEAREST",
276 Q_UNUSED( thePyramidList );
277 Q_UNUSED( theResamplingMethod );
278 Q_UNUSED( theFormat );
279 Q_UNUSED( theConfigOptions );
280 return "FAILED_NOT_SUPPORTED";
300 virtual QString metadata() = 0;
336 virtual QString lastErrorTitle() = 0;
347 virtual QString lastError() = 0;
350 virtual QString lastErrorFormat();
353 int dpi()
const {
return mDpi; }
366 virtual bool write(
void* data,
int band,
int width,
int height,
int xOffset,
int yOffset )
380 const QString& format,
int nBands,
382 int width,
int height,
double* geoTransform,
390 virtual bool setNoDataValue(
int bandNo,
double noDataValue ) { Q_UNUSED( bandNo ); Q_UNUSED( noDataValue );
return false; }
393 virtual bool remove() {
return false; }
405 { Q_UNUSED( createOptions ); Q_UNUSED( format );
return QString(); }
412 { Q_UNUSED( pyramidsFormat ); Q_UNUSED( theConfigOptions ); Q_UNUSED( fileFormat );
return QString(); }
422 void progress(
int theType,
double theProgress,
const QString& theMessage );
423 void progressUpdate(
int theProgress );
428 void statusChanged(
const QString& );
434 virtual void readBlock(
int bandNo,
int xBlock,
int yBlock,
void *data )
435 { Q_UNUSED( bandNo ); Q_UNUSED( xBlock ); Q_UNUSED( yBlock ); Q_UNUSED( data ); }
441 { Q_UNUSED( bandNo ); Q_UNUSED( viewExtent ); Q_UNUSED( width ); Q_UNUSED( height ); Q_UNUSED( data ); }
444 bool userNoDataValuesContains(
int bandNo,
double value )
const;
450 static QStringList cStringList2Q_(
char ** stringList );
virtual void readBlock(int bandNo, int xBlock, int yBlock, void *data)
Read block of data.
A rectangle specified with double values.
bool setInput(QgsRasterInterface *input) override
Set input.
virtual QDateTime timestamp() const override
Time stamp of data source in the moment when data/metadata were loaded by provider.
Black band of CMLY image.
Handles asynchronous download of images.
virtual QString validatePyramidsConfigOptions(QgsRaster::RasterPyramidsFormat pyramidsFormat, const QStringList &theConfigOptions, const QString &fileFormat)
Validates pyramid creation options for a specific dataset and destination format. ...
static QStringList mPyramidResamplingListGdal
virtual ~QgsRasterDataProvider()
virtual double bandOffset(int bandNo) const
Read band offset for raster value.
virtual double srcNoDataValue(int bandNo) const
Value representing no data value.
QDateTime mTimestamp
Timestamp of data in the moment when the data were loaded by provider.
virtual QgsImageFetcher * getLegendGraphicFetcher(const QgsMapSettings *mapSettings)
Get an image downloader for the raster legend.
Capability
If you add to this, please also add to capabilitiesString()
virtual QImage getLegendGraphic(double scale=0, bool forceRefresh=false, const QgsRectangle *visibleExtent=nullptr)
Returns the legend rendered as pixmap.
virtual QgsRasterRangeList userNoDataValues(int bandNo) const
Get list of user no data value ranges.
virtual bool setNoDataValue(int bandNo, double noDataValue)
Set no data value on created dataset.
Abstract base class for spatial data provider implementations.
The QgsMapSettings class contains configuration for rendering of the map.
virtual bool useSrcNoDataValue(int bandNo) const
Get source nodata value usage.
Raster identify results container.
Lightness band of HLS image.
Paletted (see associated color table)
Alpha (0=transparent, 255=opaque)
virtual void readBlock(int bandNo, QgsRectangle const &viewExtent, int width, int height, void *data)
Read block of data using give extent and size.
Green band of RGBA image.
virtual QList< QgsRasterPyramid > buildPyramidList(QList< int > overviewList=QList< int >())
Accessor for ths raster layers pyramid list.
virtual QStringList subLayers() const override
Returns the sublayers of this layer - useful for providers that manage their own layers, such as WMS.
virtual bool reload()
Reload data (data could change)
QList< bool > mSrcHasNoDataValue
Source no data value exists.
virtual QGis::DataType dataType(int bandNo) const =0
Returns data type for the band specified by number.
Base class for processing filters like renderers, reprojector, resampler etc.
A class to represent a point.
Saturation band of HLS image.
virtual QString colorInterpretationName(int theBandNo) const
QList< double > mSrcNoDataValue
Source no data value is available and is set to be used or internal no data is available.
virtual int colorInterpretation(int theBandNo) const
Returns data type for the band specified by number.
virtual double bandScale(int bandNo) const
Read band scale for raster value.
QString colorName(int colorInterpretation) const
virtual QgsRectangle extent()=0
Get the extent of the layer.
virtual ~QgsImageFetcher()
virtual QgsRasterInterface * clone() const =0
Clone itself, create deep copy.
virtual QGis::DataType srcDataType(int bandNo) const
Returns source data type for the band specified by number, source data type may be shorter than dataT...
Class for storing a coordinate reference system (CRS)
DataType
Raster data types.
virtual QgsRasterBlock * block(int bandNo, const QgsRectangle &extent, int width, int height)=0
Read block of data using given extent and size.
virtual QString buildPyramids(const QList< QgsRasterPyramid > &thePyramidList, const QString &theResamplingMethod="NEAREST", QgsRaster::RasterPyramidsFormat theFormat=QgsRaster::PyramidsGTiff, const QStringList &theConfigOptions=QStringList())
Create pyramid overviews.
Magenta band of CMYK image.
virtual QString validateCreationOptions(const QStringList &createOptions, const QString &format)
Validates creation options for a specific dataset and destination format.
virtual bool write(void *data, int band, int width, int height, int xOffset, int yOffset)
Writes into the provider datasource.
virtual bool srcHasNoDataValue(int bandNo) const
Return true if source band has no data value.
int dpi() const
Returns the dpi of the output device.
virtual QList< QgsColorRampShader::ColorRampItem > colorTable(int bandNo) const
void setDpi(int dpi)
Sets the output device resolution.
virtual QDateTime dataTimestamp() const override
Current time stamp of data source.
Base class for raster data providers.
QList< QgsRasterRangeList > mUserNoDataValue
List of lists of user defined additional no data values for each band, indexed from 0...
static QgsStringMap mPyramidResamplingMapGdal
QList< bool > mUseSrcNoDataValue
Use source nodata value.
Yellow band of CMYK image.