QGIS/python/core/raster/qgsrasterfilewriter.sip
Nyall Dawson bfd37e1122 [sipify] Add return types for functions in docstrings
and change \return -> :return: in docystrings
2017-04-08 09:48:48 +10:00

151 lines
4.2 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/raster/qgsrasterfilewriter.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsRasterFileWriter
{
%Docstring
The raster file writer which allows you to save a raster to a new file.
%End
%TypeHeaderCode
#include "qgsrasterfilewriter.h"
%End
public:
enum Mode
{
Raw,
Image
};
enum WriterError
{
NoError,
SourceProviderError,
DestProviderError,
CreateDatasourceError,
WriteError,
NoDataConflict,
WriteCanceled,
};
QgsRasterFileWriter( const QString &outputUrl );
QgsRasterDataProvider *createOneBandRaster( Qgis::DataType dataType,
int width, int height,
const QgsRectangle &extent,
const QgsCoordinateReferenceSystem &crs ) /Factory/;
%Docstring
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.
.. note::
Does not work with tiled mode enabled.
:return: Instance of data provider in editing mode (on success) or None on error.
.. versionadded:: 3.0
:rtype: QgsRasterDataProvider
%End
WriterError writeRaster( const QgsRasterPipe *pipe, int nCols, int nRows, const QgsRectangle &outputExtent,
const QgsCoordinateReferenceSystem &crs, QgsRasterBlockFeedback *feedback = 0 );
%Docstring
Write raster file
\param pipe raster pipe
\param nCols number of output columns
\param nRows number of output rows (or -1 to automatically calculate row number to have square pixels)
\param outputExtent extent to output
\param crs crs to reproject to
\param feedback optional feedback object for progress reports
:rtype: WriterError
%End
QString outputUrl() const;
%Docstring
Returns the output URL for the raster.
.. versionadded:: 3.0
:rtype: str
%End
void setOutputFormat( const QString &format );
QString outputFormat() const;
%Docstring
:rtype: str
%End
void setOutputProviderKey( const QString &key );
QString outputProviderKey() const;
%Docstring
:rtype: str
%End
void setTiledMode( bool t );
bool tiledMode() const;
%Docstring
:rtype: bool
%End
void setMaxTileWidth( int w );
int maxTileWidth() const;
%Docstring
:rtype: int
%End
QgsRaster::RasterBuildPyramids buildPyramidsFlag() const;
%Docstring
:rtype: QgsRaster.RasterBuildPyramids
%End
void setBuildPyramidsFlag( QgsRaster::RasterBuildPyramids f );
QList< int > pyramidsList() const;
%Docstring
:rtype: list of int
%End
void setPyramidsList( const QList< int > &list );
QString pyramidsResampling() const;
%Docstring
:rtype: str
%End
void setPyramidsResampling( const QString &str );
QgsRaster::RasterPyramidsFormat pyramidsFormat() const;
%Docstring
:rtype: QgsRaster.RasterPyramidsFormat
%End
void setPyramidsFormat( QgsRaster::RasterPyramidsFormat f );
void setMaxTileHeight( int h );
int maxTileHeight() const;
%Docstring
:rtype: int
%End
void setCreateOptions( const QStringList &list );
QStringList createOptions() const;
%Docstring
:rtype: list of str
%End
void setPyramidsConfigOptions( const QStringList &list );
QStringList pyramidsConfigOptions() const;
%Docstring
:rtype: list of str
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/raster/qgsrasterfilewriter.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/