DEMObject.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later
/***********************************************************************************/
/*  Copyright 2009 WSL Institute for Snow and Avalanche Research    SLF-DAVOS      */
/***********************************************************************************/
/* This file is part of MeteoIO.
    MeteoIO is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    MeteoIO is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public License
    along with MeteoIO.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef DEMOBJECT_H
#define DEMOBJECT_H
 
#include <meteoio/dataClasses/Array2D.h>
#include <meteoio/dataClasses/Grid2DObject.h>
#include <meteoio/meteoLaws/Meteoconst.h> //for math constants
 
namespace mio {
 
class DEMObject : public Grid2DObject {
        public:
                Array2D<double> slope;
                Array2D<double> azi;
                Array2D<double> curvature;
                Array2D<double> Nx, Ny, Nz;
                double min_altitude, min_slope, min_curvature;
                double max_altitude, max_slope, max_curvature;
 
                typedef enum SLOPE_TYPE {
                        DFLT, 
                        FLEM, 
                        HICK, 
                        HORN, 
                        CORR, 
                        D8 
                } slope_type;
 
                typedef enum UPDATE_TYPE {
                        NO_UPDATE=0, 
                        SLOPE=1, 
                        NORMAL=2, 
                        CURVATURE=4, 
                        UPDATE_UNSET 
                } update_type;
 
                typedef enum {
                        FULL, 
                        SHORT 
                } FORMATS;
 
                DEMObject(const slope_type& i_algorithm=DFLT);
                
                DEMObject(const size_t& ncols_in, const size_t& nrows_in, const Coords& llcorner_in, const double& init);
 
                DEMObject(const size_t& ncols_in, const size_t& nrows_in,
                          const double& cellsize_in, const Coords& llcorner_in, const slope_type& i_algorithm=DFLT);
 
                DEMObject(const double& cellsize_in, const Coords& llcorner_in, const Array2D<double>& altitude_in,
                          const bool& i_update=true, const slope_type& i_algorithm=DFLT);
 
                DEMObject(const Grid2DObject& dem_in, const bool& i_update=true, const slope_type& i_algorithm=DFLT);
 
                DEMObject (const DEMObject& i_dem,
                           const size_t& i_nx, const size_t& i_ny, //Point in the plane
                           const size_t& i_ncols, const size_t& i_nrows, //dimensions of the sub-plane
                           const bool& i_update=true, const slope_type& i_algorithm=DFLT);
 
                void setDefaultAlgorithm(const std::string& i_algorithm);
                void setDefaultAlgorithm(const slope_type& i_algorithm);
                int getDefaultAlgorithm() const;
                void setUpdatePpt(const update_type& in_update_flag);
                int getUpdatePpt() const;
                void setCurvatureScale(const double& in_curvature_scale);
 
                void update(const std::string& algorithm);
                void update(const slope_type& algorithm=DFLT);
                void updateAllMinMax();
                void printFailures();
                void sanitize();
 
                DEMObject& operator=(const Grid2DObject&); 
                DEMObject& operator=(const double& value); 
 
                DEMObject& operator+=(const double& rhs);
                const DEMObject operator+(const double& rhs) const;
                DEMObject& operator+=(const Grid2DObject& rhs);
                const DEMObject operator+(const Grid2DObject& rhs) const;
 
                DEMObject& operator-=(const double& rhs);
                const DEMObject operator-(const double& rhs) const;
                DEMObject& operator-=(const Grid2DObject& rhs);
                const DEMObject operator-(const Grid2DObject& rhs) const;
 
                DEMObject& operator*=(const double& rhs);
                const DEMObject operator*(const double& rhs) const;
                DEMObject& operator*=(const Grid2DObject& rhs);
                const DEMObject operator*(const Grid2DObject& rhs) const;
 
                DEMObject& operator/=(const double& rhs);
                const DEMObject operator/(const double& rhs) const;
                DEMObject& operator/=(const Grid2DObject& rhs);
                const DEMObject operator/(const Grid2DObject& rhs) const;
 
                bool operator==(const DEMObject& in) const; 
                bool operator!=(const DEMObject& in) const; 
 
                const std::string toString(const FORMATS& type = FULL) const;
                friend std::ostream& operator<<(std::ostream& os, const DEMObject& dem);
                friend std::istream& operator>>(std::istream& is, DEMObject& dem);
 
        private:
                void CalculateAziSlopeCurve(slope_type algorithm);
                static double CalculateAzimuth(const double& o_Nx, const double& o_Ny, const double& o_Nz, const double& o_slope, const double& no_slope=0.);
                double getCurvature(double A[4][4], const double& scale=IOUtils::nodata);
                void CalculateHick(double A[4][4], double& o_slope, double& o_Nx, double& o_Ny, double& o_Nz);
                void CalculateFleming(double A[4][4], double& o_slope, double& o_Nx, double& o_Ny, double& o_Nz);
                void CalculateHorn(double A[4][4], double& o_slope, double& o_Nx, double& o_Ny, double& o_Nz);
                void CalculateCorripio(double A[4][4], double& o_slope, double& o_Nx, double& o_Ny, double& o_Nz);
                void (DEMObject::*CalculateSlope)(double A[4][4], double& o_slope, double& o_Nx, double& o_Ny, double& o_Nz);
                
                static double steepestGradient(const double& i_cellsize, double A[4][4]);
                static double lineGradient(const double& A1, const double& A2, const double& A3);
                static double fillMissingGradient(const double& delta1, const double& delta2);
                static void surfaceGradient(double& dx_sum, double& dy_sum, double A[4][4]);
                static double avgHeight(const double& z1, const double &z2, const double& z3);
                void getNeighbours(const size_t& i, const size_t& j, double A[4][4], const double& scale=IOUtils::nodata) const;
                double safeGet(const int& i, const int& j) const;
 
                double max_shade_distance; 
                double curvature_scale; 
                int update_flag;
                slope_type dflt_algorithm;
                size_t slope_failures; 
                size_t curvature_failures; 
};
} //end namespace
 
#endif