Class: QgsRasterDataProvider¶
- class qgis.core.QgsRasterDataProvider¶
Bases:
QgsDataProvider
,QgsRasterInterface
Base class for raster data providers.
QgsRasterDataProvider()
QgsRasterDataProvider(uri: str, providerOptions: QgsDataProvider.ProviderOptions = QgsDataProvider.ProviderOptions(), flags: Union[QgsDataProvider.ReadFlags, QgsDataProvider.ReadFlag] = QgsDataProvider.ReadFlags()) Constructor for QgsRasterDataProvider.
The
uri
argument gives a provider-specific uri indicating the underlying data source and it’s parameters.The
options
argument specifies generic provider options and since QGIS 3.16 creation flags are specified within theflags
value.Enums
Bases:
enum.IntEnum
Methods
Add error message
Returns the (possibly NULL) attribute table for the specified
bandNumber
.Read band offset for raster value
Read band scale for raster value
Read block of data using given extent and size.
Returns the raster layers pyramid list.
Creates pyramid overviews.
- rtype:
QgsRasterDataProvider
Returns data type for the band specified by number
- param bandNo:
Returns a string color name representation of a color interpretation.
- param bandNo:
Copy member variables from other raster data provider.
Creates a new dataset with mDataSourceURI
Current time stamp of data source
Returns data type for the band specified by number
Decodes the URI returning a struct with all the parameters for
QgsVirtualRasterProvider
classReturns the dpi of the output device.
- rtype:
QgsRasterDataProviderElevationProperties
Enable or disable provider-level resampling.
Encodes the URI starting from the struct .
- rtype:
QgsRectangle
Returns the fields of the raster layer for data providers that expose them, the default implementation returns an empty list.
Returns a new image downloader for the raster legend.
Returns
True
if raster has at least one existing pyramid.Returns metadata in a format suitable for feeding directly into a subset of the GUI raster properties "Metadata" tab.
Identify raster value(s) found on the point position.
Converts a string
formatName
to a raster identify format.Converts a raster identify
format
to a translated string label.Converts a raster identify
format
to a string name.Converts a raster identify
format
to a capability.Returns
True
if the extents reported by the data provider are not reliable and it's possible that there is renderable content outside of these extents.Fill in histogram defaults if not specified
Fill in statistics defaults if not specified
Checks whether the provider is in editing mode, i.e. raster write operations will be accepted.
Returns whether provider-level resampling is enabled.
Returns the verbose error text for the last error in this provider
Returns the format of the error text for the last error in this provider
Returns the caption error text for the last error in this provider
Returns maximum oversampling factor for zoomed-out operations.
Returns a list of native resolutions if available, i.e. map units per pixel at which the raster source was originally created.
Returns flags containing the supported capabilities of the data provider.
Returns a list of pyramid resampling method name and label pairs for given provider
Loads the filesystem-based attribute table for the specified
bandNumber
frompath
, optionally reporting any error inerrorMessage
, returnsTrue
on success.Reads the native attribute table, optionally reporting any error in
errorMessage
, returnsTrue
on success.- param filterElem:
Reload data (data could change)
Remove dataset
Remove the attribute table for the specified
bandNumber
.Samples a raster value from the specified
band
found at thepoint
position.Set the attribute table to
attributeTable
for the specifiedbandNumber
, if theattributeTable
is NULL any existing attribute table for the specified band will be removed.Sets the output device resolution.
Turns on/off editing mode of the provider.
Sets error message
It makes no sense to set input on provider */
Sets maximum oversampling factor for zoomed-out operations.
Set no data value on created dataset
Sets the source nodata value usage
- param bandNo:
Set resampling method to apply for zoomed-in operations.
Set resampling method to apply for zoomed-out operations.
Returns source data type for the band specified by number, source data type may be shorter than dataType
Returns
True
if source band has no data valueValue representing no data value.
Step height for raster iterations.
Step width for raster iterations.
Returns the sublayers of this layer - useful for providers that manage their own layers, such as WMS
Returns whether the provider supplies a legend graphic
- rtype:
QgsRasterDataProviderTemporalCapabilities
Time stamp of data source in the moment when data/metadata were loaded by provider
Transforms coordinates between source image coordinate space [0..width]x[0..height] and layer coordinate space (georeferenced coordinates).
Returns the source nodata value usage
Returns a list of user no data value ranges.
Returns
True
if user no data contains valueValidates creation options for a specific dataset and destination format.
Validates pyramid creation options for a specific dataset and destination format
Writes into the provider datasource
Writes pixel data from a raster block into the provider data source.
Writes the filesystem-based attribute table for the specified
bandNumber
topath
, optionally reporting any error inerrorMessage
, returnsTrue
on success.- rtype:
Tuple[bool, str]
- param doc:
Returns resampling method for zoomed-in operations.
Returns resampling method for zoomed-out operations.
Signals
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
Attributes
- DpiDependentData = 64¶
- NativeRasterAttributeTable = 128¶
- NoProviderCapabilities = 0¶
- class ProviderCapabilities¶
- class ProviderCapabilities(Union[QgsRasterDataProvider.ProviderCapabilities, QgsRasterDataProvider.ProviderCapability])
- class ProviderCapabilities(QgsRasterDataProvider.ProviderCapabilities)
Bases:
sip.wrapper
- class ProviderCapability¶
Bases:
int
- ProviderHintBenefitsFromResampling = 8¶
- ProviderHintCanPerformProviderResampling = 16¶
- ReadLayerMetadata = 2¶
- ReloadData = 32¶
- class ResamplingMethod(value)¶
Bases:
enum.IntEnum
Resampling method for provider-level resampling.
New in version 3.16.
Nearest
: Nearest-neighbour resamplingBilinear
: Bilinear (2x2 kernel) resamplingCubic
: Cubic Convolution Approximation (4x4 kernel) resamplingCubicSpline
: Cubic B-Spline Approximation (4x4 kernel)Lanczos
: Lanczos windowed sinc interpolation (6x6 kernel)Average
: Average resamplingMode
: Mode (selects the value which appears most often of all the sampled points)Gauss
: Gauss blurring
- Average = 5¶
- Bilinear = 1¶
- Cubic = 2¶
- CubicSpline = 3¶
- Gauss = 7¶
- Lanczos = 4¶
- Mode = 6¶
- Nearest = 0¶
- TransformImageToLayer = 0¶
- TransformLayerToImage = 1¶
- class TransformType¶
Bases:
int
- class VirtualRasterInputLayers¶
- class VirtualRasterInputLayers(QgsRasterDataProvider.VirtualRasterInputLayers)
Bases:
sip.wrapper
- name¶
- provider¶
- uri¶
- class VirtualRasterParameters¶
- class VirtualRasterParameters(QgsRasterDataProvider.VirtualRasterParameters)
Bases:
sip.wrapper
- crs¶
- extent¶
- formula¶
- height¶
- rInputLayers¶
- width¶
- WriteLayerMetadata = 4¶
- appendError(self, message: QgsErrorMessage)¶
Add error message
- attributeTable(self, bandNumber: int) QgsRasterAttributeTable ¶
Returns the (possibly NULL) attribute table for the specified
bandNumber
.New in version 3.30.
- Parameters:
bandNumber (int) –
- Return type:
- bandOffset(self, bandNo: int) float ¶
Read band offset for raster value
New in version 2.3.
- Parameters:
bandNo (int) –
- Return type:
float
- bandScale(self, bandNo: int) float ¶
Read band scale for raster value
New in version 2.3.
- Parameters:
bandNo (int) –
- Return type:
float
- block(self, bandNo: int, boundingBox: QgsRectangle, width: int, height: int, feedback: QgsRasterBlockFeedback = None) QgsRasterBlock ¶
Read block of data using given extent and size.
- Parameters:
bandNo (int) –
boundingBox (QgsRectangle) –
width (int) –
height (int) –
feedback (
QgsRasterBlockFeedback
= None) –
- Return type:
- buildPyramidList(self, overviewList: Iterable[int] = []) List[QgsRasterPyramid] ¶
Returns the raster layers pyramid list.
This method returns a list of pyramid layers which are valid for the data provider. The returned list is a complete list of all possible layers, and includes both pyramids layers which currently exist and layers which have not yet been constructed. To know which of the pyramid layers ACTUALLY exists you need to look at the
QgsRasterPyramid.getExists()
member for each value in the list.The returned list is suitable for passing to the
buildPyramids()
method. First, modify the returned list by calling QgsRasterPyramid.setBuild( ``True` )` for every layer you want to create pyramids for, and then pass the modified list tobuildPyramids()
.- Parameters:
overviewList (Iterable[int] = []) – used to construct the pyramid list (optional), when empty the list is defined by the provider.
See also
See also
- Return type:
List[QgsRasterPyramid]
- buildPyramids(self, pyramidList: Iterable[QgsRasterPyramid], resamplingMethod: str = '', format: Qgis.RasterPyramidFormat = Qgis.RasterPyramidFormat.GeoTiff, configOptions: Iterable[str] = [], feedback: QgsRasterBlockFeedback = None) str ¶
Creates pyramid overviews.
- Parameters:
pyramidList (Iterable[QgsRasterPyramid]) – a list of
QgsRasterPyramids
to create overviews for. TheQgsRasterPyramid.setBuild()
flag should be set toTrue
for every layer where pyramids are desired.resamplingMethod (str = '') – resampling method to use when creating the pyramids. The
pyramidResamplingMethods()
method can be used to retrieve a list of valid resampling methods available for specific raster data providers.format (Qgis.RasterPyramidFormat = Qgis.RasterPyramidFormat.GeoTiff) – raster pyramid format.
configOptions (Iterable[str] = []) – optional configuration options which are passed to the specific data provider for use during pyramid creation.
feedback (
QgsRasterBlockFeedback
= None) – optional feedback argument for progress reports and cancellation support.
See also
See also
See also
- Return type:
str
- childEvent(self, QChildEvent)¶
- clone(self) QgsRasterDataProvider ¶
- Return type:
- colorInterpretation(self, bandNo: int) Qgis.RasterColorInterpretation ¶
Returns data type for the band specified by number
- Parameters:
bandNo (int) –
- Return type:
- colorInterpretationName(self, bandNo: int) str ¶
- Parameters:
bandNo (int) –
- Return type:
str
- colorName(self, colorInterpretation: Qgis.RasterColorInterpretation) str ¶
Returns a string color name representation of a color interpretation.
- Parameters:
colorInterpretation (Qgis.RasterColorInterpretation) –
- Return type:
str
- colorTable(self, bandNo: int) List[QgsColorRampShader.ColorRampItem] ¶
- Parameters:
bandNo (int) –
- Return type:
- connectNotify(self, QMetaMethod)¶
- copyBaseSettings(self, other: QgsRasterDataProvider)¶
Copy member variables from other raster data provider. Useful for implementation of
clone()
method in subclasses- Parameters:
other (QgsRasterDataProvider) –
- create(providerKey: str, uri: str, format: str, nBands: int, type: Qgis.DataType, width: int, height: int, crs: QgsCoordinateReferenceSystem, createOptions: Iterable[str] = []) Tuple[QgsRasterDataProvider, float] ¶
Creates a new dataset with mDataSourceURI
- Parameters:
providerKey (str) –
uri (str) –
format (str) –
nBands (int) –
type (Qgis.DataType) –
width (int) –
height (int) –
crs (QgsCoordinateReferenceSystem) –
createOptions (Iterable[str] = []) –
- Return type:
Tuple[
QgsRasterDataProvider
, float]
- customEvent(self, QEvent)¶
- dataTimestamp(self) QDateTime ¶
Current time stamp of data source
- Return type:
QDateTime
- dataType(self, bandNo: int) Qgis.DataType ¶
Returns data type for the band specified by number
- Parameters:
bandNo (int) –
- Return type:
- decodeVirtualRasterProviderUri(uri: str) Tuple[QgsRasterDataProvider.VirtualRasterParameters, bool] ¶
Decodes the URI returning a struct with all the parameters for
QgsVirtualRasterProvider
classNote
used by Virtual Raster Provider only
Note
since QGIS 3.22
- Parameters:
uri (str) –
- Return type:
Tuple[QgsRasterDataProvider.VirtualRasterParameters, bool]
- disconnectNotify(self, QMetaMethod)¶
- dpi(self) int ¶
Returns the dpi of the output device.
- Return type:
int
- elevationProperties(self) QgsRasterDataProviderElevationProperties ¶
- Return type:
- enableProviderResampling(self, enable: bool) bool ¶
Enable or disable provider-level resampling.
- Return type:
bool
- Returns:
True
if success
New in version 3.16.
- Parameters:
enable (bool) –
- encodeVirtualRasterProviderUri(parts: QgsRasterDataProvider.VirtualRasterParameters) str ¶
Encodes the URI starting from the struct .
Note
used by Virtual Raster Provider only
Note
since QGIS 3.22
- Parameters:
- Return type:
str
- extent(self) QgsRectangle ¶
- Return type:
- fields(self) QgsFields ¶
Returns the fields of the raster layer for data providers that expose them, the default implementation returns an empty list.
New in version 3.14.
- Return type:
- getLegendGraphicFetcher(self, mapSettings: QgsMapSettings) QgsImageFetcher ¶
Returns a new image downloader for the raster legend.
- Parameters:
mapSettings (QgsMapSettings) – map settings for legend providers supporting contextual legends.
- Return type:
- Returns:
a download handler or
None
if the provider does not support legend at all. Ownership of the returned object is transferred to caller.
New in version 2.8.
- hasPyramids(self) bool ¶
Returns
True
if raster has at least one existing pyramid.The
buildPyramidList()
method can be used to retrieve additional details about potential and existing pyramid layers.See also
See also
- Return type:
bool
- htmlMetadata(self) str ¶
Returns metadata in a format suitable for feeding directly into a subset of the GUI raster properties “Metadata” tab.
- Return type:
str
- identify(self, point: QgsPointXY, format: Qgis.RasterIdentifyFormat, boundingBox: QgsRectangle = QgsRectangle(), width: int = 0, height: int = 0, dpi: int = 96) QgsRasterIdentifyResult ¶
Identify raster value(s) found on the point position. The context parameters extent, width and height are important to identify on the same zoom level as a displayed map and to do effective caching (WCS). If context params are not specified the highest resolution is used.
capabilities()
may be used to test if format is supported by provider. Values are set to ‘no data’ or empty string if point is outside data source extent.- Parameters:
point (QgsPointXY) – coordinates in data source CRS
format (Qgis.RasterIdentifyFormat) – result format
boundingBox (
QgsRectangle
= QgsRectangle()) – context bounding boxwidth (int = 0) – context width
height (int = 0) – context height
dpi (int = 96) – context dpi
- Return type:
- Returns:
QgsRaster
.IdentifyFormatValue: map of values for each band, keys are band numbers (from 1).QgsRaster
.IdentifyFormatFeature: map ofQgsRasterFeatureList
for each sublayerQgsRaster
.IdentifyFormatHtml: map of HTML strings for each sublayer (WMS). Empty if failed or there are no results.
Note
The arbitraryness of the returned document is enforced by WMS standards up to at least v1.3.0
See also
- identifyFormatFromName(formatName: str) Qgis.RasterIdentifyFormat ¶
Converts a string
formatName
to a raster identify format.See also
- Parameters:
formatName (str) –
- Return type:
- identifyFormatLabel(format: Qgis.RasterIdentifyFormat) str ¶
Converts a raster identify
format
to a translated string label.- Parameters:
format (Qgis.RasterIdentifyFormat) –
- Return type:
str
- identifyFormatName(format: Qgis.RasterIdentifyFormat) str ¶
Converts a raster identify
format
to a string name.See also
- Parameters:
format (Qgis.RasterIdentifyFormat) –
- Return type:
str
- identifyFormatToCapability(format: Qgis.RasterIdentifyFormat) QgsRasterInterface.Capability ¶
Converts a raster identify
format
to a capability.- Parameters:
format (Qgis.RasterIdentifyFormat) –
- Return type:
- ignoreExtents(self) bool ¶
Returns
True
if the extents reported by the data provider are not reliable and it’s possible that there is renderable content outside of these extents.New in version 3.10.0.
- Return type:
bool
- initHistogram(self, histogram: QgsRasterHistogram, bandNo: int, binCount: int, minimum: object = Py_None, maximum: object = Py_None, boundingBox: QgsRectangle = QgsRectangle(), sampleSize: int = 0, includeOutOfRange: bool = False)¶
Fill in histogram defaults if not specified
Note
the parameters are the same as in
histogram()
- initStatistics(self, statistics: QgsRasterBandStats, bandNo: int, stats: int = QgsRasterBandStats.All, boundingBox: QgsRectangle = QgsRectangle(), binCount: int = 0)¶
Fill in statistics defaults if not specified
- isEditable(self) bool ¶
Checks whether the provider is in editing mode, i.e. raster write operations will be accepted. By default providers are not editable. Use
setEditable()
method to enable/disable editing.See also
New in version 3.0.
- Return type:
bool
- isProviderResamplingEnabled(self) bool ¶
Returns whether provider-level resampling is enabled.
Note
Resampling is effective only if
zoomedInResamplingMethod()
and/orzoomedOutResamplingMethod()
return non-nearest resampling.See also
See also
See also
New in version 3.16.
- Return type:
bool
- isSignalConnected(self, QMetaMethod) bool ¶
- lastError(self) str ¶
Returns the verbose error text for the last error in this provider
If an operation returns 0 (e.g.
draw()
), this function returns the text of the error associated with the failure. Interactive users of this provider can then, for example, call a QMessageBox to display the contents.- Return type:
str
- lastErrorFormat(self) str ¶
Returns the format of the error text for the last error in this provider
- Return type:
str
- lastErrorTitle(self) str ¶
Returns the caption error text for the last error in this provider
If an operation returns 0 (e.g.
draw()
), this function returns the text of the error associated with the failure. Interactive users of this provider can then, for example, call a QMessageBox to display the contents.- Return type:
str
- maxOversampling(self) float ¶
Returns maximum oversampling factor for zoomed-out operations.
New in version 3.16.
- Return type:
float
- nativeResolutions(self) List[float] ¶
Returns a list of native resolutions if available, i.e. map units per pixel at which the raster source was originally created.
Resolutions are calculated in the provider’s
crs()
.New in version 3.8.0.
- Return type:
List[float]
- providerCapabilities(self) QgsRasterDataProvider.ProviderCapabilities ¶
Returns flags containing the supported capabilities of the data provider.
New in version 3.0.
- Return type:
- pyramidResamplingMethods(providerKey: str) List[Tuple[str, str]] ¶
Returns a list of pyramid resampling method name and label pairs for given provider
- Parameters:
providerKey (str) –
- Return type:
List[Tuple[str, str]]
- readFileBasedAttributeTable(self, bandNumber: int, path: str) Tuple[bool, str] ¶
Loads the filesystem-based attribute table for the specified
bandNumber
frompath
, optionally reporting any error inerrorMessage
, returnsTrue
on success.- Return type:
Tuple[bool, str]
- Returns:
True
on success
New in version 3.30.
- Parameters:
bandNumber (int) –
path (str) –
- readNativeAttributeTable(self) Tuple[bool, str] ¶
Reads the native attribute table, optionally reporting any error in
errorMessage
, returnsTrue
on success. The default implementation does nothing and returnsFalse
. Data providers that have NativeRasterAttributeTable provider capability will try to read the native attribute table.- Return type:
Tuple[bool, str]
- Returns:
True
on success
New in version 3.30.
- readXml(self, filterElem: QDomElement)¶
- Parameters:
filterElem (QDomElement) –
- receivers(self, PYQT_SIGNAL) int ¶
- reload(self) bool ¶
Reload data (data could change)
- Return type:
bool
- remove(self) bool ¶
Remove dataset
- Return type:
bool
- removeAttributeTable(self, bandNumber: int)¶
Remove the attribute table for the specified
bandNumber
. If the attribute table does not exist this method does nothing.New in version 3.30.
- Parameters:
bandNumber (int) –
- sample(self, point: QgsPointXY, band: int, boundingBox: QgsRectangle = QgsRectangle(), width: int = 0, height: int = 0, dpi: int = 96) Tuple[float, bool] ¶
Samples a raster value from the specified
band
found at thepoint
position. The context parametersboundingBox
,width
andheight
are important to identify on the same zoom level as a displayed map and to do effective caching (WCS). If context params are not specified the highest resolution is used.If
ok
is specified and the point is outside data source extent, or an invalid band number was specified, thenok
will be set toFalse
. In this case the function will return a NaN value.See also
New in version 3.4.
- Parameters:
point (QgsPointXY) –
band (int) –
boundingBox (
QgsRectangle
= QgsRectangle()) –width (int = 0) –
height (int = 0) –
dpi (int = 96) –
- Return type:
Tuple[float, bool]
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setAttributeTable(self, bandNumber: int, attributeTable: QgsRasterAttributeTable)¶
Set the attribute table to
attributeTable
for the specifiedbandNumber
, if theattributeTable
is NULL any existing attribute table for the specified band will be removed.Note
Ownership of the attribute table is transferred to the provider.
New in version 3.30.
- Parameters:
bandNumber (int) –
attributeTable (QgsRasterAttributeTable) –
- setDpi(self, dpi: int)¶
Sets the output device resolution.
- Parameters:
dpi (int) –
- setEditable(self, enabled: bool) bool ¶
Turns on/off editing mode of the provider. When in editing mode, it is possible to overwrite data of the provider using
writeBlock()
calls.- Return type:
bool
- Returns:
True
if the switch to/from editing mode was successful
Note
Only some providers support editing mode and even those may fail to turn the underlying data source into editing mode, so it is necessary to check the return value whether the operation was successful.
See also
New in version 3.0.
- Parameters:
enabled (bool) –
- setInput(self, input: QgsRasterInterface) bool ¶
It makes no sense to set input on provider */
- Parameters:
input (QgsRasterInterface) –
- Return type:
bool
- setMaxOversampling(self, factor: float) bool ¶
Sets maximum oversampling factor for zoomed-out operations.
- Return type:
bool
- Returns:
True
if success
New in version 3.16.
- Parameters:
factor (float) –
- setNoDataValue(self, bandNo: int, noDataValue: float) bool ¶
Set no data value on created dataset
- Parameters:
bandNo (int) – band number
noDataValue (float) – no data value
- Return type:
bool
- setUseSourceNoDataValue(self, bandNo: int, use: bool)¶
Sets the source nodata value usage
- Parameters:
bandNo (int) –
use (bool) –
- setUserNoDataValue(self, bandNo: int, noData: Iterable[QgsRasterRange])¶
- Parameters:
bandNo (int) –
noData (Iterable[QgsRasterRange]) –
- setZoomedInResamplingMethod(self, method: QgsRasterDataProvider.ResamplingMethod) bool ¶
Set resampling method to apply for zoomed-in operations.
- Return type:
bool
- Returns:
True
if success
New in version 3.16.
- Parameters:
method (QgsRasterDataProvider.ResamplingMethod) –
- setZoomedOutResamplingMethod(self, method: QgsRasterDataProvider.ResamplingMethod) bool ¶
Set resampling method to apply for zoomed-out operations.
- Return type:
bool
- Returns:
True
if success
New in version 3.16.
- Parameters:
method (QgsRasterDataProvider.ResamplingMethod) –
- sourceDataType(self, bandNo: int) Qgis.DataType ¶
Returns source data type for the band specified by number, source data type may be shorter than dataType
- Parameters:
bandNo (int) –
- Return type:
- sourceHasNoDataValue(self, bandNo: int) bool ¶
Returns
True
if source band has no data value- Parameters:
bandNo (int) –
- Return type:
bool
- sourceNoDataValue(self, bandNo: int) float ¶
Value representing no data value.
- Parameters:
bandNo (int) –
- Return type:
float
- statusChanged¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- stepHeight(self) int ¶
Step height for raster iterations.
See also
New in version 3.0.
- Return type:
int
- stepWidth(self) int ¶
Step width for raster iterations.
See also
New in version 3.0.
- Return type:
int
- subLayers(self) List[str] ¶
Returns the sublayers of this layer - useful for providers that manage their own layers, such as WMS
- Return type:
List[str]
- supportsLegendGraphic(self) bool ¶
Returns whether the provider supplies a legend graphic
- Return type:
bool
- temporalCapabilities(self) QgsRasterDataProviderTemporalCapabilities ¶
- Return type:
- timerEvent(self, QTimerEvent)¶
- timestamp(self) QDateTime ¶
Time stamp of data source in the moment when data/metadata were loaded by provider
- Return type:
QDateTime
- transformCoordinates(self, point: QgsPoint, type: QgsRasterDataProvider.TransformType) QgsPoint ¶
Transforms coordinates between source image coordinate space [0..width]x[0..height] and layer coordinate space (georeferenced coordinates). Often this transformation is a simple 2D affine transformation (offset and scaling), but rasters with different georeferencing methods like GCPs (ground control points) or RPCs (rational polynomial coefficients) may require a more complex transform.
If the transform fails (input coordinates are outside of the valid range or data provider does not support this functionality), an empty point is returned.
New in version 3.14.
- Parameters:
point (QgsPoint) –
type (QgsRasterDataProvider.TransformType) –
- Return type:
- useSourceNoDataValue(self, bandNo: int) bool ¶
Returns the source nodata value usage
- Parameters:
bandNo (int) –
- Return type:
bool
- userNoDataValues(self, bandNo: int) List[QgsRasterRange] ¶
Returns a list of user no data value ranges.
- Parameters:
bandNo (int) –
- Return type:
List[QgsRasterRange]
- userNoDataValuesContains(self, bandNo: int, value: float) bool ¶
Returns
True
if user no data contains value- Parameters:
bandNo (int) –
value (float) –
- Return type:
bool
- validateCreationOptions(self, createOptions: Iterable[str], format: str) str ¶
Validates creation options for a specific dataset and destination format.
Note
used by GDAL provider only
Note
see also
validateCreationOptionsFormat()
in gdal provider for validating options based on format only- Parameters:
createOptions (Iterable[str]) –
format (str) –
- Return type:
str
- validatePyramidsConfigOptions(self, pyramidsFormat: Qgis.RasterPyramidFormat, configOptions: Iterable[str], fileFormat: str) str ¶
Validates pyramid creation options for a specific dataset and destination format
Note
used by GDAL provider only
- Parameters:
pyramidsFormat (Qgis.RasterPyramidFormat) –
configOptions (Iterable[str]) –
fileFormat (str) –
- Return type:
str
- write(self, data: sip.voidptr, band: int, width: int, height: int, xOffset: int, yOffset: int) bool ¶
Writes into the provider datasource
- Parameters:
data (sip.voidptr) –
band (int) –
width (int) –
height (int) –
xOffset (int) –
yOffset (int) –
- Return type:
bool
- writeBlock(self, block: QgsRasterBlock, band: int, xOffset: int = 0, yOffset: int = 0) bool ¶
Writes pixel data from a raster block into the provider data source.
This will override previously stored pixel values. It is assumed that cells in the passed raster block are aligned with the cells of the data source. If raster block does not cover the whole area of the data source, only a subset of pixels covered by the raster block will be overwritten. By default, writing of raster data starts from the first cell of the raster - it is possible to set offset in pixels by specifying non-zero xOffset and yOffset values.
Writing is supported only by some data providers. Provider has to be in editing mode in order to allow write operations.
See also
- Return type:
bool
- Returns:
True
on success
New in version 3.0.
- Parameters:
block (QgsRasterBlock) –
band (int) –
xOffset (int = 0) –
yOffset (int = 0) –
- writeFileBasedAttributeTable(self, bandNumber: int, path: str) Tuple[bool, str] ¶
Writes the filesystem-based attribute table for the specified
bandNumber
topath
, optionally reporting any error inerrorMessage
, returnsTrue
on success.- Return type:
Tuple[bool, str]
- Returns:
True
on success
Note
No checks for Raster Attribute Table validity are performed when saving, it is client code responsibility to handle validation.
New in version 3.30.
- Parameters:
bandNumber (int) –
path (str) –
- writeNativeAttributeTable(self) Tuple[bool, str] ¶
- Return type:
Tuple[bool, str]
- writeXml(self, doc: QDomDocument, parentElem: QDomElement)¶
- Parameters:
doc (QDomDocument) –
parentElem (QDomElement) –
- zoomedInResamplingMethod(self) QgsRasterDataProvider.ResamplingMethod ¶
Returns resampling method for zoomed-in operations.
New in version 3.16.
- Return type:
- zoomedOutResamplingMethod(self) QgsRasterDataProvider.ResamplingMethod ¶
Returns resampling method for zoomed-out operations.
New in version 3.16.
- Return type: