QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | List of all members
QgsRasterFileWriter Class Reference

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

#include <qgsrasterfilewriter.h>

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 ()
 
WriterError writeRaster (const QgsRasterPipe *pipe, int nCols, int nRows, QgsRectangle outputExtent, const QgsCoordinateReferenceSystem &crs, QProgressDialog *p=0)
 Write raster file. More...
 
void setOutputFormat (const QString &format)
 
QString outputFormat () const
 
void setOutputProviderKey (const QString &key)
 
QString outputProviderKey () const
 
void setTiledMode (bool t)
 
bool tiledMode () const
 
void setMaxTileWidth (int w)
 
int maxTileWidth () const
 
QgsRaster::RasterBuildPyramids buildPyramidsFlag () const
 
void setBuildPyramidsFlag (QgsRaster::RasterBuildPyramids f)
 
QList< int > pyramidsList () const
 
void setPyramidsList (const QList< int > &list)
 
QString pyramidsResampling () const
 
void setPyramidsResampling (const QString &str)
 
QgsRaster::RasterPyramidsFormat pyramidsFormat () const
 
void setPyramidsFormat (QgsRaster::RasterPyramidsFormat f)
 
void setMaxTileHeight (int h)
 
int maxTileHeight () const
 
void setCreateOptions (const QStringList &list)
 
QStringList createOptions () const
 
void setPyramidsConfigOptions (const QStringList &list)
 
QStringList pyramidsConfigOptions () const
 

Detailed Description

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

Constructor & Destructor Documentation

QgsRasterFileWriter::QgsRasterFileWriter ( const QString &  outputUrl)
QgsRasterFileWriter::~QgsRasterFileWriter ( )

Member Function Documentation

QgsRaster::RasterBuildPyramids QgsRasterFileWriter::buildPyramidsFlag ( ) const
inline
QStringList QgsRasterFileWriter::createOptions ( ) const
inline
int QgsRasterFileWriter::maxTileHeight ( ) const
inline
int QgsRasterFileWriter::maxTileWidth ( ) const
inline
QString QgsRasterFileWriter::outputFormat ( ) const
inline
QString QgsRasterFileWriter::outputProviderKey ( ) const
inline
QStringList QgsRasterFileWriter::pyramidsConfigOptions ( ) const
inline
QgsRaster::RasterPyramidsFormat QgsRasterFileWriter::pyramidsFormat ( ) const
inline
QList< int > QgsRasterFileWriter::pyramidsList ( ) const
inline
QString QgsRasterFileWriter::pyramidsResampling ( ) const
inline
void QgsRasterFileWriter::setBuildPyramidsFlag ( QgsRaster::RasterBuildPyramids  f)
inline
void QgsRasterFileWriter::setCreateOptions ( const QStringList &  list)
inline
void QgsRasterFileWriter::setMaxTileHeight ( int  h)
inline
void QgsRasterFileWriter::setMaxTileWidth ( int  w)
inline
void QgsRasterFileWriter::setOutputFormat ( const QString &  format)
inline
void QgsRasterFileWriter::setOutputProviderKey ( const QString &  key)
inline
void QgsRasterFileWriter::setPyramidsConfigOptions ( const QStringList &  list)
inline
void QgsRasterFileWriter::setPyramidsFormat ( QgsRaster::RasterPyramidsFormat  f)
inline
void QgsRasterFileWriter::setPyramidsList ( const QList< int > &  list)
inline
void QgsRasterFileWriter::setPyramidsResampling ( const QString &  str)
inline
void QgsRasterFileWriter::setTiledMode ( bool  t)
inline
bool QgsRasterFileWriter::tiledMode ( ) const
inline
QgsRasterFileWriter::WriterError QgsRasterFileWriter::writeRaster ( const QgsRasterPipe pipe,
int  nCols,
int  nRows,
QgsRectangle  outputExtent,
const QgsCoordinateReferenceSystem crs,
QProgressDialog *  p = 0 
)

Write raster file.

Parameters
piperaster pipe
nColsnumber of output columns
nRowsnumber of output rows (or -1 to automatically calculate row number to have square pixels)
outputExtentextent to output
crscrs to reproject to
pdialog to show progress in

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