otbDEMHandler.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef otbDEMHandler_h
#define otbDEMHandler_h
 
#include "otbImage.h"
#include "otbGDALDatasetWrapper.h"
#include <string>
#include <list>
#include <vector>
#include <memory>
 
namespace otb
{
 
class DEMObserverInterface
{
public:
  virtual void Update() = 0;
protected:
  DEMObserverInterface() = default;
  ~DEMObserverInterface() = default;
  DEMObserverInterface(DEMObserverInterface const&) = delete;
  DEMObserverInterface& operator=(DEMObserverInterface const&) = delete;
};
 
class DEMSubjectInterface
{
public:
  virtual void AttachObserver(DEMObserverInterface *observer) = 0;
  virtual void DetachObserver(DEMObserverInterface *observer) = 0;
  virtual void Notify() const = 0;
protected:
  DEMSubjectInterface() = default;
  ~DEMSubjectInterface() = default;
  DEMSubjectInterface(DEMSubjectInterface const&) = delete;
  DEMSubjectInterface& operator=(DEMSubjectInterface const&) = delete;
};
 
// Forward declaration of the class at this point. No need to expose the
// full class definition.
class DEMHandlerTLS;
 
class DEMHandler : public DEMSubjectInterface
{
public:
  using Self      = DEMHandler;
  using PointType = itk::Point<double, 2>;
 
  static DEMHandler & GetInstance();
 
  void OpenDEMDirectory(std::string DEMDirectory);
 
  void OpenDEMFile(std::string path);
 
  bool IsValidDEMDirectory(const std::string& DEMDirectory) const;
 
  bool OpenGeoidFile(std::string geoidFile);
 
  double GetHeightAboveEllipsoid(double lon, double lat) const;
 
  double GetHeightAboveEllipsoid(const PointType& geoPoint) const;
 
  double GetHeightAboveMSL(double lon, double lat) const;
  double GetHeightAboveMSL(const PointType& geoPoint) const;
 
  double GetGeoidHeight(double lon, double lat) const;
  double GetGeoidHeight(const PointType& geoPoint) const;
 
  std::size_t GetDEMCount() const noexcept;
 
  double GetDefaultHeightAboveEllipsoid() const noexcept;
 
  void SetDefaultHeightAboveEllipsoid(double height);
 
  std::string const& GetDEMDirectory(std::size_t idx = 0) const;
 
  std::size_t GetNumberOfDEMDirectories() const noexcept
  { return m_DEMDirectories.size(); }
 
  std::string const& GetGeoidFile() const noexcept;
 
  void ClearElevationParameters();
 
  void AttachObserver(DEMObserverInterface *observer) override {m_ObserverList.push_back(observer);};
 
  void DetachObserver(DEMObserverInterface *observer) override {m_ObserverList.remove(observer);};
 
  void Notify() const override;
 
  static constexpr char const* DEM_DATASET_PATH         = "/vsimem/otb_dem_dataset.vrt";
  static constexpr char const* DEM_WARPED_DATASET_PATH  = "/vsimem/otb_dem_warped_dataset.vrt";
  static constexpr char const* DEM_SHIFTED_DATASET_PATH = "/vsimem/otb_dem_shifted_dataset.vrt";
 
  DEMHandlerTLS const& GetHandlerForCurrentThread() const;
 
protected:
  DEMHandler();
 
  ~DEMHandler();
 
private:
 
  std::shared_ptr<DEMHandlerTLS> DoFetchOrCreateHandler() const;
 
  void RegisterConfigurationInHandler(DEMHandlerTLS & handler) const;
 
  DEMHandler(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  double m_DefaultHeightAboveEllipsoid;
 
  std::vector<std::string> m_DEMDirectories;
 
  std::vector<otb::GDALDatasetWrapper::Pointer> m_DatasetList;
 
  std::string m_GeoidFilename;
 
  std::list<DEMObserverInterface *> m_ObserverList;
 
  mutable std::vector<std::shared_ptr<DEMHandlerTLS>> m_tlses;
};
 
 
double GetHeightAboveEllipsoid(DEMHandlerTLS const&, double lon, double lat);
double GetHeightAboveMSL      (DEMHandlerTLS const&, double lon, double lat);
double GetGeoidHeight         (DEMHandlerTLS const&, double lon, double lat);
double GetHeightAboveEllipsoid(DEMHandlerTLS const&, itk::Point<double, 2> geoPoint);
double GetHeightAboveMSL      (DEMHandlerTLS const&, itk::Point<double, 2> geoPoint);
double GetGeoidHeight         (DEMHandlerTLS const&, itk::Point<double, 2> geoPoint);
 
 
}
#endif