The raster file writer which allows you to save a raster to a new file. More...

#include <qgsrasterfilewriter.h>

Collaboration diagram for QgsRasterFileWriter:

Public Types
enum	Mode { Raw = 0, Image = 1 }
enum	WriterError { NoError = 0, SourceProviderError = 1, DestProviderError = 2, CreateDatasourceError = 3, WriteError = 4, NoDataConflict = 5 }
Public Member Functions
	QgsRasterFileWriter (const QString &outputUrl)
	~QgsRasterFileWriter ()
QgsRaster::RasterBuildPyramids	buildPyramidsFlag () const
QStringList	createOptions () const
int	maxTileHeight () const
int	maxTileWidth () const
QString	outputFormat () const
QString	outputProviderKey () const
QStringList	pyramidsConfigOptions () const
QgsRaster::RasterPyramidsFormat	pyramidsFormat () const
QList< int >	pyramidsList () const
QString	pyramidsResampling () const
void	setBuildPyramidsFlag (QgsRaster::RasterBuildPyramids f)
void	setCreateOptions (const QStringList &list)
void	setMaxTileHeight (int h)
void	setMaxTileWidth (int w)
void	setOutputFormat (const QString &format)
void	setOutputProviderKey (const QString &key)
void	setPyramidsConfigOptions (const QStringList &list)
void	setPyramidsFormat (QgsRaster::RasterPyramidsFormat f)
void	setPyramidsList (const QList< int > &list)
void	setPyramidsResampling (const QString &str)
void	setTiledMode (bool t)
bool	tiledMode () const
WriterError	writeRaster (const QgsRasterPipe pipe, int nCols, int nRows, QgsRectangle outputExtent, const QgsCoordinateReferenceSystem &crs, QProgressDialog p=0)
	Write raster file.
Private Member Functions
	QgsRasterFileWriter ()
void	addToVRT (const QString &filename, int band, int xSize, int ySize, int xOffset, int yOffset)
void	buildPyramids (const QString &filename)
QgsRasterDataProvider *	createPartProvider (const QgsRectangle &extent, int nCols, int iterCols, int iterRows, int iterLeft, int iterTop, const QString &outputUrl, int fileIndex, int nBands, QGis::DataType type, const QgsCoordinateReferenceSystem &crs)
	Create provider and datasource for a part image (vrt mode)
void	createVRT (int xSize, int ySize, const QgsCoordinateReferenceSystem &crs, double *geoTransform, QGis::DataType type, QList< bool > destHasNoDataValueList, QList< double > destNoDataValueList)
	Initialize vrt member variables.
void	globalOutputParameters (const QgsRectangle &extent, int nCols, int &nRows, double *geoTransform, double &pixelSize)
	Calculate nRows, geotransform and pixel size for output.
QgsRasterDataProvider *	initOutput (int nCols, int nRows, const QgsCoordinateReferenceSystem &crs, double *geoTransform, int nBands, QGis::DataType type, QList< bool > destHasNoDataValueList=QList< bool >(), QList< double > destNoDataValueList=QList< double >())
	Init VRT (for tiled mode) or create global output provider (single-file mode)
QString	partFileName (int fileIndex)
QString	vrtFileName ()
WriterError	writeDataRaster (const QgsRasterPipe pipe, QgsRasterIterator iter, int nCols, int nRows, const QgsRectangle &outputExtent, const QgsCoordinateReferenceSystem &crs, QProgressDialog *progressDialog=0)
WriterError	writeDataRaster (const QgsRasterPipe pipe, QgsRasterIterator iter, int nCols, int nRows, const QgsRectangle &outputExtent, const QgsCoordinateReferenceSystem &crs, QGis::DataType destDataType, QList< bool > destHasNoDataValueList, QList< double > destNoDataValueList, QgsRasterDataProvider destProvider, QProgressDialog progressDialog)
WriterError	writeImageRaster (QgsRasterIterator iter, int nCols, int nRows, const QgsRectangle &outputExtent, const QgsCoordinateReferenceSystem &crs, QProgressDialog progressDialog=0)
bool	writeVRT (const QString &file)
Private Attributes
QgsRaster::RasterBuildPyramids	mBuildPyramidsFlag
QStringList	mCreateOptions
const QgsRasterInterface *	mInput
double	mMaxTileHeight
double	mMaxTileWidth
Mode	mMode
QgsCoordinateReferenceSystem	mOutputCRS
QString	mOutputFormat
QString	mOutputProviderKey
QString	mOutputUrl
const QgsRasterPipe *	mPipe
QProgressDialog *	mProgressDialog
QStringList	mPyramidsConfigOptions
QgsRaster::RasterPyramidsFormat	mPyramidsFormat
QList< int >	mPyramidsList
QString	mPyramidsResampling
bool	mTiledMode
	False: Write one file, true: create a directory and add the files numbered.
