QGIS API Documentation 3.38.0-Grenoble (exported)
Loading...
Searching...
No Matches
Classes | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
QgsRasterLayer Class Reference

Represents a raster layer. More...

#include <qgsrasterlayer.h>

Inheritance diagram for QgsRasterLayer:
Inheritance graph
[legend]

Classes

struct  LayerOptions
 Setting options for loading raster layers. More...
 

Public Slots

virtual void setTransformContext (const QgsCoordinateTransformContext &transformContext) override
 Sets the coordinate transform context to transformContext.
 
void showStatusMessage (const QString &message)
 
- Public Slots inherited from QgsMapLayer
void emitStyleChanged ()
 Triggers an emission of the styleChanged() signal.
 
QgsProjectproject () const
 Returns the parent project if this map layer is added to a project.
 
virtual bool setDependencies (const QSet< QgsMapLayerDependency > &layers)
 Sets the list of dependencies.
 
void setMaximumScale (double scale)
 Sets the maximum map scale (i.e.
 
void setMinimumScale (double scale)
 Sets the minimum map scale (i.e.
 
void setRefreshOnNofifyMessage (const QString &message)
 Set the notification message that triggers repaint If refresh on notification is enabled, the notification will triggerRepaint only if the notification message is equal to.
 
void setRefreshOnNotifyEnabled (bool enabled)
 Set whether provider notification is connected to triggerRepaint.
 
void setScaleBasedVisibility (bool enabled)
 Sets whether scale based visibility is enabled for the layer.
 
virtual void setTransformContext (const QgsCoordinateTransformContext &transformContext)=0
 Sets the coordinate transform context to transformContext.
 
void trigger3DUpdate ()
 Will advise any 3D maps that this layer requires to be updated in the scene.
 
void triggerRepaint (bool deferredUpdate=false)
 Will advise the map canvas (and any other interested party) that this layer requires to be repainted.
 

Signals

void subsetStringChanged ()
 Emitted when the layer's subset string has changed.
 
- Signals inherited from QgsMapLayer
void autoRefreshIntervalChanged (int interval)
 Emitted when the auto refresh interval changes.
 
void beforeResolveReferences (QgsProject *project)
 Emitted when all layers are loaded and references can be resolved, just before the references of this layer are resolved.
 
void blendModeChanged (QPainter::CompositionMode blendMode)
 Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode()
 
void configChanged ()
 Emitted whenever the configuration is changed.
 
void crs3DChanged ()
 Emitted when the crs3D() of the layer has changed.
 
void crsChanged ()
 Emitted when the crs() of the layer has changed.
 
void customPropertyChanged (const QString &key)
 Emitted when a custom property of the layer has been changed or removed.
 
void dataChanged ()
 Data of layer changed.
 
void dataSourceChanged ()
 Emitted whenever the layer's data source has been changed.
 
void dependenciesChanged ()
 Emitted when dependencies are changed.
 
void editingStarted ()
 Emitted when editing on this layer has started.
 
void editingStopped ()
 Emitted when edited changes have been successfully written to the data provider.
 
void flagsChanged ()
 Emitted when layer's flags have been modified.
 
void idChanged (const QString &id)
 Emitted when the layer's ID has been changed.
 
void isValidChanged ()
 Emitted when the validity of this layer changed.
 
void layerModified ()
 Emitted when modifications has been done on layer.
 
void legendChanged ()
 Signal emitted when legend of the layer has changed.
 
void mapTipsEnabledChanged ()
 Emitted when map tips are enabled or disabled for the layer.
 
void mapTipTemplateChanged ()
 Emitted when the map tip template changes.
 
void metadataChanged ()
 Emitted when the layer's metadata is changed.
 
void nameChanged ()
 Emitted when the name has been changed.
 
void opacityChanged (double opacity)
 Emitted when the layer's opacity is changed, where opacity is a value between 0 (transparent) and 1 (opaque).
 
void recalculateExtents () const
 This is used to send a request that any mapcanvas using this layer update its extents.
 
void renderer3DChanged ()
 Signal emitted when 3D renderer associated with the layer has changed.
 
void rendererChanged ()
 Signal emitted when renderer is changed.
 
void repaintRequested (bool deferredUpdate=false)
 By emitting this signal the layer tells that either appearance or content have been changed and any view showing the rendered layer should refresh itself.
 
void request3DUpdate ()
 Signal emitted when a layer requires an update in any 3D maps.
 
void statusChanged (const QString &status)
 Emit a signal with status (e.g. to be caught by QgisApp and display a msg on status bar)
 
void styleChanged ()
 Signal emitted whenever a change affects the layer's style.
 
void styleLoaded (QgsMapLayer::StyleCategories categories)
 Emitted when a style has been loaded.
 
void verticalCrsChanged ()
 Emitted when the verticalCrs() of the layer has changed.
 
void willBeDeleted ()
 Emitted in the destructor when the layer is about to be deleted, but it is still in a perfectly valid state: the last chance for other pieces of code for some cleanup if they use the layer.
 

Public Member Functions

 QgsRasterLayer ()
 Constructor. Provider is not set.
 
 QgsRasterLayer (const QString &uri, const QString &baseName=QString(), const QString &providerType="gdal", const QgsRasterLayer::LayerOptions &options=QgsRasterLayer::LayerOptions())
 This is the constructor for the RasterLayer class.
 
 ~QgsRasterLayer () override
 
bool accept (QgsStyleEntityVisitorInterface *visitor) const override
 Accepts the specified symbology visitor, causing it to visit all symbols associated with the layer.
 
QgsRasterAttributeTableattributeTable (int bandNumber) const
 Returns the (possibly NULL) raster attribute table for the given band bandNumber.
 
int attributeTableCount () const
 Returns the number of attribute tables for the raster by counting the number of bands that have an associated attribute table.
 
int bandCount () const
 Returns the number of bands in this layer.
 
QString bandName (int bandNoInt) const
 Returns the name of a band given its number.
 
QgsBrightnessContrastFilterbrightnessFilter () const
 Returns the raster's brightness/contrast filter.
 
bool canCreateRasterAttributeTable ()
 Returns true if the raster renderer is suitable for creation of a raster attribute table.
 
QgsRasterLayerclone () const override
 Returns a new instance equivalent to this one.
 
QgsMapLayerRenderercreateMapRenderer (QgsRenderContext &rendererContext) override
 Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context.
 
QgsAbstractProfileGeneratorcreateProfileGenerator (const QgsProfileRequest &request) override
 Given a profile request, returns a new profile generator ready for generating elevation profiles.
 
const QgsRasterDataProviderdataProvider () const override
 Returns the source data provider.
 
QgsRasterDataProviderdataProvider () override
 Returns the source data provider.
 
bool defaultContrastEnhancementSettings (QgsContrastEnhancement::ContrastEnhancementAlgorithm &myAlgorithm, QgsRasterMinMaxOrigin::Limits &myLimits) const
 Returns default contrast enhancement settings for that type of raster.
 
void draw (QPainter *theQPainter, QgsRasterViewPort *myRasterViewPort, const QgsMapToPixel *qgsMapToPixel=nullptr)
 This is an overloaded version of the draw() function that is called by both draw() and thumbnailAsPixmap.
 
QgsMapLayerElevationPropertieselevationProperties () override
 Returns the layer's elevation properties.
 
int height () const
 Returns the height of the (unclipped) raster.
 
QString htmlMetadata () const override
 Obtain a formatted HTML string containing assorted metadata for this layer.
 
QgsHueSaturationFilterhueSaturationFilter () const
 Returns the raster's hue/saturation filter.
 
bool ignoreExtents () const
 If the ignoreExtent flag is set, the layer will also render outside the bounding box reported by the data provider.
 
bool isSpatial () const override
 Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated with it.
 
Q_DECL_DEPRECATED QgsLegendColorList legendSymbologyItems () const
 Returns a list with classification items (Text and color).
 
double opacity () const FINAL
 Returns the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).
 
QPixmap paletteAsPixmap (int bandNumber=1)
 Returns a 100x100 pixmap of the color palette.
 
QgsRasterPipepipe ()
 Returns the raster pipe.
 
QImage previewAsImage (QSize size, const QColor &bgColor=Qt::white, QImage::Format format=QImage::Format_ARGB32_Premultiplied)
 Draws a preview of the rasterlayer into a QImage.
 
Qgis::MapLayerProperties properties () const override
 Returns the map layer properties of this layer.
 
QString providerType () const
 [ data provider interface ] Which provider is being used for this Raster Layer?
 
Qgis::RasterLayerType rasterType () const
 Returns the raster layer type (which is a read only property).
 
double rasterUnitsPerPixelX () const
 Returns the number of raster units per each raster pixel in X axis.
 
double rasterUnitsPerPixelY () const
 Returns the number of raster units per each raster pixel in Y axis.
 
void refreshContrastEnhancement (const QgsRectangle &extent)
 Refresh contrast enhancement with new extent.
 
void refreshRendererIfNeeded (QgsRasterRenderer *rasterRenderer, const QgsRectangle &extent)
 Refresh renderer with new extent, if needed.
 
void reload () override
 Synchronises with changes in the datasource.
 
QgsRasterRendererrenderer () const
 Returns the raster's renderer.
 
QgsRasterResampleFilterresampleFilter () const
 Returns the raster's resample filter.
 
Qgis::RasterResamplingStage resamplingStage () const
 Returns which stage of the pipe should apply resampling.
 
void setContrastEnhancement (QgsContrastEnhancement::ContrastEnhancementAlgorithm algorithm, QgsRasterMinMaxOrigin::Limits limits=QgsRasterMinMaxOrigin::MinMax, const QgsRectangle &extent=QgsRectangle(), int sampleSize=QgsRasterLayer::SAMPLE_SIZE, bool generateLookupTableFlag=true)
 Set contrast enhancement algorithm.
 
Q_DECL_DEPRECATED void setDataProvider (const QString &provider)
 Set the data provider.
 
void setDataProvider (const QString &provider, const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags=QgsDataProvider::ReadFlags())
 Set the data provider.
 
void setDefaultContrastEnhancement ()
 Sets the default contrast enhancement.
 
void setLayerOrder (const QStringList &layers) override
 Reorders the previously selected sublayers of this layer from bottom to top.
 
void setOpacity (double opacity) FINAL
 Sets the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).
 
