qgsrastercalculator.h

Go to the documentation of this file.

/***************************************************************************
                          qgsrastercalculator.h  -  description
                          ---------------------
    begin                : September 28th, 2010
    copyright            : (C) 2010 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 QGSRASTERCALCULATOR_H
#define QGSRASTERCALCULATOR_H
 
#include <gdal.h>
 
#include "qgis_analysis.h"
#include "qgscoordinatereferencesystem.h"
#include "qgscoordinatetransformcontext.h"
#include "qgsogrutils.h"
#include "qgsrastercalcnode.h"
#include "qgsrectangle.h"
 
#include <QString>
#include <QVector>
 
class QgsRasterLayer;
class QgsFeedback;

class ANALYSIS_EXPORT QgsRasterCalculatorEntry
{
  public:
    static QVector<QgsRasterCalculatorEntry> rasterEntries();

    QString ref;

    QgsRasterLayer *raster = nullptr;

    int bandNumber = 1;
};

class ANALYSIS_EXPORT QgsRasterCalculator
{
  public:
    enum class Result SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsRasterCalculator, Result ) : int
    {
      Success = 0,               
      CreateOutputError = 1,     
      InputLayerError = 2,       
      Canceled = 3,              
      ParserError = 4,           
      MemoryError = 5,           
      BandError = 6,             
      CalculationError = 7,      
      OpenCLKernelBuildError = 8 
    };
 

    QgsRasterCalculator(
      const QString &formulaString,
      const QString &outputFile,
      const QString &outputFormat,
      const QgsRectangle &outputExtent,
      const QgsCoordinateReferenceSystem &outputCrs,
      int nOutputColumns,
      int nOutputRows,
      const QVector<QgsRasterCalculatorEntry> &rasterEntries,
      const QgsCoordinateTransformContext &transformContext
    );

    QgsRasterCalculator(
      const QString &formulaString,
      const QString &outputFile,
      const QString &outputFormat,
      const QgsRectangle &outputExtent,
      int nOutputColumns,
      int nOutputRows,
      const QVector<QgsRasterCalculatorEntry> &rasterEntries,
      const QgsCoordinateTransformContext &transformContext
    );

    Q_DECL_DEPRECATED QgsRasterCalculator(
      const QString &formulaString,
      const QString &outputFile,
      const QString &outputFormat,
      const QgsRectangle &outputExtent,
      const QgsCoordinateReferenceSystem &outputCrs,
      int nOutputColumns,
      int nOutputRows,
      const QVector<QgsRasterCalculatorEntry> &rasterEntries
    ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED QgsRasterCalculator(
      const QString &formulaString, const QString &outputFile, const QString &outputFormat, const QgsRectangle &outputExtent, int nOutputColumns, int nOutputRows, const QVector<QgsRasterCalculatorEntry> &rasterEntries
    ) SIP_DEPRECATED;

    Result processCalculation( QgsFeedback *feedback = nullptr );

    QString lastError() const;

    void setCreationOptions( const QStringList &options ) { mCreationOptions = options; }

    QStringList creationOptions() const { return mCreationOptions; }

    void setNoDataValue( double noDataValue ) { mNoDataValue = noDataValue; }

    double noDataValue() const { return mNoDataValue; }
 
  private:
    //default constructor forbidden. We need formula, output file, output format and output raster resolution obligatory
    QgsRasterCalculator() = delete;

    GDALDriverH openOutputDriver();

    gdal::dataset_unique_ptr openOutputFile( GDALDriverH outputDriver );

    void outputGeoTransform( double *transform ) const;

    Result processCalculationGPU( std::unique_ptr<QgsRasterCalcNode> calcNode, QgsFeedback *feedback = nullptr );
 
    QString mFormulaString;
    QString mOutputFile;
    QString mOutputFormat;

    QgsRectangle mOutputRectangle;
    QgsCoordinateReferenceSystem mOutputCrs;

    int mNumOutputColumns = 0;
    int mNumOutputRows = 0;
 
    QString mLastError;
    QStringList mCreationOptions;
    double mNoDataValue = -FLT_MAX;
 
    /***/
    QVector<QgsRasterCalculatorEntry> mRasterEntries;
 
    QgsCoordinateTransformContext mTransformContext;
};
 
#endif // QGSRASTERCALCULATOR_H