QList< QDomElement >	mVRTBands
QDomDocument	mVRTDocument

Detailed Description

The raster file writer which allows you to save a raster to a new file.

Definition at line 32 of file qgsrasterfilewriter.h.

Member Enumeration Documentation

enum QgsRasterFileWriter::Mode

Enumerator:

Raw
Image

Definition at line 35 of file qgsrasterfilewriter.h.

enum QgsRasterFileWriter::WriterError

Enumerator:

NoError
SourceProviderError
DestProviderError
CreateDatasourceError
WriteError
NoDataConflict

Definition at line 40 of file qgsrasterfilewriter.h.

Constructor & Destructor Documentation

QgsRasterFileWriter::QgsRasterFileWriter ( const QString & outputUrl )

Definition at line 29 of file qgsrasterfilewriter.cpp.

QgsRasterFileWriter::~QgsRasterFileWriter ( )

Definition at line 44 of file qgsrasterfilewriter.cpp.

QgsRasterFileWriter::QgsRasterFileWriter ( ) [private]

Definition at line 39 of file qgsrasterfilewriter.cpp.

Member Function Documentation

void QgsRasterFileWriter::addToVRT	(	const QString &	filename,
		int	band,
		int	xSize,
		int	ySize,
		int	xOffset,
		int	yOffset
	)		`[private]`

Definition at line 608 of file qgsrasterfilewriter.cpp.

References mVRTBands, and mVRTDocument.

Referenced by writeDataRaster(), and writeImageRaster().

void QgsRasterFileWriter::buildPyramids ( const QString & filename ) [private]

Definition at line 688 of file qgsrasterfilewriter.cpp.

References QgsRasterDataProvider::buildPyramidList(), QgsRasterDataProvider::buildPyramids(), QgsProviderRegistry::instance(), mOutputProviderKey, mPyramidsConfigOptions, mPyramidsFormat, mPyramidsList, mPyramidsResampling, QgsProviderRegistry::provider(), QgsDebugMsg, and tr.

Referenced by writeDataRaster(), and writeImageRaster().

QgsRaster::RasterBuildPyramids QgsRasterFileWriter::buildPyramidsFlag ( ) const [inline]

Definition at line 76 of file qgsrasterfilewriter.h.

QStringList QgsRasterFileWriter::createOptions ( ) const [inline]

Definition at line 92 of file qgsrasterfilewriter.h.

QgsRasterDataProvider * QgsRasterFileWriter::createPartProvider	(	const QgsRectangle &	extent,
		int	nCols,
		int	iterCols,
		int	iterRows,
		int	iterLeft,
		int	iterTop,
		const QString &	outputUrl,
		int	fileIndex,
		int	nBands,
		QGis::DataType	type,
		const QgsCoordinateReferenceSystem &	crs
	)		`[private]`

Create provider and datasource for a part image (vrt mode)

Definition at line 863 of file qgsrasterfilewriter.cpp.

References QgsRasterDataProvider::create(), mCreateOptions, mOutputFormat, mOutputProviderKey, partFileName(), QgsRectangle::width(), QgsRectangle::xMinimum(), and QgsRectangle::yMaximum().

Referenced by writeDataRaster(), and writeImageRaster().

void QgsRasterFileWriter::createVRT	(	int	xSize,
		int	ySize,
		const QgsCoordinateReferenceSystem &	crs,
		double *	geoTransform,
		QGis::DataType	type,
		QList< bool >	destHasNoDataValueList,
		QList< double >	destNoDataValueList
	)		`[private]`

Initialize vrt member variables.

Parameters:

xSize	width of vrt
ySize	height of vrt
crs	coordinate system of vrt
geoTransform	optional array of transformation matrix values
type	datatype of vrt
destHasNoDataValueList	true if destination has no data value, indexed from 0
destNoDataValueList	no data value, indexed from 0

Definition at line 771 of file qgsrasterfilewriter.cpp.

References QgsRasterInterface::bandCount(), QGis::Byte, QGis::CFloat32, QGis::CFloat64, QGis::CInt16, QGis::CInt32, QGis::Float32, QGis::Float64, Image, QGis::Int16, mInput, mMode, mVRTBands, mVRTDocument, Raw, QgsCoordinateReferenceSystem::toWkt(), QGis::UInt16, and QGis::UInt32.

Referenced by initOutput().

void QgsRasterFileWriter::globalOutputParameters	(	const QgsRectangle &	extent,
		int	nCols,
		int &	nRows,
		double *	geoTransform,
		double &	pixelSize
	)		`[private]`