void setRenderer (QgsRasterRenderer *renderer)
 Sets the raster's renderer.
 
void setResamplingStage (Qgis::RasterResamplingStage stage)
 Select which stage of the pipe should apply resampling.
 
void setSubLayerVisibility (const QString &name, bool vis) override
 Set the visibility of the given sublayer name.
 
virtual bool setSubsetString (const QString &subset)
 Sets the string (typically sql) used to define a subset of the layer.
 
QStringList subLayers () const override
 Returns the sublayers of this layer.
 
virtual QString subsetString () const
 Returns the string (typically sql) used to define a subset of the layer.
 
QgsMapLayerTemporalPropertiestemporalProperties () override
 Returns the layer's temporal properties.
 
QDateTime timestamp () const override
 Time stamp of data source in the moment when data/metadata were loaded by provider.
 
int width () const
 Returns the width of the (unclipped) raster.
 
bool writeSld (QDomNode &node, QDomDocument &doc, QString &errorMessage, const QVariantMap &props=QVariantMap()) const
 Writes the symbology of the layer into the document provided in SLD 1.0.0 format.
 
- Public Member Functions inherited from QgsMapLayer
 QgsMapLayer (Qgis::LayerType type=Qgis::LayerType::Vector, const QString &name=QString(), const QString &source=QString())
 Constructor for QgsMapLayer.
 
 QgsMapLayer (QgsMapLayer const &)=delete
 QgsMapLayer cannot be copied.
 
 ~QgsMapLayer () override
 
Q_DECL_DEPRECATED QString abstract () const
 Returns the abstract of the layer used by QGIS Server in GetCapabilities request.
 
Q_DECL_DEPRECATED QString attribution () const
 Returns the attribution of the layer used by QGIS Server in GetCapabilities request.
 
Q_DECL_DEPRECATED QString attributionUrl () const
 Returns the attribution URL of the layer used by QGIS Server in GetCapabilities request.
 
int autoRefreshInterval () const
 Returns the auto refresh interval (in milliseconds).
 
Qgis::AutoRefreshMode autoRefreshMode () const
 Returns the layer's automatic refresh mode.
 
QPainter::CompositionMode blendMode () const
 Returns the current blending mode for a layer.
 
QgsCoordinateReferenceSystem crs () const
 Returns the layer's spatial reference system.
 
QgsCoordinateReferenceSystem crs3D () const
 Returns the CRS to use for the layer when transforming 3D data, or when z/elevation value handling is important.
 
template<class T >
customEnumProperty (const QString &key, const T &defaultValue)
 Returns the property value for a property based on an enum.
 
template<class T >
customFlagProperty (const QString &key, const T &defaultValue)
 Returns the property value for a property based on a flag.
 
const QgsObjectCustomPropertiescustomProperties () const
 Read all custom properties from layer.
 
Q_INVOKABLE QVariant customProperty (const QString &value, const QVariant &defaultValue=QVariant()) const
 Read a custom property from layer.
 
Q_INVOKABLE QStringList customPropertyKeys () const
 Returns list of all keys within custom properties.
 
Q_DECL_DEPRECATED QString dataUrl () const
 Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request.
 
Q_DECL_DEPRECATED QString dataUrlFormat () const
 Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities request.
 
virtual bool deleteStyleFromDatabase (const QString &styleId, QString &msgError)
 Deletes a style from the database.
 
virtual QSet< QgsMapLayerDependencydependencies () const
 Gets the list of dependencies.
 
virtual QgsError error () const
 Gets current status error.
 
void exportNamedMetadata (QDomDocument &doc, QString &errorMsg) const
 Export the current metadata of this layer as named metadata in a QDomDocument.
 
virtual void exportNamedStyle (QDomDocument &doc, QString &errorMsg, const QgsReadWriteContext &context=QgsReadWriteContext(), QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) const
 Export the properties of this layer as named style in a QDomDocument.
 
virtual void exportSldStyle (QDomDocument &doc, QString &errorMsg) const
 Export the properties of this layer as SLD style in a QDomDocument.
 
virtual void exportSldStyleV2 (QDomDocument &doc, QString &errorMsg, const QgsSldExportContext &exportContext) const
 Export the properties of this layer as SLD style in a QDomDocument.
 
virtual QgsRectangle extent () const
 Returns the extent of the layer.
 
virtual QgsBox3D extent3D () const
 Returns the 3D extent of the layer.
 
QgsMapLayer::LayerFlags flags () const
 Returns the flags for this layer.
 
virtual QString getStyleFromDatabase (const QString &styleId, QString &msgError)
 Returns the named style corresponding to style id provided.
 
Q_DECL_DEPRECATED bool hasAutoRefreshEnabled () const
 Returns true if auto refresh is enabled for the layer.
 
virtual bool hasMapTips () const
 Returns true if the layer contains map tips.
 
bool hasScaleBasedVisibility () const
 Returns whether scale based visibility is enabled for the layer.
 
QString id () const
 Returns the layer's unique ID, which is used to access this layer from QgsProject.
 
bool importNamedMetadata (QDomDocument &document, QString &errorMessage)
 Import the metadata of this layer from a QDomDocument.
 
virtual bool importNamedStyle (QDomDocument &doc, QString &errorMsg, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories)
 Import the properties of this layer from a QDomDocument.
 
virtual bool isEditable () const
 Returns true if the layer can be edited.
 
bool isInScaleRange (double scale) const
 Tests whether the layer should be visible at the specified scale.
 
virtual bool isModified () const
 Returns true if the layer has been modified since last commit/save.
 
bool isRefreshOnNotifyEnabled () const
 Returns true if the refresh on provider nofification is enabled.
 
virtual bool isTemporary () const
 Returns true if the layer is considered a temporary layer.
 
bool isValid () const
 Returns the status of the layer.
 
Q_DECL_DEPRECATED QString keywordList () const
 Returns the keyword list of the layer used by QGIS Server in GetCapabilities request.
 
QgsMapLayerLegendlegend () const
 Can be nullptr.
 
QString legendPlaceholderImage () const
 Returns path to the placeholder image or an empty string if a generated legend is shown.
 
QString legendUrl () const
 Returns the URL for the layer's legend.
 
