qgsrelief.h

Go to the documentation of this file.

/***************************************************************************
                          qgsrelief.h  -  description
                          ---------------------------
    begin                : November 2011
    copyright            : (C) 2011 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 QGSRELIEF_H
#define QGSRELIEF_H
 
#include <gdal.h>
 
#include "qgis_analysis.h"
#include "qgsogrutils.h"
#include "qgsrasterlayerutils.h"
 
#include <QColor>
#include <QMap>
#include <QPair>
#include <QString>
 
class QgsAspectFilter;
class QgsSlopeFilter;
class QgsHillshadeFilter;
class QgsFeedback;

class ANALYSIS_EXPORT QgsRelief
{
  public:
    QgsRelief( const QString &inputFile, const QString &outputFile, const QString &outputFormat );
    ~QgsRelief();
 
    QgsRelief( const QgsRelief &rh ) = delete;
    QgsRelief &operator=( const QgsRelief &rh ) = delete;

    enum class Result : int
    {
      Success = 0,              
      InvalidInput = 1,         
      OutputCreationFailed = 3, 
      InvalidInputSize = 6,     
      Canceled = 7,             
    };

    QgsRelief::Result processRaster( QgsFeedback *feedback = nullptr );

    double zFactor() const { return mZFactor; }

    void setZFactor( double factor ) { mZFactor = factor; }

    void clearReliefColors();

    void addReliefColorClass( const QgsRasterReliefColor &color );

    QList<QgsRasterReliefColor> reliefColors() const { return mReliefColors; }

    void setReliefColors( const QList<QgsRasterReliefColor> &c ) { mReliefColors = c; }

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

    QStringList creationOptions() const { return mCreationOptions; }

    void setOutputNodataValue( double value ) { mOutputNodataValue = value; }

    double outputNodataValue() const { return mOutputNodataValue; }

    QList<QgsRasterReliefColor> calculateOptimizedReliefClasses();

    bool exportFrequencyDistributionToCsv( const QString &file );
 
  private:
#ifdef SIP_RUN
    QgsRelief( const QgsRelief &rh );
#endif
 
    QString mInputFile;
    QString mOutputFile;
    QString mOutputFormat;
 
    double mCellSizeX = 0.0;
    double mCellSizeY = 0.0;
    float mInputNodataValue = -9999.0;
    float mOutputNodataValue = -9999.0;
 
    double mZFactor = 1;
 
    QStringList mCreationOptions;
 
    std::unique_ptr<QgsSlopeFilter> mSlopeFilter;
    std::unique_ptr<QgsAspectFilter> mAspectFilter;
    std::unique_ptr<QgsHillshadeFilter> mHillshadeFilter285;
    std::unique_ptr<QgsHillshadeFilter> mHillshadeFilter300;
    std::unique_ptr<QgsHillshadeFilter> mHillshadeFilter315;
 
    //relief colors and corresponding elevations
    QList<QgsRasterReliefColor> mReliefColors;
 
    bool processNineCellWindow( float *x1, float *x2, float *x3, float *x4, float *x5, float *x6, float *x7, float *x8, float *x9, unsigned char *red, unsigned char *green, unsigned char *blue );

    bool getElevationColor( double elevation, int *red, int *green, int *blue ) const;

    void setDefaultReliefColors();

    static int frequencyClassForElevation( double elevation, double minElevation, double elevationClassRange );
};
 
#endif // QGSRELIEF_H