Calculate nRows, geotransform and pixel size for output.

Definition at line 922 of file qgsrasterfilewriter.cpp.

References QgsRectangle::height(), QgsRectangle::width(), QgsRectangle::xMinimum(), and QgsRectangle::yMaximum().

Referenced by writeDataRaster(), and writeImageRaster().

QgsRasterDataProvider * QgsRasterFileWriter::initOutput	(	int	nCols,
		int	nRows,
		const QgsCoordinateReferenceSystem &	crs,
		double *	geoTransform,
		int	nBands,
		QGis::DataType	type,
		QList< bool >	destHasNoDataValueList = `QList<bool>()`,
		QList< double >	destNoDataValueList = `QList<double>()`
	)		`[private]`

Init VRT (for tiled mode) or create global output provider (single-file mode)

Parameters:

nCols	number of tile columns
nRows	number of tile rows
crs	coordinate system of vrt
geoTransform	optional array of transformation matrix values
nBands	number of bands
type	datatype of vrt
destHasNoDataValueList	true if destination has no data value, indexed from 0
destNoDataValueList	no data value, indexed from 0

Definition at line 893 of file qgsrasterfilewriter.cpp.

References QgsRasterDataProvider::create(), createVRT(), mBuildPyramidsFlag, mCreateOptions, mOutputFormat, mOutputProviderKey, mOutputUrl, mTiledMode, and QgsDebugMsg.

Referenced by writeDataRaster(), and writeImageRaster().

int QgsRasterFileWriter::maxTileHeight ( ) const [inline]

Definition at line 89 of file qgsrasterfilewriter.h.

int QgsRasterFileWriter::maxTileWidth ( ) const [inline]

Definition at line 74 of file qgsrasterfilewriter.h.

QString QgsRasterFileWriter::outputFormat ( ) const [inline]

Definition at line 65 of file qgsrasterfilewriter.h.

QString QgsRasterFileWriter::outputProviderKey ( ) const [inline]

Definition at line 68 of file qgsrasterfilewriter.h.

QString QgsRasterFileWriter::partFileName ( int fileIndex ) [private]

Definition at line 940 of file qgsrasterfilewriter.cpp.

References mOutputUrl.

Referenced by createPartProvider(), writeDataRaster(), and writeImageRaster().

QStringList QgsRasterFileWriter::pyramidsConfigOptions ( ) const [inline]

Definition at line 95 of file qgsrasterfilewriter.h.

QgsRaster::RasterPyramidsFormat QgsRasterFileWriter::pyramidsFormat ( ) const [inline]

Definition at line 85 of file qgsrasterfilewriter.h.

QList< int > QgsRasterFileWriter::pyramidsList ( ) const [inline]

Definition at line 79 of file qgsrasterfilewriter.h.

QString QgsRasterFileWriter::pyramidsResampling ( ) const [inline]

Definition at line 82 of file qgsrasterfilewriter.h.

void QgsRasterFileWriter::setBuildPyramidsFlag ( QgsRaster::RasterBuildPyramids f ) [inline]

Definition at line 77 of file qgsrasterfilewriter.h.

void QgsRasterFileWriter::setCreateOptions ( const QStringList & list ) [inline]

Definition at line 91 of file qgsrasterfilewriter.h.

void QgsRasterFileWriter::setMaxTileHeight ( int h ) [inline]

Definition at line 88 of file qgsrasterfilewriter.h.

void QgsRasterFileWriter::setMaxTileWidth ( int w ) [inline]

Definition at line 73 of file qgsrasterfilewriter.h.

void QgsRasterFileWriter::setOutputFormat ( const QString & format ) [inline]

Definition at line 64 of file qgsrasterfilewriter.h.

void QgsRasterFileWriter::setOutputProviderKey ( const QString & key ) [inline]

Definition at line 67 of file qgsrasterfilewriter.h.

void QgsRasterFileWriter::setPyramidsConfigOptions ( const QStringList & list ) [inline]

Definition at line 94 of file qgsrasterfilewriter.h.

void QgsRasterFileWriter::setPyramidsFormat ( QgsRaster::RasterPyramidsFormat f ) [inline]

Definition at line 86 of file qgsrasterfilewriter.h.

void QgsRasterFileWriter::setPyramidsList ( const QList< int > & list ) [inline]

Definition at line 80 of file qgsrasterfilewriter.h.

void QgsRasterFileWriter::setPyramidsResampling ( const QString & str ) [inline]

Definition at line 83 of file qgsrasterfilewriter.h.

void QgsRasterFileWriter::setTiledMode ( bool t ) [inline]