QString legendUrlFormat () const
 Returns the format for a URL based layer legend.
 
virtual int listStylesInDatabase (QStringList &ids, QStringList &names, QStringList &descriptions, QString &msgError)
 Lists all the style in db split into related to the layer and not related to.
 
virtual QString loadDefaultMetadata (bool &resultFlag)
 Retrieve the default metadata for this layer if one exists (either as a .qmd file on disk or as a record in the users metadata table in their personal qgis.db)
 
virtual QString loadDefaultStyle (bool &resultFlag)
 Retrieve the default style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)
 
virtual QString loadNamedMetadata (const QString &uri, bool &resultFlag)
 Retrieve a named metadata for this layer if one exists (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db)
 
bool loadNamedMetadataFromDatabase (const QString &db, const QString &uri, QString &qmd)
 Retrieve a named metadata for this layer from a sqlite database.
 
virtual QString loadNamedStyle (const QString &theURI, bool &resultFlag, bool loadFromLocalDb, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories, Qgis::LoadStyleFlags flags=Qgis::LoadStyleFlags())
 Loads a named style from file/local db/datasource db.
 
virtual QString loadNamedStyle (const QString &uri, bool &resultFlag, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories, Qgis::LoadStyleFlags flags=Qgis::LoadStyleFlags())
 Retrieve a named style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)
 
virtual bool loadNamedStyleFromDatabase (const QString &db, const QString &uri, QString &qml)
 Retrieve a named style for this layer from a sqlite database.
 
virtual QString loadSldStyle (const QString &uri, bool &resultFlag)
 Attempts to style the layer using the formatting from an SLD type file.
 
bool mapTipsEnabled () const
 Returns true if map tips are enabled for this layer.
 
QString mapTipTemplate () const
 The mapTip is a pretty, html representation for feature information.
 
double maximumScale () const
 Returns the maximum map scale (i.e.
 
virtual const QgsLayerMetadatametadata () const
 Returns a reference to the layer's metadata store.
 
virtual QString metadataUri () const
 Retrieve the metadata URI for this layer (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db)
 
Q_DECL_DEPRECATED QString metadataUrl () const
 Returns the metadata URL of the layer used by QGIS Server in GetCapabilities request.
 
Q_DECL_DEPRECATED QString metadataUrlFormat () const
 Returns the metadata format of the layer used by QGIS Server in GetCapabilities request.
 
Q_DECL_DEPRECATED QString metadataUrlType () const
 Returns the metadata type of the layer used by QGIS Server in GetCapabilities request.
 
double minimumScale () const
 Returns the minimum map scale (i.e.
 
QString name () const
 Returns the display name of the layer.
 
QgsMapLayeroperator= (QgsMapLayer const &)=delete
 QgsMapLayer cannot be copied.
 
QString originalXmlProperties () const
 Returns the XML properties of the original layer as they were when the layer was first read from the project file.
 
QString providerType () const
 Returns the provider type (provider key) for this layer.
 
QString publicSource (bool hidePassword=false) const
 Gets a version of the internal layer definition that has sensitive bits removed (for example, the password).
 
bool readLayerXml (const QDomElement &layerElement, QgsReadWriteContext &context, QgsMapLayer::ReadFlags flags=QgsMapLayer::ReadFlags(), QgsDataProvider *preloadedProvider=nullptr)
 Sets state from DOM document.
 
bool readOnly () const
 Returns if this layer is read only.
 
virtual bool readSld (const QDomNode &node, QString &errorMessage)
 
QString refreshOnNotifyMessage () const
 Returns the message that should be notified by the provider to triggerRepaint.
 
void removeCustomProperty (const QString &key)
 Remove a custom property from layer.
 
QgsAbstract3DRendererrenderer3D () const
 Returns 3D renderer associated with the layer.
 
virtual void resolveReferences (QgsProject *project)
 Resolve references to other layers (kept as layer IDs after reading XML) into layer objects.
 
virtual QString saveDefaultMetadata (bool &resultFlag)
 Save the current metadata of this layer as the default metadata (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db)
 
virtual Q_DECL_DEPRECATED QString saveDefaultStyle (bool &resultFlag)
 Save the properties of this layer as the default style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)
 
virtual QString saveDefaultStyle (bool &resultFlag, StyleCategories categories)
 Save the properties of this layer as the default style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)
 
QString saveNamedMetadata (const QString &uri, bool &resultFlag)
 Save the current metadata of this layer as a named metadata (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db)
 
virtual QString saveNamedStyle (const QString &uri, bool &resultFlag, StyleCategories categories=AllStyleCategories)
 Save the properties of this layer as a named style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)
 
virtual QString saveSldStyle (const QString &uri, bool &resultFlag) const
 Saves the properties of this layer to an SLD format file.
 
virtual QString saveSldStyleV2 (bool &resultFlag, const QgsSldExportContext &exportContext) const
 Saves the properties of this layer to an SLD format file.
 
virtual void saveStyleToDatabase (const QString &name, const QString &description, bool useAsDefault, const QString &uiFileContent, QString &msgError, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories)
 Saves named and sld style of the layer to the style table in the db.
 
virtual QgsMapLayerSelectionPropertiesselectionProperties ()
 Returns the layer's selection properties.
 
QgsMapLayerServerPropertiesserverProperties ()
 Returns QGIS Server Properties for the map layer.
 
const QgsMapLayerServerPropertiesserverProperties () const
 Returns QGIS Server Properties const for the map layer.
 
Q_DECL_DEPRECATED void setAbstract (const QString &abstract)
 Sets the abstract of the layer used by QGIS Server in GetCapabilities request.
 
Q_DECL_DEPRECATED void setAttribution (const QString &attrib)
 Sets the attribution of the layerused by QGIS Server in GetCapabilities request.
 
Q_DECL_DEPRECATED void setAttributionUrl (const QString &attribUrl)
 Sets the attribution URL of the layer used by QGIS Server in GetCapabilities request.
 
Q_DECL_DEPRECATED void setAutoRefreshEnabled (bool enabled)
 Sets whether auto refresh is enabled for the layer.
 
void setAutoRefreshInterval (int interval)
 Sets the auto refresh interval (in milliseconds) for the layer.
 
void setAutoRefreshMode (Qgis::AutoRefreshMode mode)
 Sets the automatic refresh mode for the layer.
 
void setBlendMode (QPainter::CompositionMode blendMode)
 Set the blending mode used for rendering a layer.
 
void setCrs (const QgsCoordinateReferenceSystem &srs, bool emitSignal=true)
 Sets layer's spatial reference system.
 
template<class T >
void setCustomEnumProperty (const QString &key, const T &value)
 Set the value of a property based on an enum.
 
template<class T >
void setCustomFlagProperty (const QString &key, const T &value)
 Set the value of a property based on a flag.
 
void setCustomProperties (const QgsObjectCustomProperties &properties)
 Set custom properties for layer.
 
Q_INVOKABLE void setCustomProperty (const QString &key, const QVariant &value)
 Set a custom property for layer.
 
void setDataSource (const QString &dataSource, const QString &baseName, const QString &provider, bool loadDefaultStyleFlag=false)
 Updates the data source of the layer.
 
void setDataSource (const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, bool loadDefaultStyleFlag=false)
 Updates the data source of the layer.
 
void setDataSource (const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags)
 Updates the data source of the layer.
 
Q_DECL_DEPRECATED void setDataUrl (const QString &dataUrl)
 Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request.
 
Q_DECL_DEPRECATED void setDataUrlFormat (const QString &dataUrlFormat)
 Sets the DataUrl format of the layer used by QGIS Server in GetCapabilities request.
 
void setFlags (QgsMapLayer::LayerFlags flags)
 Returns the flags for this layer.
 
bool setId (const QString &id)
 Sets the layer's id.
 
Q_DECL_DEPRECATED void setKeywordList (const QString &keywords)
 Sets the keyword list of the layerused by QGIS Server in GetCapabilities request.
 
void setLegend (QgsMapLayerLegend *legend)
 Assign a legend controller to the map layer.
 
void setLegendPlaceholderImage (const QString &imgPath)
 Set placeholder image for legend.
 
void setLegendUrl (const QString &legendUrl)
 Sets the URL for the layer's legend.
 
