qgsrasterfilewriter.h

Go to the documentation of this file.

/***************************************************************************
    qgsrasterfilewriter.h
    ---------------------
    begin                : July 2012
    copyright            : (C) 2012 by Marco Hugentobler
    email                : marco dot hugentobler at sourcepole dot ch
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSRASTERFILEWRITER_H
#define QGSRASTERFILEWRITER_H
 
#include "qgis_core.h"
#include "qgscoordinatereferencesystem.h"
#include "qgscoordinatetransformcontext.h"
 
#include <QDomDocument>
#include <QDomElement>
#include <QString>
#include <QStringList>
 
using namespace Qt::StringLiterals;
 
class QgsRasterBlockFeedback;
class QgsRasterIterator;
class QgsRasterPipe;
class QgsRectangle;
class QgsRasterDataProvider;
class QgsRasterInterface;

class CORE_EXPORT QgsRasterFileWriter
{
  public:

    enum RasterFormatOption SIP_ENUM_BASETYPE( IntFlag )
    {
      SortRecommended = 1 << 1, 
    };
    Q_DECLARE_FLAGS( RasterFormatOptions, RasterFormatOption )
 
    
    QgsRasterFileWriter( const QString &outputUrl );

    QgsRasterDataProvider *createOneBandRaster( Qgis::DataType dataType,
        int width, int height,
        const QgsRectangle &extent,
        const QgsCoordinateReferenceSystem &crs ) SIP_FACTORY;

    QgsRasterDataProvider *createMultiBandRaster( Qgis::DataType dataType,
        int width, int height,
        const QgsRectangle &extent,
        const QgsCoordinateReferenceSystem &crs,
        int nBands ) SIP_FACTORY;
 

    Q_DECL_DEPRECATED Qgis::RasterFileWriterResult writeRaster( const QgsRasterPipe *pipe, int nCols, int nRows, const QgsRectangle &outputExtent,
        const QgsCoordinateReferenceSystem &crs, QgsRasterBlockFeedback *feedback = nullptr ) SIP_DEPRECATED;

    Qgis::RasterFileWriterResult writeRaster( const QgsRasterPipe *pipe, int nCols, int nRows, const QgsRectangle &outputExtent,
        const QgsCoordinateReferenceSystem &crs,
        const QgsCoordinateTransformContext &transformContext,
        QgsRasterBlockFeedback *feedback = nullptr );

    QString outputUrl() const { return mOutputUrl; }

    void setOutputFormat( const QString &format );

    QString outputFormat() const { return mOutputFormat; }

    void setOutputProviderKey( const QString &key ) { mOutputProviderKey = key; }

    QString outputProviderKey() const { return mOutputProviderKey; }

    void setTiledMode( bool t ) { mTiledMode = t; }

    bool tiledMode() const { return mTiledMode; }

    void setMaxTileWidth( int w ) { mMaxTileWidth = w; }

    int maxTileWidth() const { return mMaxTileWidth; }

    Qgis::RasterBuildPyramidOption buildPyramidsFlag() const { return mBuildPyramidsFlag; }

    void setBuildPyramidsFlag( Qgis::RasterBuildPyramidOption flag );

    QList< int > pyramidsList() const { return mPyramidsList; }

    void setPyramidsList( const QList< int > &list ) { mPyramidsList = list; }
 
    QString pyramidsResampling() const { return mPyramidsResampling; }
    void setPyramidsResampling( const QString &str ) { mPyramidsResampling = str; }

    Qgis::RasterPyramidFormat pyramidsFormat() const { return mPyramidsFormat; }

    void setPyramidsFormat( Qgis::RasterPyramidFormat f ) { mPyramidsFormat = f; }

    void setMaxTileHeight( int h ) { mMaxTileHeight = h; }

    int maxTileHeight() const { return mMaxTileHeight; }
 
    // TODO QGIS 5.0: rename list to options to have more semantic argument name

    Q_DECL_DEPRECATED void setCreateOptions( const QStringList &list ) SIP_DEPRECATED { setCreationOptions( list ); }

    Q_DECL_DEPRECATED QStringList createOptions() const SIP_DEPRECATED { return creationOptions(); }

    QStringList creationOptions() const { return mCreationOptions; }

    void setCreationOptions( const QStringList &options ) { mCreationOptions = options; }
 
    // TODO QGIS 5.0: rename list to options to have more semantic argument name

    void setPyramidsConfigOptions( const QStringList &list ) { mPyramidsConfigOptions = list; }

    QStringList pyramidsConfigOptions() const { return mPyramidsConfigOptions; }

    static QString filterForDriver( const QString &driverName );

    struct FilterFormatDetails
    {
      QString driverName;

      QString filterString;
    };

    static QList< QgsRasterFileWriter::FilterFormatDetails > supportedFiltersAndFormats( RasterFormatOptions options = SortRecommended );

    static QStringList supportedFormatExtensions( RasterFormatOptions options = SortRecommended );

    static QString driverForExtension( const QString &extension );

    static QStringList extensionsForFormat( const QString &format );
 
  private:
    QgsRasterFileWriter(); //forbidden
    Qgis::RasterFileWriterResult writeDataRaster( const QgsRasterPipe *pipe, QgsRasterIterator *iter, int nCols, int nRows, const QgsRectangle &outputExtent,
        const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &transformContext,
        QgsRasterBlockFeedback *feedback = nullptr );
 
    // Helper method used by previous one
    Qgis::RasterFileWriterResult writeDataRaster( const QgsRasterPipe *pipe,
        QgsRasterIterator *iter,
        int nCols, int nRows,
        const QgsRectangle &outputExtent,
        const QgsCoordinateReferenceSystem &crs,
        Qgis::DataType destDataType,
        const QList<bool> &destHasNoDataValueList,
        const QList<double> &destNoDataValueList,
        // This method can nullify the passed destProvider
        std::unique_ptr<QgsRasterDataProvider> &destProvider,
        QgsRasterBlockFeedback *feedback = nullptr );
 
    Qgis::RasterFileWriterResult writeImageRaster( QgsRasterIterator *iter, int nCols, int nRows, const QgsRectangle &outputExtent,
        const QgsCoordinateReferenceSystem &crs,
        QgsRasterBlockFeedback *feedback = nullptr );

    void createVRT( int xSize, int ySize, const QgsCoordinateReferenceSystem &crs, double *geoTransform, Qgis::DataType type, const QList<bool> &destHasNoDataValueList, const QList<double> &destNoDataValueList );
    //write vrt document to disk
    bool writeVRT( const QString &file );
    //add file entry to vrt
    void addToVRT( const QString &filename, int band, int xSize, int ySize, int xOffset, int yOffset );
    bool buildPyramids( const QString &filename, QgsRasterDataProvider *destProviderIn = nullptr );

    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 );

    QgsRasterDataProvider *initOutput( int nCols, int nRows,
                                       const QgsCoordinateReferenceSystem &crs, double *geoTransform, int nBands,
                                       Qgis::DataType type,
                                       const QList<bool> &destHasNoDataValueList = QList<bool>(), const QList<double> &destNoDataValueList = QList<double>() );

    void globalOutputParameters( const QgsRectangle &extent, int nCols, int &nRows, double *geoTransform, double &pixelSize );
 
    QString partFileName( int fileIndex );
    QString vrtFileName();
 
    Qgis::RasterExportType mMode = Qgis::RasterExportType::Raw;
    QString mOutputUrl;
    QString mOutputProviderKey = u"gdal"_s;
    QString mOutputFormat = u"GTiff"_s;
    QStringList mCreationOptions;
    QgsCoordinateReferenceSystem mOutputCRS;

    bool mTiledMode = false;
    int mMaxTileWidth = 500;
    int mMaxTileHeight = 500;
 
    QList< int > mPyramidsList;
    QString mPyramidsResampling = u"AVERAGE"_s;
    bool mBuildPyramidsFlagSet = false;
    Qgis::RasterBuildPyramidOption mBuildPyramidsFlag = Qgis::RasterBuildPyramidOption::No;
    Qgis::RasterPyramidFormat mPyramidsFormat = Qgis::RasterPyramidFormat::GeoTiff;
    QStringList mPyramidsConfigOptions;
 
    QDomDocument mVRTDocument;
    QList<QDomElement> mVRTBands;
 
    QgsRasterBlockFeedback *mFeedback = nullptr;
 
    const QgsRasterPipe *mPipe = nullptr;
    const QgsRasterInterface *mInput = nullptr;
};
 
#endif // QGSRASTERFILEWRITER_H