otbSpatialReference.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 otbSpatialReference_h
#define otbSpatialReference_h
 
#include "OTBGdalAdaptersExport.h"
 
#include <cassert>
#include <memory>
#include <string>
 
#if defined(_MSC_VER)
#pragma warning(disable : 4251)
// Disable following warning :
// warning C4251: 'otb::SpatialReference::m_SR':
// class 'std::unique_ptr<OGRSpatialReference,OGRSpatialReferenceDeleter>' needs
// to have dll-interface to be used by clients of class 'otb::SpatialReference'
// As long as otb::SpatialReference::m_SR is private no need to export this type.
#endif
 
// causes warning C4251 on Windows
#include "ogr_spatialref.h"
 
class OGRSpatialReference;
 
namespace otb
{
// Destructor of OGRSpatialReference
namespace internal
{
struct OTBGdalAdapters_EXPORT OGRSpatialReferenceDeleter
{
public:
  void operator()(OGRSpatialReference* del) const;
};
}
 
// Forward declaration needed for the operators declared bellow.
class SpatialReference;
 
OTBGdalAdapters_EXPORT bool operator==(const SpatialReference& sr1, const SpatialReference& sr2) noexcept;
 
OTBGdalAdapters_EXPORT bool operator!=(const SpatialReference& sr1, const SpatialReference& sr2) noexcept;
 
class OTBGdalAdapters_EXPORT SpatialReference
{
  friend class CoordinateTransformation;
  OTBGdalAdapters_EXPORT friend bool operator==(const SpatialReference& sr1, const SpatialReference& sr2) noexcept;
  OTBGdalAdapters_EXPORT friend bool operator!=(const SpatialReference& sr1, const SpatialReference& sr2) noexcept;
 
public:
  typedef std::unique_ptr<OGRSpatialReference, internal::OGRSpatialReferenceDeleter> OGRSpatialReferencePtr;
  static SpatialReference FromDescription(const std::string& sr_description);
 
  static SpatialReference FromWGS84();
 
  static SpatialReference FromEPSG(unsigned int epsg);
 
  enum class hemisphere
  {
    north,
    south
  };
 
  static SpatialReference FromUTM(unsigned int zone, hemisphere hem);
 
  static SpatialReference FromGeogCS(const std::string& GeogName, const std::string& DatumName,
                                     const std::string& SpheroidName, const double SemiMajor,
                                     const double InvFlattening);
 
  SpatialReference(const SpatialReference& other) noexcept;
 
  SpatialReference& operator=(const SpatialReference& other) noexcept;
 
  std::string ToWkt() const;
 
  bool NormalizeESRI();
 
  unsigned int ToEPSG() const;
 
#if GDAL_VERSION_NUM >= 3000000
  void SetAxisMappingStrategy(OSRAxisMappingStrategy strategy);
#endif
 
  static void UTMFromGeoPoint(double lon, double lat, unsigned int& zone, hemisphere& hem);
 
private:
  SpatialReference(const OGRSpatialReference* ref);
 
  SpatialReference(OGRSpatialReferencePtr ref);
 
  // unique ptr to the internal OGRSpatialReference
  OGRSpatialReferencePtr m_SR;
};
 
OTBGdalAdapters_EXPORT std::ostream& operator<<(std::ostream& o, const SpatialReference::hemisphere& hem);
 
OTBGdalAdapters_EXPORT std::ostream& operator<<(std::ostream& o, const SpatialReference& i);
}
#endif