void setLegendUrlFormat (const QString &legendUrlFormat)
 Sets the format for a URL based layer legend.
 
void setMapTipsEnabled (bool enabled)
 Enable or disable map tips for this layer.
 
void setMapTipTemplate (const QString &mapTipTemplate)
 The mapTip is a pretty, html representation for feature information.
 
virtual void setMetadata (const QgsLayerMetadata &metadata)
 Sets the layer's metadata store.
 
Q_DECL_DEPRECATED void setMetadataUrl (const QString &metaUrl)
 Sets the metadata URL of the layer used by QGIS Server in GetCapabilities request.
 
Q_DECL_DEPRECATED void setMetadataUrlFormat (const QString &metaUrlFormat)
 Sets the metadata format of the layer used by QGIS Server in GetCapabilities request.
 
Q_DECL_DEPRECATED void setMetadataUrlType (const QString &metaUrlType)
 Set the metadata type of the layer used by QGIS Server in GetCapabilities request MetadataUrlType indicates the standard to which the metadata complies.
 
void setName (const QString &name)
 Set the display name of the layer.
 
void setOriginalXmlProperties (const QString &originalXmlProperties)
 Sets the original XML properties for the layer to originalXmlProperties.
 
void setRenderer3D (QgsAbstract3DRenderer *renderer)
 Sets 3D renderer for the layer.
 
Q_DECL_DEPRECATED void setShortName (const QString &shortName)
 Sets the short name of the layer used by QGIS Server to identify the layer.
 
Q_DECL_DEPRECATED void setTitle (const QString &title)
 Sets the title of the layer used by QGIS Server in GetCapabilities request.
 
bool setVerticalCrs (const QgsCoordinateReferenceSystem &crs, QString *errorMessage=nullptr)
 Sets the layer's vertical coordinate reference system.
 
Q_DECL_DEPRECATED QString shortName () const
 Returns the short name of the layer used by QGIS Server to identify the layer.
 
QString source () const
 Returns the source for the layer.
 
QgsMapLayerStyleManagerstyleManager () const
 Gets access to the layer's style manager.
 
virtual QString styleURI () const
 Retrieve the style URI for this layer (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)
 
virtual bool supportsEditing () const
 Returns whether the layer supports editing or not.
 
Q_DECL_DEPRECATED QString title () const
 Returns the title of the layer used by QGIS Server in GetCapabilities request.
 
QgsCoordinateTransformContext transformContext () const
 Returns the layer data provider coordinate transform context or a default transform context if the layer does not have a valid data provider.
 
Qgis::LayerType type () const
 Returns the type of the layer.
 
QUndoStack * undoStack ()
 Returns pointer to layer's undo stack.
 
QUndoStack * undoStackStyles ()
 Returns pointer to layer's style undo stack.
 
QgsCoordinateReferenceSystem verticalCrs () const
 Returns the layer's vertical coordinate reference system.
 
QgsRectangle wgs84Extent (bool forceRecalculate=false) const
 Returns the WGS84 extent (EPSG:4326) of the layer according to ReadFlag::FlagTrustLayerMetadata.
 
bool writeLayerXml (QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context) const
 Stores state in DOM node.
 
- Public Member Functions inherited from QgsAbstractProfileSource
virtual ~QgsAbstractProfileSource ()
 

Static Public Member Functions

static bool isValidRasterFileName (const QString &fileNameQString)
 
static bool isValidRasterFileName (const QString &fileNameQString, QString &retError)
 This helper checks to see whether the file name appears to be a valid raster file name.
 
static QDateTime lastModified (const QString &name)
 Returns time stamp for given file name.
 
- Static Public Member Functions inherited from QgsMapLayer
static QString extensionPropertyType (PropertyType type)
 Returns the extension of a Property.
 
static QString formatLayerName (const QString &name)
 A convenience function to capitalize and format a layer name.
 
static QString generateId (const QString &layerName)
 Generates an unique identifier for this layer, the generate ID is prefixed by layerName.
 
