Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmhillshade.cpp
       3                 :            :                          ---------------------
       4                 :            :     begin                : November 2019
       5                 :            :     copyright            : (C) 2019 by Alexander Bruy
       6                 :            :     email                : alexander dot bruy at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #include "qgsalgorithmhillshade.h"
      19                 :            : #include "qgsrasterfilewriter.h"
      20                 :            : #include "qgshillshadefilter.h"
      21                 :            : 
      22                 :            : ///@cond PRIVATE
      23                 :            : 
      24                 :          0 : QString QgsHillshadeAlgorithm::name() const
      25                 :            : {
      26                 :          0 :   return QStringLiteral( "hillshade" );
      27                 :            : }
      28                 :            : 
      29                 :          0 : QString QgsHillshadeAlgorithm::displayName() const
      30                 :            : {
      31                 :          0 :   return QObject::tr( "Hillshade" );
      32                 :            : }
      33                 :            : 
      34                 :          0 : QStringList QgsHillshadeAlgorithm::tags() const
      35                 :            : {
      36                 :          0 :   return QObject::tr( "dem,hillshade,terrain" ).split( ',' );
      37                 :          0 : }
      38                 :            : 
      39                 :          0 : QString QgsHillshadeAlgorithm::group() const
      40                 :            : {
      41                 :          0 :   return QObject::tr( "Raster terrain analysis" );
      42                 :            : }
      43                 :            : 
      44                 :          0 : QString QgsHillshadeAlgorithm::groupId() const
      45                 :            : {
      46                 :          0 :   return QStringLiteral( "rasterterrainanalysis" );
      47                 :            : }
      48                 :            : 
      49                 :          0 : QString QgsHillshadeAlgorithm::shortHelpString() const
      50                 :            : {
      51                 :          0 :   return QObject::tr( "This algorithm calculates the hillshade of the Digital Terrain Model in input." )
      52                 :          0 :          + QStringLiteral( "\n\n" )
      53                 :          0 :          + QObject::tr( "The shading of the layer is calculated according to the sun position (azimuth and elevation)." );
      54                 :          0 : }
      55                 :            : 
      56                 :          0 : QgsHillshadeAlgorithm *QgsHillshadeAlgorithm::createInstance() const
      57                 :            : {
      58                 :          0 :   return new QgsHillshadeAlgorithm();
      59                 :            : }
      60                 :            : 
      61                 :          0 : void QgsHillshadeAlgorithm::initAlgorithm( const QVariantMap & )
      62                 :            : {
      63                 :          0 :   addParameter( new QgsProcessingParameterRasterLayer( QStringLiteral( "INPUT" ), QObject::tr( "Elevation layer" ) ) );
      64                 :          0 :   addParameter( new QgsProcessingParameterNumber( QStringLiteral( "Z_FACTOR" ), QObject::tr( "Z factor" ),
      65                 :          0 :                 QgsProcessingParameterNumber::Double, 1, false, 0 ) );
      66                 :          0 :   addParameter( new QgsProcessingParameterNumber( QStringLiteral( "AZIMUTH" ), QObject::tr( "Azimuth (horizontal angle)" ),
      67                 :          0 :                 QgsProcessingParameterNumber::Double, 300, false, 0, 360 ) );
      68                 :          0 :   addParameter( new QgsProcessingParameterNumber( QStringLiteral( "V_ANGLE" ), QObject::tr( "Vertical angle" ),
      69                 :          0 :                 QgsProcessingParameterNumber::Double, 40, false, 0, 90 ) );
      70                 :            : 
      71                 :          0 :   addParameter( new QgsProcessingParameterRasterDestination( QStringLiteral( "OUTPUT" ), QObject::tr( "Hillshade" ) ) );
      72                 :          0 : }
      73                 :            : 
      74                 :          0 : QVariantMap QgsHillshadeAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
      75                 :            : {
      76                 :          0 :   QgsRasterLayer *inputLayer = parameterAsRasterLayer( parameters, QStringLiteral( "INPUT" ), context );
      77                 :            : 
      78                 :          0 :   if ( !inputLayer )
      79                 :          0 :     throw QgsProcessingException( invalidRasterError( parameters, QStringLiteral( "INPUT" ) ) );
      80                 :            : 
      81                 :          0 :   double zFactor = parameterAsDouble( parameters, QStringLiteral( "Z_FACTOR" ), context );
      82                 :          0 :   double azimuth = parameterAsDouble( parameters, QStringLiteral( "AZIMUTH" ), context );
      83                 :          0 :   double vAngle = parameterAsDouble( parameters, QStringLiteral( "V_ANGLE" ), context );
      84                 :            : 
      85                 :          0 :   const QString outputFile = parameterAsOutputLayer( parameters, QStringLiteral( "OUTPUT" ), context );
      86                 :          0 :   QFileInfo fi( outputFile );
      87                 :          0 :   const QString outputFormat = QgsRasterFileWriter::driverForExtension( fi.suffix() );
      88                 :            : 
      89                 :          0 :   QgsHillshadeFilter hillshade( inputLayer->source(), outputFile, outputFormat, azimuth, vAngle );
      90                 :          0 :   hillshade.setZFactor( zFactor );
      91                 :          0 :   hillshade.processRaster( feedback );
      92                 :            : 
      93                 :          0 :   QVariantMap outputs;
      94                 :          0 :   outputs.insert( QStringLiteral( "OUTPUT" ), outputFile );
      95                 :          0 :   return outputs;
      96                 :          0 : }
      97                 :            : 
      98                 :            : ///@endcond