Definition at line 70 of file qgsrasterfilewriter.h.

bool QgsRasterFileWriter::tiledMode ( ) const [inline]

Definition at line 71 of file qgsrasterfilewriter.h.

QString QgsRasterFileWriter::vrtFileName ( ) [private]

Definition at line 947 of file qgsrasterfilewriter.cpp.

References mOutputUrl.

Referenced by writeDataRaster(), and writeImageRaster().

QgsRasterFileWriter::WriterError QgsRasterFileWriter::writeDataRaster	(	const QgsRasterPipe *	pipe,
		QgsRasterIterator *	iter,
		int	nCols,
		int	nRows,
		const QgsRectangle &	outputExtent,
		const QgsCoordinateReferenceSystem &	crs,
		QProgressDialog *	progressDialog = `0`
	)		`[private]`

Definition at line 119 of file qgsrasterfilewriter.cpp.

References QgsRasterInterface::bandCount(), QgsRasterInterface::bandStatistics(), QgsRectangle::contains(), QgsRasterProjector::destCrs(), DestProviderError, QgsRasterDataProvider::extent(), globalOutputParameters(), initOutput(), QgsRasterPipe::last(), QgsRasterBandStats::Max, QgsRasterBandStats::maximumValue, QgsContrastEnhancement::maximumValuePossible(), QgsRasterBandStats::Min, QgsRasterBandStats::minimumValue, mMaxTileHeight, mMaxTileWidth, QgsRasterNuller::noData(), NoDataConflict, QgsRasterPipe::nuller(), QgsRasterPipe::projector(), QgsDebugMsg, QgsRasterDataProvider::remove(), QgsRasterIterator::setMaximumTileHeight(), QgsRasterIterator::setMaximumTileWidth(), QgsRasterNuller::setOutputNoDataValue(), SourceProviderError, QgsRasterProjector::srcCrs(), QgsRasterDataProvider::srcDataType(), QgsRasterDataProvider::srcHasNoDataValue(), QgsRasterInterface::srcInput(), QgsRasterDataProvider::srcNoDataValue(), QgsRasterBlock::typeSize(), and QgsRasterBlock::typeWithNoDataValue().

Referenced by writeRaster().

QgsRasterFileWriter::WriterError QgsRasterFileWriter::writeDataRaster	(	const QgsRasterPipe *	pipe,
		QgsRasterIterator *	iter,
		int	nCols,
		int	nRows,
		const QgsRectangle &	outputExtent,
		const QgsCoordinateReferenceSystem &	crs,
		QGis::DataType	destDataType,
		QList< bool >	destHasNoDataValueList,
		QList< double >	destNoDataValueList,
		QgsRasterDataProvider *	destProvider,
		QProgressDialog *	progressDialog
	)		`[private]`

QgsRasterFileWriter::WriterError QgsRasterFileWriter::writeImageRaster	(	QgsRasterIterator *	iter,
		int	nCols,
		int	nRows,
		const QgsRectangle &	outputExtent,
		const QgsCoordinateReferenceSystem &	crs,
		QProgressDialog *	progressDialog = `0`
	)		`[private]`

Definition at line 446 of file qgsrasterfilewriter.cpp.

References addToVRT(), QGis::ARGB32, QGis::ARGB32_Premultiplied, buildPyramids(), QGis::Byte, QgsRasterBlock::color(), createPartProvider(), QgsRasterInterface::dataType(), globalOutputParameters(), initOutput(), QgsRasterIterator::input(), QgsRasterIterator::maximumTileHeight(), QgsRasterIterator::maximumTileWidth(), mBuildPyramidsFlag, mMaxTileHeight, mMaxTileWidth, mOutputUrl, mTiledMode, NoError, partFileName(), QgsRaster::PyramidsFlagYes, QgsDebugMsg, QgsDebugMsgLevel, qgsFree(), qgsMalloc(), QgsRasterIterator::readNextRasterPart(), QgsRasterIterator::setMaximumTileHeight(), QgsRasterIterator::setMaximumTileWidth(), QgsRasterBlock::setValue(), SourceProviderError, QgsRasterIterator::startRasterRead(), tr, vrtFileName(), QgsRasterDataProvider::write(), and writeVRT().

Referenced by writeRaster().

QgsRasterFileWriter::WriterError QgsRasterFileWriter::writeRaster	(	const QgsRasterPipe *	pipe,
		int	nCols,
		int	nRows,
		QgsRectangle	outputExtent,
		const QgsCoordinateReferenceSystem &	crs,
		QProgressDialog *	p = `0`
	)

Write raster file.

Parameters:

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
p	dialog to show progress in