static QgsDataProvider::ReadFlags providerReadFlags (const QDomNode &layerNode, QgsMapLayer::ReadFlags layerReadFlags)
 Returns provider read flag deduced from layer read flags layerReadFlags and a dom node layerNode that describes a layer (corresponding to `‘maplayer’' tag in a DOM document project file read by QgsProject).
 

Static Public Attributes

static const QgsContrastEnhancement::ContrastEnhancementAlgorithm MULTIPLE_BAND_MULTI_BYTE_ENHANCEMENT_ALGORITHM = QgsContrastEnhancement::StretchToMinimumMaximum
 Default enhancement algorithm for multiple band raster of type different from Byte.
 
static const QgsRasterMinMaxOrigin::Limits MULTIPLE_BAND_MULTI_BYTE_MIN_MAX_LIMITS = QgsRasterMinMaxOrigin::CumulativeCut
 Default enhancement limits for multiple band raster of type different from Byte.
 
static const QgsContrastEnhancement::ContrastEnhancementAlgorithm MULTIPLE_BAND_SINGLE_BYTE_ENHANCEMENT_ALGORITHM = QgsContrastEnhancement::NoEnhancement
 Default enhancement algorithm for multiple band raster of type Byte.
 
static const QgsRasterMinMaxOrigin::Limits MULTIPLE_BAND_SINGLE_BYTE_MIN_MAX_LIMITS = QgsRasterMinMaxOrigin::MinMax
 Default enhancement limits for multiple band raster of type Byte.
 
static const double SAMPLE_SIZE = 250000
 Default sample size (number of pixels) for estimated statistics/histogram calculation.
 
static const QgsSettingsEntryBoolsettingsRasterDefaultEarlyResampling = new QgsSettingsEntryBool( QStringLiteral( "default-early-resampling" ), QgsSettingsTree::sTreeRaster, false )
 
static const QgsSettingsEntryDoublesettingsRasterDefaultOversampling = new QgsSettingsEntryDouble( QStringLiteral( "default-oversampling" ), QgsSettingsTree::sTreeRaster, 2.0 )
 
static const QgsContrastEnhancement::ContrastEnhancementAlgorithm SINGLE_BAND_ENHANCEMENT_ALGORITHM = QgsContrastEnhancement::StretchToMinimumMaximum
 Default enhancement algorithm for single band raster.
 
static const QgsRasterMinMaxOrigin::Limits SINGLE_BAND_MIN_MAX_LIMITS = QgsRasterMinMaxOrigin::MinMax
 Default enhancement limits for single band raster.
 

Protected Member Functions

QString decodedSource (const QString &source, const QString &provider, const QgsReadWriteContext &context) const override
 Called by readLayerXML(), used by derived classes to decode provider's specific data source from project files.
 
QString encodedSource (const QString &source, const QgsReadWriteContext &context) const override
 Called by writeLayerXML(), used by derived classes to encode provider's specific data source to project files.
 
bool readStyle (const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) override
 Read the style for the current layer from the DOM node supplied.
 
bool readSymbology (const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) override
 Read the symbology for the current layer from the DOM node supplied.
 
bool readXml (const QDomNode &layer_node, QgsReadWriteContext &context) override
 Called by readLayerXML(), used by children to read state specific to them from project files.
 
bool writeStyle (QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) const override
 Write just the symbology information for the layer into the document.
 
bool writeSymbology (QDomNode &, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) const override
 Write the style for the layer into the document provided.
 
bool writeXml (QDomNode &layer_node, QDomDocument &doc, const QgsReadWriteContext &context) const override
 Called by writeLayerXML(), used by children to write state specific to them to project files.
 
- Protected Member Functions inherited from QgsMapLayer
void appendError (const QgsErrorMessage &error)
 Add error message.
 
void clone (QgsMapLayer *layer) const
 Copies attributes like name, short name, ... into another layer.
 
QString crsHtmlMetadata () const
 Returns a HTML fragment containing the layer's CRS metadata, for use in the htmlMetadata() method.
 
QString generalHtmlMetadata () const
 Returns an HTML fragment containing general metadata information, for use in the htmlMetadata() method.
 
Q_DECL_DEPRECATED bool hasDependencyCycle (const QSet< QgsMapLayerDependency > &) const
 Checks whether a new set of dependencies will introduce a cycle this method is now deprecated and always return false, because circular dependencies are now correctly managed.
 
void invalidateWgs84Extent ()
 Invalidates the WGS84 extent.
 
void readCommonStyle (const QDomElement &layerElement, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories)
 Read style data common to all layer types.
 
void readCustomProperties (const QDomNode &layerNode, const QString &keyStartsWith=QString())
 Read custom properties from project file.
 
void readStyleManager (const QDomNode &layerNode)
 Read style manager's configuration (if any). To be called by subclasses.
 
void setError (const QgsError &error)
 Sets error message.
 
virtual void setExtent (const QgsRectangle &rect)
 Sets the extent.
 
virtual void setExtent3D (const QgsBox3D &box)
 Sets the extent.
 
void setProviderType (const QString &providerType)
 Sets the providerType (provider key)
 
void setValid (bool valid)
 Sets whether layer is valid or not.
 
void writeCommonStyle (QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) const
 Write style data common to all layer types.
 
void writeCustomProperties (QDomNode &layerNode, QDomDocument &doc) const
 Write custom properties to project file.
 
void writeStyleManager (QDomNode &layerNode, QDomDocument &doc) const
 Write style manager's configuration (if exists). To be called by subclasses.
 

Additional Inherited Members

- Public Types inherited from QgsMapLayer
enum  LayerFlag { Identifiable = 1 << 0 , Removable = 1 << 1 , Searchable = 1 << 2 , Private = 1 << 3 }
 Flags for the map layer. More...
 
typedef QFlags< LayerFlagLayerFlags
 
enum  PropertyType { Style = 0 , Metadata }
 Maplayer has a style and a metadata property. More...
 
enum  ReadFlag { FlagDontResolveLayers = 1 << 0 , FlagTrustLayerMetadata = 1 << 1 , FlagReadExtentFromXml = 1 << 2 , FlagForceReadOnly = 1 << 3 }
 Flags which control project read behavior. More...
 
typedef QFlags< ReadFlagReadFlags
 
typedef QFlags< StyleCategoryStyleCategories
 
enum  StyleCategory {
  LayerConfiguration = 1 << 0 , Symbology = 1 << 1 , Symbology3D = 1 << 2 , Labeling = 1 << 3 ,
  Fields = 1 << 4 , Forms = 1 << 5 , Actions = 1 << 6 , MapTips = 1 << 7 ,
  Diagrams = 1 << 8 , AttributeTable = 1 << 9 , Rendering = 1 << 10 , CustomProperties = 1 << 11 ,
  GeometryOptions = 1 << 12 , Relations = 1 << 13 , Temporal = 1 << 14 , Legend = 1 << 15 ,
  Elevation = 1 << 16 , Notes = 1 << 17 , AllStyleCategories
}
 Categories of style to distinguish appropriate sections for import/export. More...
 
- Protected Attributes inherited from QgsMapLayer
int mBlockStyleChangedSignal = 0
 If non-zero, the styleChanged signal should not be emitted.
 
QString mDataSource
 Data source description string, varies by layer type.
 
QSet< QgsMapLayerDependencymDependencies
 List of layers that may modify this layer on modification.
 
QgsError mError
 Error.
 
bool mIsRefreshOnNofifyEnabled = false
 
QString mLayerName
 Name of the layer - used for display.
 
double mLayerOpacity = 1.0
 Layer opacity.
 
QString mLegendUrl
 WMS legend.
 
QString mLegendUrlFormat
 
std::unique_ptr< QgsDataProvidermPreloadedProvider
 Optionally used when loading a project, it is released when the layer is effectively created.
 
QString mProviderKey
 Data provider key (name of the data provider)
 
QgsMapLayer::ReadFlags mReadFlags = QgsMapLayer::ReadFlags()
 Read flags. It's up to the subclass to respect these when restoring state from XML.
 
QString mRefreshOnNofifyMessage
 
bool mShouldValidateCrs = true
 true if the layer's CRS should be validated and invalid CRSes are not permitted.
 
bool mValid = false
 Indicates if the layer is valid and can be drawn.
 
- Properties inherited from QgsMapLayer
int autoRefreshInterval
 
QgsCoordinateReferenceSystem crs
 
QgsCoordinateReferenceSystem crs3D
 
QString id
 
bool isValid
 
bool mapTipsEnabled
 
QString mapTipTemplate
 
QgsLayerMetadata metadata
 
QString name
 
double opacity
 
Qgis::LayerType type
 
QgsCoordinateReferenceSystem verticalCrs
 

Detailed Description

Represents a raster layer.

A QgsRasterLayer is instantiated by specifying the name of a data provider, such as "gdal" or "wms", and a url defining the specific data set to connect to. The raster layer constructor in turn instantiates a QgsRasterDataProvider subclass corresponding to the provider type, and passes it the url. The data provider connects to the data source.

Sample usage of the QgsRasterLayer class:

my_raster_layer = QgsRasterLayer("/path/to/file.tif", "my layer")
Represents a raster layer.

Definition at line 77 of file qgsrasterlayer.h.

Constructor & Destructor Documentation

◆ QgsRasterLayer() [1/2]

QgsRasterLayer::QgsRasterLayer ( )

Constructor. Provider is not set.

Definition at line 109 of file qgsrasterlayer.cpp.

◆ QgsRasterLayer() [2/2]

QgsRasterLayer::QgsRasterLayer ( const QString &  uri,
const QString &  baseName = QString(),
const QString &  providerType = "gdal",
const QgsRasterLayer::LayerOptions options = QgsRasterLayer::LayerOptions() 
)
explicit

This is the constructor for the RasterLayer class.

The main tasks carried out by the constructor are:

  • Load the rasters default style (.qml) file if it exists
  • Populate the RasterStatsVector with initial values for each band.
  • Calculate the layer extents
  • Determine whether the layer is gray, paletted or multiband.
  • Assign sensible defaults for the red, green, blue and gray bands.

Definition at line 121 of file qgsrasterlayer.cpp.

◆ ~QgsRasterLayer()

QgsRasterLayer::~QgsRasterLayer ( )
override

Definition at line 154 of file qgsrasterlayer.cpp.

Member Function Documentation

◆ accept()

bool QgsRasterLayer::accept ( QgsStyleEntityVisitorInterface visitor) const
overridevirtual

Accepts the specified symbology visitor, causing it to visit all symbols associated with the layer.

Returns true if the visitor should continue visiting other objects, or false if visiting should be canceled.

Since
QGIS 3.10

Reimplemented from QgsMapLayer.

Definition at line 1813 of file qgsrasterlayer.cpp.

◆ attributeTable()

QgsRasterAttributeTable * QgsRasterLayer::attributeTable ( int  bandNumber) const

Returns the (possibly NULL) raster attribute table for the given band bandNumber.

Since
QGIS 3.30

Definition at line 273 of file qgsrasterlayer.cpp.

◆ attributeTableCount()

int QgsRasterLayer::attributeTableCount ( ) const

Returns the number of attribute tables for the raster by counting the number of bands that have an associated attribute table.

Since
QGIS 3.30

Definition at line 282 of file qgsrasterlayer.cpp.

◆ bandCount()

int QgsRasterLayer::bandCount ( ) const

Returns the number of bands in this layer.

Definition at line 257 of file qgsrasterlayer.cpp.

◆ bandName()

QString QgsRasterLayer::bandName ( int  bandNoInt) const

Returns the name of a band given its number.

Definition at line 265 of file qgsrasterlayer.cpp.

◆ brightnessFilter()

QgsBrightnessContrastFilter * QgsRasterLayer::brightnessFilter ( ) const

Returns the raster's brightness/contrast filter.

See also
resampleFilter()
hueSaturationFilter()

Definition at line 2066 of file qgsrasterlayer.cpp.

◆ canCreateRasterAttributeTable()

bool QgsRasterLayer::canCreateRasterAttributeTable ( )

Returns true if the raster renderer is suitable for creation of a raster attribute table.

The supported renderers are QgsPalettedRasterRenderer and QgsSingleBandPseudoColorRenderer.

Since
QGIS 3.30

Definition at line 300 of file qgsrasterlayer.cpp.

◆ clone()

QgsRasterLayer * QgsRasterLayer::clone ( ) const
overridevirtual

Returns a new instance equivalent to this one.

A new provider is created for the same data source and renderer is cloned too.

Returns
a new layer instance

Implements QgsMapLayer.

Definition at line 162 of file qgsrasterlayer.cpp.

◆ createMapRenderer()

QgsMapLayerRenderer * QgsRasterLayer::createMapRenderer ( QgsRenderContext rendererContext)
overridevirtual

Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context.

Implements QgsMapLayer.

Definition at line 338 of file qgsrasterlayer.cpp.

◆ createProfileGenerator()

QgsAbstractProfileGenerator * QgsRasterLayer::createProfileGenerator ( const QgsProfileRequest request)
overridevirtual

Given a profile request, returns a new profile generator ready for generating elevation profiles.

The caller takes ownership of the returned generator.

May return nullptr if the source cannot generate a profile at this time.

Implements QgsAbstractProfileSource.

Definition at line 195 of file qgsrasterlayer.cpp.

◆ dataProvider() [1/2]

const QgsRasterDataProvider * QgsRasterLayer::dataProvider ( ) const
overridevirtual

Returns the source data provider.

This will be nullptr if the layer is invalid.

Reimplemented from QgsMapLayer.

Definition at line 321 of file qgsrasterlayer.cpp.

◆ dataProvider() [2/2]

QgsRasterDataProvider * QgsRasterLayer::dataProvider ( )
overridevirtual

Returns the source data provider.

This will be nullptr if the layer is invalid.

Reimplemented from QgsMapLayer.

Definition at line 314 of file qgsrasterlayer.cpp.

◆ decodedSource()

QString QgsRasterLayer::decodedSource ( const QString &  source,
const QString &  dataProvider,
const QgsReadWriteContext context 
) const
overrideprotectedvirtual

Called by readLayerXML(), used by derived classes to decode provider's specific data source from project files.

Typically resolving absolute or relative paths, usernames and passwords or drivers prefixes ("HDF5:")

Parameters
sourcedata source to decode, typically read from layer's DOM element "datasource"
dataProviderstring identification of data provider (e.g. "ogr"), typically read from layer's DOM element
contextreading context (e.g. for conversion between relative and absolute paths)
Returns
decoded source, typically to be used as the layer's datasource
Since
QGIS 3.2

Reimplemented from QgsMapLayer.

Definition at line 2622 of file qgsrasterlayer.cpp.

◆ defaultContrastEnhancementSettings()

bool QgsRasterLayer::defaultContrastEnhancementSettings ( QgsContrastEnhancement::ContrastEnhancementAlgorithm myAlgorithm,
QgsRasterMinMaxOrigin::Limits myLimits 
) const

Returns default contrast enhancement settings for that type of raster.

Note
not available in Python bindings

Definition at line 1704 of file qgsrasterlayer.cpp.

◆ draw()

void QgsRasterLayer::draw ( QPainter *  theQPainter,
QgsRasterViewPort myRasterViewPort,
const QgsMapToPixel qgsMapToPixel = nullptr 
)

This is an overloaded version of the draw() function that is called by both draw() and thumbnailAsPixmap.

Definition at line 346 of file qgsrasterlayer.cpp.

◆ elevationProperties()

QgsMapLayerElevationProperties * QgsRasterLayer::elevationProperties ( )
overridevirtual

Returns the layer's elevation properties.

This may be nullptr, depending on the layer type.

Since
QGIS 3.18

Reimplemented from QgsMapLayer.

Definition at line 1329 of file qgsrasterlayer.cpp.

◆ encodedSource()

QString QgsRasterLayer::encodedSource ( const QString &  source,
const QgsReadWriteContext context 
) const
overrideprotectedvirtual

Called by writeLayerXML(), used by derived classes to encode provider's specific data source to project files.

Typically resolving absolute or relative paths, usernames and passwords or drivers prefixes ("HDF5:")

Parameters
sourcedata source to encode, typically QgsMapLayer::source()
contextwriting context (e.g. for conversion between relative and absolute paths)
Returns
encoded source, typically to be written in the DOM element "datasource"
Since
QGIS 3.2

Reimplemented from QgsMapLayer.

Definition at line 2615 of file qgsrasterlayer.cpp.

◆ height()

int QgsRasterLayer::height ( ) const

Returns the height of the (unclipped) raster.

See also
width()

Definition at line 2637 of file qgsrasterlayer.cpp.

◆ htmlMetadata()

QString QgsRasterLayer::htmlMetadata ( ) const
overridevirtual

Obtain a formatted HTML string containing assorted metadata for this layer.

Reimplemented from QgsMapLayer.

Definition at line 403 of file qgsrasterlayer.cpp.

◆ hueSaturationFilter()

QgsHueSaturationFilter * QgsRasterLayer::hueSaturationFilter ( ) const

Returns the raster's hue/saturation filter.

See also
resampleFilter()
brightnessFilter()

Definition at line 2073 of file qgsrasterlayer.cpp.

◆ ignoreExtents()

bool QgsRasterLayer::ignoreExtents ( ) const

If the ignoreExtent flag is set, the layer will also render outside the bounding box reported by the data provider.

To be used for example for WMS layers with labels or symbology that happens to be drawn outside the data extent.

Since
QGIS 3.10

Definition at line 1315 of file qgsrasterlayer.cpp.

◆ isSpatial()

bool QgsRasterLayer::isSpatial ( ) const
inlineoverridevirtual

Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated with it.

Reimplemented from QgsMapLayer.

Definition at line 350 of file qgsrasterlayer.h.

◆ isValidRasterFileName() [1/2]

bool QgsRasterLayer::isValidRasterFileName ( const QString &  fileNameQString)
static

Definition at line 217 of file qgsrasterlayer.cpp.

◆ isValidRasterFileName() [2/2]

bool QgsRasterLayer::isValidRasterFileName ( const QString &  fileNameQString,
QString &  retError 
)
static

This helper checks to see whether the file name appears to be a valid raster file name.

If the file name looks like it could be valid, but some sort of error occurs in processing the file, the error is returned in retError.

Definition at line 211 of file qgsrasterlayer.cpp.

◆ lastModified()

QDateTime QgsRasterLayer::lastModified ( const QString &  name)
static

Returns time stamp for given file name.

Definition at line 223 of file qgsrasterlayer.cpp.

◆ legendSymbologyItems()

QgsLegendColorList QgsRasterLayer::legendSymbologyItems ( ) const

Returns a list with classification items (Text and color).

Deprecated:
use QgsRasterRenderer::createLegendNodes() instead.

Definition at line 395 of file qgsrasterlayer.cpp.

◆ opacity()

double QgsRasterLayer::opacity ( ) const
virtual

Returns the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).

See also
setOpacity()
opacityChanged()
Note
Prior to QGIS 3.18, this method was available for vector layers only
Since
QGIS 3.18

Reimplemented from QgsMapLayer.

Definition at line 688 of file qgsrasterlayer.cpp.

◆ paletteAsPixmap()

QPixmap QgsRasterLayer::paletteAsPixmap ( int  bandNumber = 1)

Returns a 100x100 pixmap of the color palette.

If the layer has no palette a white pixmap will be returned

Parameters
bandNumberthe number of the band to use for generating a pixmap of the associated palette

Definition at line 582 of file qgsrasterlayer.cpp.

◆ pipe()

QgsRasterPipe * QgsRasterLayer::pipe ( )
inline

Returns the raster pipe.

Definition at line 279 of file qgsrasterlayer.h.

◆ previewAsImage()

QImage QgsRasterLayer::previewAsImage ( QSize  size,
const QColor &  bgColor = Qt::white,
QImage::Format  format = QImage::Format_ARGB32_Premultiplied 
)

Draws a preview of the rasterlayer into a QImage.

Definition at line 2111 of file qgsrasterlayer.cpp.

◆ properties()

Qgis::MapLayerProperties QgsRasterLayer::properties ( ) const
overridevirtual

Returns the map layer properties of this layer.

Note
properties() differ from flags() in that flags() are user settable, and reflect options that users can enable for map layers. In contrast properties() are reflections of inherent capabilities for the layer, which cannot be directly changed by users.
Since
QGIS 3.22

Reimplemented from QgsMapLayer.

Definition at line 570 of file qgsrasterlayer.cpp.

◆ providerType()

QString QgsRasterLayer::providerType ( ) const

[ data provider interface ] Which provider is being used for this Raster Layer?

Definition at line 639 of file qgsrasterlayer.cpp.

◆ rasterType()

Qgis::RasterLayerType QgsRasterLayer::rasterType ( ) const
inline

Returns the raster layer type (which is a read only property).

Definition at line 219 of file qgsrasterlayer.h.

◆ rasterUnitsPerPixelX()

double QgsRasterLayer::rasterUnitsPerPixelX ( ) const

Returns the number of raster units per each raster pixel in X axis.

In a world file, this is normally the first row (without the sign). (E.g. the value reported by the GDAL geotransform[1]).

See also
rasterUnitsPerPixelY()

Definition at line 646 of file qgsrasterlayer.cpp.

◆ rasterUnitsPerPixelY()

double QgsRasterLayer::rasterUnitsPerPixelY ( ) const

Returns the number of raster units per each raster pixel in Y axis.

In a world file, this is normally the first row (without the sign).

See also
rasterUnitsPerPixelX()

Definition at line 664 of file qgsrasterlayer.cpp.

◆ readStyle()

bool QgsRasterLayer::readStyle ( const QDomNode &  node,
QString &  errorMessage,
QgsReadWriteContext context,
QgsMapLayer::StyleCategories  categories = QgsMapLayer::AllStyleCategories 
)
overrideprotectedvirtual

Read the style for the current layer from the DOM node supplied.

Parameters
nodenode that will contain the style definition for this layer.
errorMessagereference to string that will be updated with any error messages
contextreading context (used for transform from relative to absolute paths)
categoriesthe style categories to be read
Returns
true in case of success.
Note
To be implemented in subclasses. Default implementation does nothing and returns false.

Reimplemented from QgsMapLayer.

Definition at line 2304 of file qgsrasterlayer.cpp.

◆ readSymbology()

bool QgsRasterLayer::readSymbology ( const QDomNode &  node,
QString &  errorMessage,
QgsReadWriteContext context,
QgsMapLayer::StyleCategories  categories = QgsMapLayer::AllStyleCategories 
)
overrideprotectedvirtual

Read the symbology for the current layer from the DOM node supplied.

Parameters
nodenode that will contain the symbology definition for this layer.
errorMessagereference to string that will be updated with any error messages
contextreading context (used for transform from relative to absolute paths)
categoriesthe style categories to be read
Returns
true in case of success.

Implements QgsMapLayer.

Definition at line 2172 of file qgsrasterlayer.cpp.

◆ readXml()

bool QgsRasterLayer::readXml ( const QDomNode &  layer_node,
QgsReadWriteContext context 
)
overrideprotectedvirtual

Called by readLayerXML(), used by children to read state specific to them from project files.

Reimplemented from QgsMapLayer.

Definition at line 2311 of file qgsrasterlayer.cpp.

◆ refreshContrastEnhancement()

void QgsRasterLayer::refreshContrastEnhancement ( const QgsRectangle extent)

Refresh contrast enhancement with new extent.

Note
not available in Python bindings

Definition at line 1502 of file qgsrasterlayer.cpp.

◆ refreshRendererIfNeeded()

void QgsRasterLayer::refreshRendererIfNeeded ( QgsRasterRenderer rasterRenderer,
const QgsRectangle extent 
)

Refresh renderer with new extent, if needed.

Note
not available in Python bindings

Definition at line 1545 of file qgsrasterlayer.cpp.

◆ reload()

void QgsRasterLayer::reload ( )
overridevirtual

Synchronises with changes in the datasource.

Reimplemented from QgsMapLayer.

Definition at line 328 of file qgsrasterlayer.cpp.

◆ renderer()

QgsRasterRenderer * QgsRasterLayer::renderer ( ) const

Returns the raster's renderer.

See also
setRenderer()

Definition at line 2052 of file qgsrasterlayer.cpp.

◆ resampleFilter()

QgsRasterResampleFilter * QgsRasterLayer::resampleFilter ( ) const

Returns the raster's resample filter.

See also
brightnessFilter()
hueSaturationFilter()

Definition at line 2059 of file qgsrasterlayer.cpp.

◆ resamplingStage()

Qgis::RasterResamplingStage QgsRasterLayer::resamplingStage ( ) const

Returns which stage of the pipe should apply resampling.

See also
QgsRasterPipe::resamplingStage()
Since
QGIS 3.16

Definition at line 2652 of file qgsrasterlayer.cpp.

◆ setContrastEnhancement()

void QgsRasterLayer::setContrastEnhancement ( QgsContrastEnhancement::ContrastEnhancementAlgorithm  algorithm,
QgsRasterMinMaxOrigin::Limits  limits = QgsRasterMinMaxOrigin::MinMax,
const QgsRectangle extent = QgsRectangle(),
int  sampleSize = QgsRasterLayer::SAMPLE_SIZE,
bool  generateLookupTableFlag = true 
)

Set contrast enhancement algorithm.

Parameters
algorithmContrast enhancement algorithm
limitsLimits
extentExtent used to calculate limits, if empty, use full layer extent
sampleSizeSize of data sample to calculate limits, if 0, use full resolution
generateLookupTableFlagGenerate lookup table.

Definition at line 1336 of file qgsrasterlayer.cpp.

◆ setDataProvider() [1/2]

void QgsRasterLayer::setDataProvider ( const QString &  provider)

Set the data provider.

Deprecated:
Use the version with ProviderOptions instead.

Definition at line 241 of file qgsrasterlayer.cpp.

◆ setDataProvider() [2/2]

void QgsRasterLayer::setDataProvider ( const QString &  provider,
const QgsDataProvider::ProviderOptions options,
QgsDataProvider::ReadFlags  flags = QgsDataProvider::ReadFlags() 
)

Set the data provider.

Parameters
providerprovider key string, must match a valid QgsRasterDataProvider key. E.g. "gdal", "wms", etc.
optionsprovider options
flagsprovider flags since QGIS 3.16
Since
QGIS 3.2

Definition at line 710 of file qgsrasterlayer.cpp.

◆ setDefaultContrastEnhancement()

void QgsRasterLayer::setDefaultContrastEnhancement ( )

Sets the default contrast enhancement.

Definition at line 1766 of file qgsrasterlayer.cpp.

◆ setLayerOrder()

void QgsRasterLayer::setLayerOrder ( const QStringList &  layers)
overridevirtual

Reorders the previously selected sublayers of this layer from bottom to top.

(Useful for providers that manage their own layers, such as WMS).

Reimplemented from QgsMapLayer.

Definition at line 1779 of file qgsrasterlayer.cpp.

◆ setOpacity()

void QgsRasterLayer::setOpacity ( double  opacity)
virtual

Sets the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).

See also
opacity()
opacityChanged()
Note
Prior to QGIS 3.18, this method was available for vector layers only
Since
QGIS 3.18

Reimplemented from QgsMapLayer.

Definition at line 676 of file qgsrasterlayer.cpp.

◆ setRenderer()

void QgsRasterLayer::setRenderer ( QgsRasterRenderer renderer)

Sets the raster's renderer.

Takes ownership of the renderer object.

See also
renderer()

Definition at line 2037 of file qgsrasterlayer.cpp.

◆ setResamplingStage()

void QgsRasterLayer::setResamplingStage ( Qgis::RasterResamplingStage  stage)

Select which stage of the pipe should apply resampling.

See also
QgsRasterPipe::setResamplingStage()
Since
QGIS 3.16

Definition at line 2645 of file qgsrasterlayer.cpp.

◆ setSubLayerVisibility()

void QgsRasterLayer::setSubLayerVisibility ( const QString &  name,
bool  visible 
)
overridevirtual

Set the visibility of the given sublayer name.

Parameters
namesublayer name
visiblesublayer visibility

Reimplemented from QgsMapLayer.

Definition at line 1793 of file qgsrasterlayer.cpp.

◆ setSubsetString()

bool QgsRasterLayer::setSubsetString ( const QString &  subset)
virtual

Sets the string (typically sql) used to define a subset of the layer.

Parameters
subsetThe subset string. This may be the where clause of a sql statement or other definition string specific to the underlying dataprovider and data store.
Returns
true, when setting the subset string was successful, false otherwise
Since
QGIS 3.12

Definition at line 1670 of file qgsrasterlayer.cpp.

◆ setTransformContext

void QgsRasterLayer::setTransformContext ( const QgsCoordinateTransformContext transformContext)
overridevirtualslot

Sets the coordinate transform context to transformContext.

Since
QGIS 3.8

Definition at line 2091 of file qgsrasterlayer.cpp.

◆ showStatusMessage

void QgsRasterLayer::showStatusMessage ( const QString &  message)
slot

Definition at line 2080 of file qgsrasterlayer.cpp.

◆ subLayers()

QStringList QgsRasterLayer::subLayers ( ) const
overridevirtual

Returns the sublayers of this layer.

(Useful for providers that manage their own layers, such as WMS).

Reimplemented from QgsMapLayer.

Definition at line 2100 of file qgsrasterlayer.cpp.

◆ subsetString()

QString QgsRasterLayer::subsetString ( ) const
virtual

Returns the string (typically sql) used to define a subset of the layer.

Returns
The subset string or null QString if not implemented by the provider
Since
QGIS 3.12

Definition at line 1654 of file qgsrasterlayer.cpp.

◆ subsetStringChanged

void QgsRasterLayer::subsetStringChanged ( )
signal

Emitted when the layer's subset string has changed.

Since
QGIS 3.12

◆ temporalProperties()

QgsMapLayerTemporalProperties * QgsRasterLayer::temporalProperties ( )
overridevirtual

Returns the layer's temporal properties.

This may be nullptr, depending on the layer type.

Since
QGIS 3.14

Reimplemented from QgsMapLayer.

Definition at line 1322 of file qgsrasterlayer.cpp.

◆ timestamp()

QDateTime QgsRasterLayer::timestamp ( ) const
overridevirtual

Time stamp of data source in the moment when data/metadata were loaded by provider.

Reimplemented from QgsMapLayer.

Definition at line 1804 of file qgsrasterlayer.cpp.

◆ width()

int QgsRasterLayer::width ( ) const

Returns the width of the (unclipped) raster.

See also
height()

Definition at line 2629 of file qgsrasterlayer.cpp.

◆ writeSld()

bool QgsRasterLayer::writeSld ( QDomNode &  node,
QDomDocument &  doc,
QString &  errorMessage,
const QVariantMap &  props = QVariantMap() 
) const

Writes the symbology of the layer into the document provided in SLD 1.0.0 format.

Parameters
nodethe node that will have the style element added to it.
docthe document that will have the QDomNode added.
errorMessagereference to string that will be updated with any error messages
propsa open ended set of properties that can drive/inform the SLD encoding
Returns
true in case of success
Since
QGIS 3.6

Definition at line 1826 of file qgsrasterlayer.cpp.

◆ writeStyle()

bool QgsRasterLayer::writeStyle ( QDomNode &  node,
QDomDocument &  doc,
QString &  errorMessage,
const QgsReadWriteContext context,
QgsMapLayer::StyleCategories  categories = QgsMapLayer::AllStyleCategories 
) const
overrideprotectedvirtual

Write just the symbology information for the layer into the document.

Parameters
nodethe node that will have the style element added to it.
docthe document that will have the QDomNode added.
errorMessagereference to string that will be updated with any error messages
contextwriting context (used for transform from absolute to relative paths)
categoriesthe style categories to be written
Returns
true in case of success.
Note
To be implemented in subclasses. Default implementation does nothing and returns false.
There is a confusion of terms with the GUI. This method actually writes what is known as the symbology in the application.

Reimplemented from QgsMapLayer.

Definition at line 2539 of file qgsrasterlayer.cpp.

◆ writeSymbology()

bool QgsRasterLayer::writeSymbology ( QDomNode &  node,
QDomDocument &  doc,
QString &  errorMessage,
const QgsReadWriteContext context,
QgsMapLayer::StyleCategories  categories = QgsMapLayer::AllStyleCategories 
) const
overrideprotectedvirtual

Write the style for the layer into the document provided.

Parameters
nodethe node that will have the style element added to it.
docthe document that will have the QDomNode added.
errorMessagereference to string that will be updated with any error messages
contextwriting context (used for transform from absolute to relative paths)
categoriesthe style categories to be written
Note
There is a confusion of terms with the GUI. This method actually writes what is called a style in the application.
Returns
true in case of success.

Implements QgsMapLayer.

Definition at line 2480 of file qgsrasterlayer.cpp.

◆ writeXml()

bool QgsRasterLayer::writeXml ( QDomNode &  layer_node,
QDomDocument &  document,
const QgsReadWriteContext context 
) const
overrideprotectedvirtual

Called by writeLayerXML(), used by children to write state specific to them to project files.

Reimplemented from QgsMapLayer.

Definition at line 2547 of file qgsrasterlayer.cpp.

Member Data Documentation

◆ MULTIPLE_BAND_MULTI_BYTE_ENHANCEMENT_ALGORITHM

const QgsContrastEnhancement::ContrastEnhancementAlgorithm QgsRasterLayer::MULTIPLE_BAND_MULTI_BYTE_ENHANCEMENT_ALGORITHM = QgsContrastEnhancement::StretchToMinimumMaximum
static

Default enhancement algorithm for multiple band raster of type different from Byte.

Definition at line 96 of file qgsrasterlayer.h.

◆ MULTIPLE_BAND_MULTI_BYTE_MIN_MAX_LIMITS

const QgsRasterMinMaxOrigin::Limits QgsRasterLayer::MULTIPLE_BAND_MULTI_BYTE_MIN_MAX_LIMITS = QgsRasterMinMaxOrigin::CumulativeCut
static

Default enhancement limits for multiple band raster of type different from Byte.

Definition at line 105 of file qgsrasterlayer.h.

◆ MULTIPLE_BAND_SINGLE_BYTE_ENHANCEMENT_ALGORITHM

const QgsContrastEnhancement::ContrastEnhancementAlgorithm QgsRasterLayer::MULTIPLE_BAND_SINGLE_BYTE_ENHANCEMENT_ALGORITHM = QgsContrastEnhancement::NoEnhancement
static

Default enhancement algorithm for multiple band raster of type Byte.

Definition at line 93 of file qgsrasterlayer.h.

◆ MULTIPLE_BAND_SINGLE_BYTE_MIN_MAX_LIMITS

const QgsRasterMinMaxOrigin::Limits QgsRasterLayer::MULTIPLE_BAND_SINGLE_BYTE_MIN_MAX_LIMITS = QgsRasterMinMaxOrigin::MinMax
static

Default enhancement limits for multiple band raster of type Byte.

Definition at line 102 of file qgsrasterlayer.h.

◆ SAMPLE_SIZE

const double QgsRasterLayer::SAMPLE_SIZE = 250000
static

Default sample size (number of pixels) for estimated statistics/histogram calculation.

Definition at line 87 of file qgsrasterlayer.h.

◆ settingsRasterDefaultEarlyResampling

const QgsSettingsEntryBool * QgsRasterLayer::settingsRasterDefaultEarlyResampling = new QgsSettingsEntryBool( QStringLiteral( "default-early-resampling" ), QgsSettingsTree::sTreeRaster, false )
static

Definition at line 83 of file qgsrasterlayer.h.

◆ settingsRasterDefaultOversampling

const QgsSettingsEntryDouble * QgsRasterLayer::settingsRasterDefaultOversampling = new QgsSettingsEntryDouble( QStringLiteral( "default-oversampling" ), QgsSettingsTree::sTreeRaster, 2.0 )
static

Definition at line 84 of file qgsrasterlayer.h.

◆ SINGLE_BAND_ENHANCEMENT_ALGORITHM

const QgsContrastEnhancement::ContrastEnhancementAlgorithm QgsRasterLayer::SINGLE_BAND_ENHANCEMENT_ALGORITHM = QgsContrastEnhancement::StretchToMinimumMaximum
static

Default enhancement algorithm for single band raster.

Definition at line 90 of file qgsrasterlayer.h.

◆ SINGLE_BAND_MIN_MAX_LIMITS

const QgsRasterMinMaxOrigin::Limits QgsRasterLayer::SINGLE_BAND_MIN_MAX_LIMITS = QgsRasterMinMaxOrigin::MinMax
static

Default enhancement limits for single band raster.

Definition at line 99 of file qgsrasterlayer.h.


The documentation for this class was generated from the following files: