Utilities for working with GDAL. More...

#include <qgsgdalutils.h>

Static Public Member Functions
static gdal::dataset_unique_ptr	createMultiBandMemoryDataset (GDALDataType dataType, int bands, const QgsRectangle &extent, int width, int height, const QgsCoordinateReferenceSystem &crs)
	Creates a new multi band memory dataset with given parameters. More...

static gdal::dataset_unique_ptr	createSingleBandMemoryDataset (GDALDataType dataType, const QgsRectangle &extent, int width, int height, const QgsCoordinateReferenceSystem &crs)
	Creates a new single band memory dataset with given parameters. More...

static gdal::dataset_unique_ptr	createSingleBandTiffDataset (const QString &filename, GDALDataType dataType, const QgsRectangle &extent, int width, int height, const QgsCoordinateReferenceSystem &crs)
	Creates a new single band TIFF dataset with given parameters. More...

static QString	helpCreationOptionsFormat (const QString &format)
	Gets creation options metadata for a given format. More...

static gdal::dataset_unique_ptr	imageToMemoryDataset (const QImage &image)
	Converts an image to a GDAL memory dataset by borrowing image data. More...

static QStringList	multiLayerFileExtensions ()
	Returns a list of file extensions which potentially contain multiple layers representing GDAL raster or vector layers. More...

static char **	papszFromStringList (const QStringList &list)
	Helper function. More...

static bool	pathIsCheapToOpen (const QString &path, int smallFileSizeLimit=50000)
	Returns `true` if the dataset at the specified path is considered "cheap" to open. More...

static QImage	resampleImage (const QImage &image, QSize outputSize, GDALRIOResampleAlg resampleAlg)
	Resamples a QImage image using GDAL resampler. More...

static bool	resampleSingleBandRaster (GDALDatasetH hSrcDS, GDALDatasetH hDstDS, GDALResampleAlg resampleAlg, const char *pszCoordinateOperation)
	Resamples a single band raster to the destination dataset with different resolution (and possibly with different CRS). More...

static GDALDatasetH	rpcAwareAutoCreateWarpedVrt (GDALDatasetH hSrcDS, const char pszSrcWKT, const char pszDstWKT, GDALResampleAlg eResampleAlg, double dfMaxError, const GDALWarpOptions *psOptionsIn)
	This is a copy of GDALAutoCreateWarpedVRT optimized for imagery using RPC georeferencing that also sets RPC_HEIGHT in GDALCreateGenImgProjTransformer2 based on HEIGHT_OFF. More...

static void *	rpcAwareCreateTransformer (GDALDatasetH hSrcDS, GDALDatasetH hDstDS=nullptr, char **papszOptions=nullptr)
	This is a wrapper around GDALCreateGenImgProjTransformer2() that takes into account RPC georeferencing (it sets RPC_HEIGHT in GDALCreateGenImgProjTransformer2 based on HEIGHT_OFF). More...

static void	setupProxy ()
	Sets the gdal proxy variables. More...

static bool	supportsRasterCreate (GDALDriverH driver)
	Reads whether a driver supports GDALCreate() for raster purposes. More...

static QString	validateCreationOptionsFormat (const QStringList &createOptions, const QString &format)
	Validates creation options for a given format, regardless of layer. More...

static bool	vrtMatchesLayerType (const QString &vrtPath, QgsMapLayerType type)
	Returns `true` if the VRT file at the specified path is a VRT matching the given layer type. More...

Friends
class	TestQgsGdalUtils

Detailed Description

Utilities for working with GDAL.

Note: not available in Python bindings

Since: QGIS 3.4

Definition at line 34 of file qgsgdalutils.h.

Member Function Documentation

◆ createMultiBandMemoryDataset()

gdal::dataset_unique_ptr QgsGdalUtils::createMultiBandMemoryDataset	(	GDALDataType	dataType,
		int	bands,
		const QgsRectangle &	extent,
		int	width,
		int	height,
		const QgsCoordinateReferenceSystem &	crs
	)

