NBHeightMapper.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2011-2026 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// Set z-values for all network positions based on data from a height map
/****************************************************************************/
#pragma once
#include <config.h>
 
#ifdef WIN32
typedef __int16 int16_t;
#else
#include <stdint.h>
#endif
 
#include <string>
#include <foreign/rtree/RTree.h>
#include <utils/geom/PositionVector.h>
#include <utils/geom/Boundary.h>
#include <utils/common/UtilExceptions.h>
 
#ifdef HAVE_GDAL
#include <ogr_spatialref.h>
#endif
 
#define TRIANGLE_RTREE_QUAL RTree<NBHeightMapper::Triangle*, NBHeightMapper::Triangle, float, 2, NBHeightMapper::QueryResult>
 
// ===========================================================================
// class declarations
// ===========================================================================
class OptionsCont;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class NBHeightMapper {
 
    friend class NBHeightMapperTest;
 
public:
    static void loadIfSet(OptionsCont& oc);
 
    static const NBHeightMapper& get();
 
    bool ready() const;
 
    const Boundary& getBoundary() {
        return myInstance.myBoundary;
    }
 
    double getZ(const Position& geo) const;
 
    class QueryResult;
    /* @brief content class for the rtree. Since we wish to be able to use the
     * rtree for spatial querying we have to jump through some minor hoops:
     * We let each found triangle callback the NBHeightMapper and add itself the
     * the query result
     * */
    class Triangle {
 
    public:
        Triangle(const PositionVector& corners);
        ~Triangle() {};
 
        void addSelf(const QueryResult& queryResult) const;
 
        bool contains(const Position& pos) const;
 
        double getZ(const Position& geo) const;
 
        Position normalVector() const;
 
        PositionVector myCorners;
 
    };
 
    typedef std::vector<const Triangle*> Triangles;
 
    class QueryResult {
    public:
        QueryResult() {};
        ~QueryResult() {};
        // @brief method not realy const
        void add(Triangle* triangle) const {
            triangles.push_back(triangle);
        };
        mutable Triangles triangles;
    };
 
private:
 
    struct RasterData {
        float* raster;
        Boundary boundary;
        int xSize;
        int ySize;
#ifdef HAVE_GDAL
        OGRCoordinateTransformation* transform;
#endif
    };
 
    static NBHeightMapper myInstance;
 
    Triangles myTriangles;
 
    TRIANGLE_RTREE_QUAL myRTree;
 
    std::vector<RasterData> myRasters;
 
    Position mySizeOfPixel;
 
    Boundary myBoundary;
 
private:
    NBHeightMapper();
    ~NBHeightMapper();
 
    void addTriangle(PositionVector corners);
 
    int loadShapeFile(const std::string& file);
 
    int loadTiff(const std::string& file);
 
    void clearData();
 
    NBHeightMapper(const NBHeightMapper&);
 
    NBHeightMapper& operator=(const NBHeightMapper&);
 
};
 
 
// ===========================================================================
// RTree specialization for speedup and avoiding warnings (ripped from SUMORTree.h)
// ===========================================================================
template<>
inline float TRIANGLE_RTREE_QUAL::RectSphericalVolume(Rect* a_rect) {
    ASSERT(a_rect);
    const float extent0 = a_rect->m_max[0] - a_rect->m_min[0];
    const float extent1 = a_rect->m_max[1] - a_rect->m_min[1];
    return .78539816f * (extent0 * extent0 + extent1 * extent1);
}
 
template<>
inline TRIANGLE_RTREE_QUAL::Rect TRIANGLE_RTREE_QUAL::CombineRect(Rect* a_rectA, Rect* a_rectB) {
    ASSERT(a_rectA && a_rectB);
    Rect newRect;
    newRect.m_min[0] = rtree_min(a_rectA->m_min[0], a_rectB->m_min[0]);
    newRect.m_max[0] = rtree_max(a_rectA->m_max[0], a_rectB->m_max[0]);
    newRect.m_min[1] = rtree_min(a_rectA->m_min[1], a_rectB->m_min[1]);
    newRect.m_max[1] = rtree_max(a_rectA->m_max[1], a_rectB->m_max[1]);
    return newRect;
}