21#ifndef QGSRASTERLAYER_H
22#define QGSRASTERLAYER_H
121 : loadDefaultStyle( loadDefaultStyle )
122 , transformContext( transformContext )
126 bool loadDefaultStyle =
true;
147 bool skipCrsValidation =
false;
164 const QString &baseName = QString(),
165 const QString &providerType =
"gdal",
171 SIP_PYOBJECT __repr__();
173 QString
str = QStringLiteral(
"<QgsRasterLayer: '%1' (%2)>" ).arg( sipCpp->name(), sipCpp->dataProvider() ? sipCpp->dataProvider()->name() : QStringLiteral(
"Invalid" ) );
174 sipRes = PyUnicode_FromString(
str.toUtf8().constData() );
193 static
bool isValidRasterFileName( const QString &fileNameQString, QString &retError );
196 static
bool isValidRasterFileName( const QString &fileNameQString );
199 static QDateTime lastModified( const QString &name );
205 Q_DECL_DEPRECATED
void setDataProvider( const QString &provider )
SIP_DEPRECATED;
219 Qgis::RasterLayerType rasterType()
const {
return mRasterType; }
296 int bandCount()
const;
301 QString bandName(
int bandNoInt )
const;
313 int attributeTableCount( )
const;
319 bool canCreateRasterAttributeTable( );
335 void reload() override;
339 void draw( QPainter *theQPainter,
350 bool isSpatial()
const override {
return true; }
359 QPixmap paletteAsPixmap(
int bandNumber = 1 );
372 double rasterUnitsPerPixelX()
const;
381 double rasterUnitsPerPixelY()
const;
398 bool generateLookupTableFlag = true );
417 virtual QString subsetString() const;
427 virtual
bool setSubsetString( const QString &subset );
433 bool defaultContrastEnhancementSettings(
438 void setDefaultContrastEnhancement();
440 QStringList subLayers() const override;
445 QImage previewAsImage( QSize size, const QColor &bgColor = Qt::white,
446 QImage::Format format = QImage::Format_ARGB32_Premultiplied );
448 void setLayerOrder( const QStringList &layers ) override;
449 void setSubLayerVisibility( const QString &name,
bool vis ) override;
450 QDateTime timestamp() const override;
462 bool writeSld( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QVariantMap &props = QVariantMap() ) const;
472 bool ignoreExtents() const;
478 void showStatusMessage( const QString &message );
493 void subsetStringChanged();
499 bool writeSymbology( QDomNode &, QDomDocument &doc, QString &errorMessage,
501 bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage,
503 bool writeXml( QDomNode &layer_node, QDomDocument &doc, const
QgsReadWriteContext &context ) const override;
504 QString encodedSource( const QString &source, const
QgsReadWriteContext &context ) const override;
505 QString decodedSource( const QString &source, const QString &provider, const
QgsReadWriteContext &context ) const override;
512 void closeDataProvider();
518 void setRendererForDrawingStyle(
Qgis::RasterDrawingStyle drawingStyle );
524 bool generateLookupTableFlag,
530 void computeMinMax(
int band,
535 double &min,
double &max );
548 void setDataSourcePrivate( const QString &dataSource, const QString &baseName, const QString &provider, const
QgsDataProvider::ProviderOptions &options,
QgsDataProvider::
ReadFlags flags ) override;
557 void writeRasterAttributeTableExternalPaths( QDomNode &layerNode, QDomDocument &doc, const
QgsReadWriteContext &context ) const;
565 void readRasterAttributeTableExternalPaths( const QDomNode &layerNode,
QgsReadWriteContext &context ) const;
568 const QString QSTRING_NOT_SET;
569 const QString TRSTRING_NOT_SET;
580 QDateTime mLastModified;
584 Qgis::RasterLayerType mRasterType =
Qgis::RasterLayerType::GrayOrUndefined;
589 QgsRectangle mLastRectangleUsedByRefreshContrastEnhancementIfNeeded;
591 QDomDocument mOriginalStyleDocument;
592 QDomElement mOriginalStyleElement;
The Qgis class provides global constants for use throughout the application.
RasterResamplingStage
Stage at which raster resampling occurs.
QFlags< MapLayerProperty > MapLayerProperties
Map layer properties.
Abstract base class for objects which generate elevation profiles.
Interface for classes which can generate elevation profiles.
Brightness/contrast and gamma correction filter pipe for rasters.
Manipulates raster or point cloud pixel values so that they enhanceContrast or clip into a specified ...
ContrastEnhancementAlgorithm
This enumerator describes the types of contrast enhancement algorithms that can be used.
Contains information about the context in which a coordinate transform is executed.
Abstract base class for spatial data provider implementations.
Color and saturation filter pipe for rasters.
Base class for storage of map layer elevation properties.
Base class for utility classes that encapsulate information necessary for rendering of map layers.
Base class for storage of map layer temporal properties.
Base class for all map layer types.
QFlags< ReadFlag > ReadFlags
QString providerType() const
Returns the provider type (provider key) for this layer.
virtual void setOpacity(double opacity)
Sets the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1....
virtual Qgis::MapLayerProperties properties() const
Returns the map layer properties of this layer.
QFlags< StyleCategory > StyleCategories
virtual QString htmlMetadata() const
Obtain a formatted HTML string containing assorted metadata for this layer.
virtual QgsMapLayer * clone() const =0
Returns a new instance equivalent to this one except for the id which is still unique.
virtual Q_INVOKABLE QgsDataProvider * dataProvider()
Returns the layer's data provider, it may be nullptr.
Perform transforms between map coordinates and device coordinates.
Encapsulates properties and constraints relating to fetching elevation profiles from different source...
The QgsRasterAttributeTable class represents a Raster Attribute Table (RAT).
Base class for raster data providers.
Raster layer specific subclass of QgsMapLayerElevationProperties.
Implementation of map layer temporal properties for raster layers.
Represents a raster layer.
static const QgsContrastEnhancement::ContrastEnhancementAlgorithm MULTIPLE_BAND_SINGLE_BYTE_ENHANCEMENT_ALGORITHM
Default enhancement algorithm for multiple band raster of type Byte.
QgsRasterPipe * pipe()
Returns the raster pipe.
static const QgsRasterMinMaxOrigin::Limits SINGLE_BAND_MIN_MAX_LIMITS
Default enhancement limits for single band raster.
static const QgsRasterMinMaxOrigin::Limits MULTIPLE_BAND_MULTI_BYTE_MIN_MAX_LIMITS
Default enhancement limits for multiple band raster of type different from Byte.
static const double SAMPLE_SIZE
Default sample size (number of pixels) for estimated statistics/histogram calculation.
static const QgsRasterMinMaxOrigin::Limits MULTIPLE_BAND_SINGLE_BYTE_MIN_MAX_LIMITS
Default enhancement limits for multiple band raster of type Byte.
static const QgsContrastEnhancement::ContrastEnhancementAlgorithm MULTIPLE_BAND_MULTI_BYTE_ENHANCEMENT_ALGORITHM
Default enhancement algorithm for multiple band raster of type different from Byte.
static const QgsContrastEnhancement::ContrastEnhancementAlgorithm SINGLE_BAND_ENHANCEMENT_ALGORITHM
Default enhancement algorithm for single band raster.
This class describes the origin of min/max values.
Limits
This enumerator describes the limits used to compute min/max values.
Contains a pipeline of raster interfaces for sequential raster processing.
Raster renderer pipe that applies colors to a raster.
Resample filter pipe for rasters.
The class is used as a container of context for various read/write operations on other objects.
A rectangle specified with double values.
Contains information about the context of a rendering operation.
A boolean settings entry.
An interface for classes which can visit style entity (e.g.
std::unique_ptr< GEOSGeometry, GeosDeleter > unique_ptr
Scoped GEOS pointer.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into allowing algorithms to be written in pure substantial changes are required in order to port existing x Processing algorithms for QGIS x The most significant changes are outlined not GeoAlgorithm For algorithms which operate on features one by consider subclassing the QgsProcessingFeatureBasedAlgorithm class This class allows much of the boilerplate code for looping over features from a vector layer to be bypassed and instead requires implementation of a processFeature method Ensure that your algorithm(or algorithm 's parent class) implements the new pure virtual createInstance(self) call
QList< QPair< QString, QColor > > QgsLegendColorList
Setting options for loading raster layers.
LayerOptions(bool loadDefaultStyle=true, const QgsCoordinateTransformContext &transformContext=QgsCoordinateTransformContext())
Constructor for LayerOptions.
This class provides details of the viewable area that a raster will be rendered into.