static

Creates a new multi band memory dataset with given parameters.

Since: QGIS 3.12

Definition at line 52 of file qgsgdalutils.cpp.

◆ createSingleBandMemoryDataset()

gdal::dataset_unique_ptr QgsGdalUtils::createSingleBandMemoryDataset	(	GDALDataType	dataType,
		const QgsRectangle &	extent,
		int	width,
		int	height,
		const QgsCoordinateReferenceSystem &	crs
	)

static

Creates a new single band memory dataset with given parameters.

Since: QGIS 3.8

Definition at line 47 of file qgsgdalutils.cpp.

◆ createSingleBandTiffDataset()

gdal::dataset_unique_ptr QgsGdalUtils::createSingleBandTiffDataset	(	const QString &	filename,
		GDALDataType	dataType,
		const QgsRectangle &	extent,
		int	width,
		int	height,
		const QgsCoordinateReferenceSystem &	crs
	)

static

Creates a new single band TIFF dataset with given parameters.

Since: QGIS 3.8

Definition at line 77 of file qgsgdalutils.cpp.

◆ helpCreationOptionsFormat()

QString QgsGdalUtils::helpCreationOptionsFormat ( const QString & format )

static

Gets creation options metadata for a given format.

Since: QGIS 3.10

Definition at line 240 of file qgsgdalutils.cpp.

◆ imageToMemoryDataset()

gdal::dataset_unique_ptr QgsGdalUtils::imageToMemoryDataset ( const QImage & image )

static

Converts an image to a GDAL memory dataset by borrowing image data.

Warning: The image must exist unchanged for the lifetime of the returned gdal dataset!

Since: QGIS 3.12

Definition at line 108 of file qgsgdalutils.cpp.

◆ multiLayerFileExtensions()

QStringList QgsGdalUtils::multiLayerFileExtensions ( )

static

Returns a list of file extensions which potentially contain multiple layers representing GDAL raster or vector layers.

Since: QGIS 3.22

Definition at line 549 of file qgsgdalutils.cpp.

◆ papszFromStringList()

char ** QgsGdalUtils::papszFromStringList ( const QStringList & list )

static

Helper function.

Since: QGIS 3.10

Definition at line 269 of file qgsgdalutils.cpp.

◆ pathIsCheapToOpen()

bool QgsGdalUtils::pathIsCheapToOpen	(	const QString &	path,
		int	smallFileSizeLimit = `50000`
	)

static

Returns true if the dataset at the specified path is considered "cheap" to open.

Datasets which are considered cheap to open may correspond to very small file sizes, or data types which only require some inexpensive header parsing to open.

One use case for this method is to test whether a remote dataset can be safely opened to resolve the geometry types and other metadata without causing undue network traffic.

The smallFileSizeLimit argument specifies the maximum file size (in bytes) which will be considered as small.

Since: QGIS 3.22

Definition at line 522 of file qgsgdalutils.cpp.

◆ resampleImage()

QImage QgsGdalUtils::resampleImage	(	const QImage &	image,
		QSize	outputSize,
		GDALRIOResampleAlg	resampleAlg
	)

static

Resamples a QImage image using GDAL resampler.

Since: QGIS 3.12

Definition at line 189 of file qgsgdalutils.cpp.

◆ resampleSingleBandRaster()

bool QgsGdalUtils::resampleSingleBandRaster	(	GDALDatasetH	hSrcDS,
		GDALDatasetH	hDstDS,
		GDALResampleAlg	resampleAlg,
		const char *	pszCoordinateOperation
	)

static

Resamples a single band raster to the destination dataset with different resolution (and possibly with different CRS).

Ideally the source dataset should cover the whole area or the destination dataset.

Returns: true on success

Since: QGIS 3.8

