qgsninecellfilter.h

Go to the documentation of this file.

/***************************************************************************
                          qgsninecellfilter.h  -  description
                             -------------------
    begin                : August 6th, 2009
    copyright            : (C) 2009 by Marco Hugentobler
    email                : marco dot hugentobler at karto dot baug dot ethz 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 QGSNINECELLFILTER_H
#define QGSNINECELLFILTER_H
 
#include "qgsconfig.h"
 
#include <gdal.h>
 
#include "qgis_analysis.h"
#include "qgsogrutils.h"
 
#include <QString>
 
class QgsFeedback;

class ANALYSIS_EXPORT QgsNineCellFilter
{
  public:
    enum class Result : int
    {
      Success = 0,           
      InputLayerError = 1,   
      DriverError = 2,       
      CreateOutputError = 3, 
      InputBandError = 4,    
      OutputBandError = 5,   
      RasterSizeError = 6,   
      Canceled = 7,          
    };

    QgsNineCellFilter( const QString &inputFile, const QString &outputFile, const QString &outputFormat );
    virtual ~QgsNineCellFilter() = default;

    Result processRaster( QgsFeedback *feedback = nullptr );
 
    double cellSizeX() const { return mCellSizeX; }
    void setCellSizeX( double size ) { mCellSizeX = size; }
    double cellSizeY() const { return mCellSizeY; }
    void setCellSizeY( double size ) { mCellSizeY = size; }
 
    double zFactor() const { return mZFactor; }
    void setZFactor( double factor ) { mZFactor = factor; }
 
    double inputNodataValue() const { return mInputNodataValue; }
    void setInputNodataValue( double value ) { mInputNodataValue = value; }
    double outputNodataValue() const { return mOutputNodataValue; }
    void setOutputNodataValue( double value ) { mOutputNodataValue = value; }

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

    QStringList creationOptions() const { return mCreationOptions; }

    virtual float processNineCellWindow( float *x11, float *x21, float *x31, float *x12, float *x22, float *x32, float *x13, float *x23, float *x33 ) = 0;
 
  private:
    //default constructor forbidden. We need input file, output file and format obligatory
    QgsNineCellFilter() = delete;

    gdal::dataset_unique_ptr openInputFile( int &nCellsX, int &nCellsY );

    GDALDriverH openOutputDriver();

    gdal::dataset_unique_ptr openOutputFile( GDALDatasetH inputDataset, GDALDriverH outputDriver );

    Result processRasterCPU( QgsFeedback *feedback = nullptr );
 
#ifdef HAVE_OPENCL

    Result processRasterGPU( const QString &source, QgsFeedback *feedback = nullptr );

    virtual void addExtraRasterParams( std::vector<float> &params ) { Q_UNUSED( params ) }
 
    virtual const QString openClProgramBaseName() const { return QString(); }
 
#endif
 
  protected:
    QString mInputFile;
    QString mOutputFile;
    QString mOutputFormat;
    QStringList mCreationOptions;
 
    double mCellSizeX = -1.0;
    double mCellSizeY = -1.0;
    double mInputNodataValue = -1.0;
    double mOutputNodataValue = -9999.0;
    double mZFactor = 1.0;
};
 
#endif // QGSNINECELLFILTER_H