QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
The raster file writer which allows you to save a raster to a new file. More...
#include <qgsrasterfilewriter.h>
Classes | |
struct | FilterFormatDetails |
Details of available filters and formats. More... | |
Public Types | |
typedef QFlags< RasterFormatOption > | RasterFormatOptions |
Public Member Functions | |
QgsRasterFileWriter (const QString &outputUrl) | |
Constructor for QgsRasterFileWriter, writing to the specified output URL/filename. | |
Qgis::RasterBuildPyramidOption | buildPyramidsFlag () const |
Returns the pyramid building option. | |
QgsRasterDataProvider * | createMultiBandRaster (Qgis::DataType dataType, int width, int height, const QgsRectangle &extent, const QgsCoordinateReferenceSystem &crs, int nBands) SIP_FACTORY |
Create a raster file with given number of bands without initializing the pixel data. | |
QgsRasterDataProvider * | createOneBandRaster (Qgis::DataType dataType, int width, int height, const QgsRectangle &extent, const QgsCoordinateReferenceSystem &crs) SIP_FACTORY |
Create a raster file with one band without initializing the pixel data. | |
QStringList | createOptions () const |
Returns the list of data source creation options which will be used when creating the output raster file. | |
int | maxTileHeight () const |
Returns the maximum tile height (in pixels) for tiled outputs. | |
int | maxTileWidth () const |
Returns the maximum tile width (in pixels) for tiled outputs. | |
QString | outputFormat () const |
Returns the output format. | |
QString | outputProviderKey () const |
Returns the name of the data provider for the raster output. | |
QString | outputUrl () const |
Returns the output URL (filename) for the raster. | |
QStringList | pyramidsConfigOptions () const |
Returns the list of configuration options used when creating the pyramids for the output raster file. | |
Qgis::RasterPyramidFormat | pyramidsFormat () const |
Returns the raster pyramid format. | |
QList< int > | pyramidsList () const |
Returns the list of pyramids which will be created for the output file. | |
QString | pyramidsResampling () const |
void | setBuildPyramidsFlag (Qgis::RasterBuildPyramidOption f) |
Sets the pyramid building option. | |
void | setCreateOptions (const QStringList &list) |
Sets a list of data source creation options to use when creating the output raster file. | |
void | setMaxTileHeight (int h) |
Sets the maximum tile height (in pixels) for tiled outputs. | |
void | setMaxTileWidth (int w) |
Sets the maximum tile width (in pixels) for tiled outputs. | |
void | setOutputFormat (const QString &format) |
Sets the output format. | |
void | setOutputProviderKey (const QString &key) |
Sets the name of the data provider for the raster output. | |
void | setPyramidsConfigOptions (const QStringList &list) |
Sets a list of configuration options to use when creating the pyramids for the output raster file. | |
void | setPyramidsFormat (Qgis::RasterPyramidFormat f) |
Sets the raster pyramid format. | |
void | setPyramidsList (const QList< int > &list) |
Sets the list of pyramids which will be created for the output file. | |
void | setPyramidsResampling (const QString &str) |
void | setTiledMode (bool t) |
Sets whether the output should be tiled. | |
enum RasterFormatOption | SIP_ENUM_BASETYPE (IntFlag) |
Options for sorting and filtering raster formats. | |
bool | tiledMode () const |
Returns whether the output will be tiled. | |
Qgis::RasterFileWriterResult | writeRaster (const QgsRasterPipe *pipe, int nCols, int nRows, const QgsRectangle &outputExtent, const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &transformContext, QgsRasterBlockFeedback *feedback=nullptr) |
Write raster file. | |
Q_DECL_DEPRECATED Qgis::RasterFileWriterResult | writeRaster (const QgsRasterPipe *pipe, int nCols, int nRows, const QgsRectangle &outputExtent, const QgsCoordinateReferenceSystem &crs, QgsRasterBlockFeedback *feedback=nullptr) SIP_DEPRECATED |
Write raster file. | |
Static Public Member Functions | |
static QString | driverForExtension (const QString &extension) |
Returns the GDAL driver name for a specified file extension. | |
static QStringList | extensionsForFormat (const QString &format) |
Returns a list of known file extensions for the given GDAL driver format. | |
static QString | filterForDriver (const QString &driverName) |
Creates a filter for an GDAL driver key. | |
static QList< QgsRasterFileWriter::FilterFormatDetails > | supportedFiltersAndFormats (RasterFormatOptions options=SortRecommended) |
Returns a list or pairs, with format filter string as first element and GDAL format key as second element. | |
static QStringList | supportedFormatExtensions (RasterFormatOptions options=SortRecommended) |
Returns a list of file extensions for supported formats. | |
The raster file writer which allows you to save a raster to a new file.
The writer defaults to creating GeoTIFF outputs using GDAL. Alternative formats and data providers can be used by calling setOutputFormat() and setOutputProviderKey().
Definition at line 40 of file qgsrasterfilewriter.h.
typedef QFlags< RasterFormatOption > QgsRasterFileWriter::RasterFormatOptions |
Definition at line 51 of file qgsrasterfilewriter.h.
QgsRasterFileWriter::QgsRasterFileWriter | ( | const QString & | outputUrl | ) |
Constructor for QgsRasterFileWriter, writing to the specified output URL/filename.
Definition at line 66 of file qgsrasterfilewriter.cpp.
|
inline |
Returns the pyramid building option.
Definition at line 192 of file qgsrasterfilewriter.h.
QgsRasterDataProvider * QgsRasterFileWriter::createMultiBandRaster | ( | Qgis::DataType | dataType, |
int | width, | ||
int | height, | ||
const QgsRectangle & | extent, | ||
const QgsCoordinateReferenceSystem & | crs, | ||
int | nBands | ||
) |
Create a raster file with given number of bands without initializing the pixel data.
Returned provider may be used to initialize the raster using writeBlock() calls. Ownership of the returned provider is passed to the caller.
nullptr
on error. Definition at line 54 of file qgsrasterfilewriter.cpp.
QgsRasterDataProvider * QgsRasterFileWriter::createOneBandRaster | ( | Qgis::DataType | dataType, |
int | width, | ||
int | height, | ||
const QgsRectangle & | extent, | ||
const QgsCoordinateReferenceSystem & | crs | ||
) |
Create a raster file with one band without initializing the pixel data.
Returned provider may be used to initialize the raster using writeBlock() calls. Ownership of the returned provider is passed to the caller.
nullptr
on error. Definition at line 42 of file qgsrasterfilewriter.cpp.
|
inline |
Returns the list of data source creation options which will be used when creating the output raster file.
Definition at line 264 of file qgsrasterfilewriter.h.
|
static |
Returns the GDAL driver name for a specified file extension.
E.g. the driver name for the ".tif" extension is "GTiff". If no suitable drivers are found then an empty string is returned.
Note that this method works for all GDAL drivers, including those without create support (and which are not supported by QgsRasterFileWriter).
Definition at line 1066 of file qgsrasterfilewriter.cpp.
|
static |
Returns a list of known file extensions for the given GDAL driver format.
E.g. returns "tif", "tiff" for the format "GTiff".
If no matching format driver is found an empty list will be returned.
Note that this method works for all GDAL drivers, including those without create support (and which are not supported by QgsRasterFileWriter).
Definition at line 1111 of file qgsrasterfilewriter.cpp.
|
static |
Creates a filter for an GDAL driver key.
Definition at line 1125 of file qgsrasterfilewriter.cpp.
|
inline |
Returns the maximum tile height (in pixels) for tiled outputs.
Definition at line 248 of file qgsrasterfilewriter.h.
|
inline |
Returns the maximum tile width (in pixels) for tiled outputs.
Definition at line 185 of file qgsrasterfilewriter.h.
|
inline |
Returns the output format.
For GDAL disk based outputs this will match the GDAL driver name, e.g. "GTiff" for GeoTiff exports.
Definition at line 134 of file qgsrasterfilewriter.h.
|
inline |
Returns the name of the data provider for the raster output.
Definition at line 150 of file qgsrasterfilewriter.h.
|
inline |
Returns the output URL (filename) for the raster.
Definition at line 116 of file qgsrasterfilewriter.h.
|
inline |
Returns the list of configuration options used when creating the pyramids for the output raster file.
Definition at line 280 of file qgsrasterfilewriter.h.
|
inline |
Returns the raster pyramid format.
Definition at line 223 of file qgsrasterfilewriter.h.
|
inline |
Returns the list of pyramids which will be created for the output file.
Definition at line 206 of file qgsrasterfilewriter.h.
|
inline |
Definition at line 215 of file qgsrasterfilewriter.h.
|
inline |
Sets the pyramid building option.
Definition at line 199 of file qgsrasterfilewriter.h.
|
inline |
Sets a list of data source creation options to use when creating the output raster file.
Definition at line 256 of file qgsrasterfilewriter.h.
|
inline |
Sets the maximum tile height (in pixels) for tiled outputs.
Definition at line 239 of file qgsrasterfilewriter.h.
|
inline |
Sets the maximum tile width (in pixels) for tiled outputs.
Definition at line 176 of file qgsrasterfilewriter.h.
|
inline |
Sets the output format.
For GDAL disk based outputs this should match the GDAL driver name, e.g. "GTiff" for GeoTiff exports.
Definition at line 125 of file qgsrasterfilewriter.h.
|
inline |
Sets the name of the data provider for the raster output.
E.g. set to "gdal" to use GDAL to create disk based raster files.
Definition at line 143 of file qgsrasterfilewriter.h.
|
inline |
Sets a list of configuration options to use when creating the pyramids for the output raster file.
Definition at line 272 of file qgsrasterfilewriter.h.
|
inline |
Sets the raster pyramid format.
Definition at line 230 of file qgsrasterfilewriter.h.
|
inline |
Sets the list of pyramids which will be created for the output file.
Definition at line 213 of file qgsrasterfilewriter.h.
|
inline |
Definition at line 216 of file qgsrasterfilewriter.h.
|
inline |
Sets whether the output should be tiled.
Tiled outputs will automatically split the raster into multiple parts, based on the maxTileWidth() value.
Definition at line 160 of file qgsrasterfilewriter.h.
|
inline |
Options for sorting and filtering raster formats.
< Use recommended sort order, with extremely commonly used formats listed first
Definition at line 47 of file qgsrasterfilewriter.h.
|
static |
Returns a list or pairs, with format filter string as first element and GDAL format key as second element.
Relies on GDAL_DMD_EXTENSIONS metadata, if it is empty corresponding driver will be skipped even if supported.
The options argument can be used to control the sorting and filtering of returned formats.
Definition at line 1149 of file qgsrasterfilewriter.cpp.
|
static |
Returns a list of file extensions for supported formats.
The options argument can be used to control the sorting and filtering of returned formats.
Definition at line 1216 of file qgsrasterfilewriter.cpp.
|
inline |
Returns whether the output will be tiled.
Definition at line 167 of file qgsrasterfilewriter.h.
Qgis::RasterFileWriterResult QgsRasterFileWriter::writeRaster | ( | const QgsRasterPipe * | pipe, |
int | nCols, | ||
int | nRows, | ||
const QgsRectangle & | outputExtent, | ||
const QgsCoordinateReferenceSystem & | crs, | ||
const QgsCoordinateTransformContext & | transformContext, | ||
QgsRasterBlockFeedback * | feedback = nullptr |
||
) |
Write raster file.
pipe | raster pipe |
nCols | number of output columns |
nRows | number of output rows (or -1 to automatically calculate row number to have square pixels) |
outputExtent | extent to output |
crs | crs to reproject to |
transformContext | coordinate transform context |
feedback | optional feedback object for progress reports |
Definition at line 85 of file qgsrasterfilewriter.cpp.
Qgis::RasterFileWriterResult QgsRasterFileWriter::writeRaster | ( | const QgsRasterPipe * | pipe, |
int | nCols, | ||
int | nRows, | ||
const QgsRectangle & | outputExtent, | ||
const QgsCoordinateReferenceSystem & | crs, | ||
QgsRasterBlockFeedback * | feedback = nullptr |
||
) |
Write raster file.
pipe | raster pipe |
nCols | number of output columns |
nRows | number of output rows (or -1 to automatically calculate row number to have square pixels) |
outputExtent | extent to output |
crs | crs to reproject to |
feedback | optional feedback object for progress reports |
Definition at line 79 of file qgsrasterfilewriter.cpp.