Definition at line 152 of file qgsgdalutils.cpp.

◆ rpcAwareAutoCreateWarpedVrt()

GDALDatasetH QgsGdalUtils::rpcAwareAutoCreateWarpedVrt	(	GDALDatasetH	hSrcDS,
		const char *	pszSrcWKT,
		const char *	pszDstWKT,
		GDALResampleAlg	eResampleAlg,
		double	dfMaxError,
		const GDALWarpOptions *	psOptionsIn
	)

static

This is a copy of GDALAutoCreateWarpedVRT optimized for imagery using RPC georeferencing that also sets RPC_HEIGHT in GDALCreateGenImgProjTransformer2 based on HEIGHT_OFF.

By default GDAL would assume that the imagery has zero elevation - if that is not the case, the image would not be shown in the correct location.

Since: QGIS 3.14

Definition at line 438 of file qgsgdalutils.cpp.

◆ rpcAwareCreateTransformer()

void * QgsGdalUtils::rpcAwareCreateTransformer	(	GDALDatasetH	hSrcDS,
		GDALDatasetH	hDstDS = `nullptr`,
		char **	papszOptions = `nullptr`
	)

static

This is a wrapper around GDALCreateGenImgProjTransformer2() that takes into account RPC georeferencing (it sets RPC_HEIGHT in GDALCreateGenImgProjTransformer2 based on HEIGHT_OFF).

By default GDAL would assume that the imagery has zero elevation - if that is not the case, the image would not be shown in the correct location.

Since: QGIS 3.16

Definition at line 458 of file qgsgdalutils.cpp.

◆ setupProxy()

void QgsGdalUtils::setupProxy ( )

static

Sets the gdal proxy variables.

Definition at line 474 of file qgsgdalutils.cpp.

◆ supportsRasterCreate()

bool QgsGdalUtils::supportsRasterCreate ( GDALDriverH driver )

static

Reads whether a driver supports GDALCreate() for raster purposes.

Parameters

driver GDAL driver

Returns: true if a driver supports GDALCreate() for raster purposes.

Definition at line 34 of file qgsgdalutils.cpp.

◆ validateCreationOptionsFormat()

QString QgsGdalUtils::validateCreationOptionsFormat	(	const QStringList &	createOptions,
		const QString &	format
	)

static

Validates creation options for a given format, regardless of layer.

Since: QGIS 3.10

Definition at line 280 of file qgsgdalutils.cpp.

◆ vrtMatchesLayerType()

bool QgsGdalUtils::vrtMatchesLayerType	(	const QString &	vrtPath,
		QgsMapLayerType	type
	)

static

Returns true if the VRT file at the specified path is a VRT matching the given layer type.

Since: QGIS 3.22

Definition at line 634 of file qgsgdalutils.cpp.

Friends And Related Function Documentation

◆ TestQgsGdalUtils

friend class TestQgsGdalUtils

friend

Definition at line 167 of file qgsgdalutils.h.

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

/build/qgis-3.24.2+99sid/src/core/qgsgdalutils.h
/build/qgis-3.24.2+99sid/src/core/qgsgdalutils.cpp

Static Public Member Functions

Friends

Detailed Description

Member Function Documentation

◆ createMultiBandMemoryDataset()

◆ createSingleBandMemoryDataset()

◆ createSingleBandTiffDataset()

◆ helpCreationOptionsFormat()

◆ imageToMemoryDataset()

◆ multiLayerFileExtensions()

◆ papszFromStringList()

◆ pathIsCheapToOpen()

◆ resampleImage()

◆ resampleSingleBandRaster()

◆ rpcAwareAutoCreateWarpedVrt()

◆ rpcAwareCreateTransformer()

◆ setupProxy()

◆ supportsRasterCreate()

◆ validateCreationOptionsFormat()

◆ vrtMatchesLayerType()

Friends And Related Function Documentation

◆ TestQgsGdalUtils