QGIS API Documentation  2.7.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.

Definition at line 32 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.

Member Function Documentation

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.

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.

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.

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

Definition at line 49 of file qgsrasterfilewriter.cpp.


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