otbRemoteSensingRegion.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 otbRemoteSensingRegion_h
#define otbRemoteSensingRegion_h
 
#include <algorithm>
#include <iomanip>
 
#include "OTBImageBaseExport.h"
#include "otbImageMetadata.h"
#include "itkImageRegion.h"
#include <string>
 
namespace otb
{
 
template <class TType>
class OTBImageBase_EXPORT_TEMPLATE RemoteSensingRegion : public itk::Region
{
public:
  typedef otb::RemoteSensingRegion<TType> Self;
  typedef itk::Region                     Superclass;
  typedef itk::SmartPointer<Self>         Pointer;
  typedef itk::SmartPointer<const Self>   ConstPointer;
 
  itkTypeMacro(RemoteSensingRegion, itk : Region);
 
  typedef TType Type;
 
  typedef itk::ContinuousIndex<Type> IndexType;
  typedef itk::Point<Type, 2>        PointType;
 
  typedef itk::ContinuousIndex<Type> SizeType;
  //   typedef itk::Size<2>                         StandardSizeType;
 
  typedef itk::ImageRegion<2> ImageRegionType;
 
  typename Superclass::RegionEnum GetRegionType() const override
  {
    return Superclass::RegionEnum::ITK_STRUCTURED_REGION;
  }
 
  RemoteSensingRegion()
  {
    m_Size.Fill(0.);
    m_Index.Fill(0.);
  }
 
  RemoteSensingRegion(const itk::ImageRegion<2>& region)
  {
    m_Size[0]  = region.GetSize()[0];
    m_Size[1]  = region.GetSize()[1];
    m_Index[0] = region.GetIndex()[0];
    m_Index[1] = region.GetIndex()[1];
  }
 
  const ImageRegionType GetImageRegion()
  {
    ImageRegionType                     imageRegion;
    typename ImageRegionType::IndexType irIndex;
    typename ImageRegionType::SizeType  irSize;
 
    irIndex[0] = static_cast<unsigned long>(std::floor(m_Index[0]));
    irIndex[1] = static_cast<unsigned long>(std::floor(m_Index[1]));
    irSize[0]  = static_cast<unsigned long>(std::ceil(m_Size[0]));
    irSize[1]  = static_cast<unsigned long>(std::ceil(m_Size[1]));
 
    imageRegion.SetIndex(irIndex);
    imageRegion.SetSize(irSize);
 
    return imageRegion;
  }
 
  void SetOrigin(const IndexType& index)
  {
    m_Index = index;
  }
 
  void SetOrigin(const PointType& index)
  {
    m_Index[0] = index[0];
    m_Index[1] = index[1];
  }
 
  const IndexType& GetOrigin() const
  {
    return m_Index;
  }
 
  void SetIndex(const IndexType& index)
  {
    m_Index = index;
  }
 
  const IndexType& GetIndex() const
  {
    return m_Index;
  }
 
  void SetSize(const SizeType& size)
  {
    m_Size = size;
  }
 
  //   void SetSize(const StandardSizeType &size)
  //     {
  //       m_Size[0] = size[0];
  //       m_Size[1] = size[1];
  //     }
 
  const SizeType& GetSize() const
  {
    return m_Size;
  }
 
  Type GetSize(unsigned int i) const
  {
    return m_Size[i];
  }
  Type GetOrigin(unsigned int i) const
  {
    return m_Index[i];
  }
  void SetSize(const unsigned int i, Type size)
  {
    m_Size[i] = size;
  }
  void SetOrigin(const unsigned int i, Type idx)
  {
    m_Index[i] = idx;
  }
 
  const ImageMetadata& GetImageMetadata() const
  {
    return m_ImageMetadata;
  }
 
  void SetImageMetadata(const ImageMetadata& imd)
  {
    m_ImageMetadata = imd;
  }
 
  bool operator==(const Self& region) const
  {
    bool same = 1;
    same      = (m_Index == region.m_Index);
    same      = same && (m_Size == region.m_Size);
    return same;
  }
 
  bool operator!=(const Self& region) const
  {
    bool same = 1;
    same      = (m_Index == region.m_Index);
    same      = same && (m_Size == region.m_Size);
    return !same;
  }
 
  bool IsInside(const IndexType& index) const
  {
    for (unsigned int i = 0; i < IndexType::IndexDimension; ++i)
    {
      if ((index[i] < m_Index[i]) && (index[i] < m_Index[i] + m_Size[i]))
      {
        return false;
      }
      if ((index[i] >= m_Index[i]) && (index[i] >= m_Index[i] + m_Size[i]))
      {
        return false;
      }
    }
    return true;
  }
 
  void SetRegionProjection(const std::string& projection)
  {
    m_InputProjectionRef = projection;
  }
 
  std::string GetRegionProjection()
  {
    return m_InputProjectionRef;
  }
 
  bool Crop(const Self& region)
  {
    Type crop;
    bool cropPossible = true;
 
    // Can we crop?
    for (unsigned int i = 0; i < IndexType::IndexDimension && cropPossible; ++i)
    {
 
      if (((region.GetOrigin()[i] <= m_Index[i]) && (region.GetOrigin()[i] <= m_Index[i] + static_cast<Type>(m_Size[i])) &&
           ((region.GetOrigin()[i] + static_cast<Type>(region.GetSize()[i])) <= m_Index[i]) &&
           ((region.GetOrigin()[i] + static_cast<Type>(region.GetSize()[i])) <= m_Index[i] + static_cast<Type>(m_Size[i]))) ||
          ((region.GetOrigin()[i] >= m_Index[i]) && (region.GetOrigin()[i] >= m_Index[i] + static_cast<Type>(m_Size[i])) &&
           ((region.GetOrigin()[i] + static_cast<Type>(region.GetSize()[i])) >= m_Index[i]) &&
           ((region.GetOrigin()[i] + static_cast<Type>(region.GetSize()[i])) >= m_Index[i] + static_cast<Type>(m_Size[i]))))
      {
        return false;
      }
    }
 
    // we can crop, so crop
    for (unsigned int i = 0; i < IndexType::IndexDimension; ++i)
    {
      // first check the start index
      if (m_Index[i] < region.GetOrigin()[i])
      {
        // how much do we need to adjust
        crop = region.GetOrigin()[i] - m_Index[i];
 
        // adjust the start index and the size of the current region
        m_Index[i] += crop;
        m_Size[i] -= static_cast<Type>(crop);
      }
      // now check the final size
      if (m_Index[i] + static_cast<Type>(m_Size[i]) > region.GetOrigin()[i] + static_cast<Type>(region.GetSize()[i]))
      {
        // how much do we need to adjust
        crop = m_Index[i] + static_cast<Type>(m_Size[i]) - region.GetOrigin()[i] - static_cast<Type>(region.GetSize()[i]);
 
        // adjust the size
        m_Size[i] -= static_cast<Type>(crop);
      }
    }
 
    return cropPossible;
  }
 
protected:
  void PrintSelf(std::ostream& os, itk::Indent indent) const override
  {
    os << std::setprecision(15);
    os << indent << "RemoteSensingRegion" << std::endl;
    os << indent << "Index:" << this->m_Index << std::endl;
    os << indent << "Size:" << this->m_Size << std::endl;
    os << indent << "Projection:" << this->m_InputProjectionRef << std::endl;
    os << indent << "ImageMetadata: " << this->m_ImageMetadata << std::endl;
  }
 
private:
  IndexType m_Index;
  SizeType  m_Size;
 
  std::string      m_InputProjectionRef;
  ImageMetadata m_ImageMetadata; // if we want to specify the region in term of sensor geometry
};
// extern std::ostream & operator<<(std::ostream &os, const RemoteSensingRegion &region);
 
template <class TType>
std::ostream& operator<<(std::ostream& os, const RemoteSensingRegion<TType>& region)
{
  region.Print(os);
  return os;
}
 
template <class ImageType, class RemoteSensingRegionType>
typename ImageType::RegionType TransformPhysicalRegionToIndexRegion(const RemoteSensingRegionType& region, const ImageType* image)
{
  typename ImageType::RegionType            outputRegion;
  typename ImageType::RegionType::IndexType index;
  typename ImageType::RegionType::IndexType index2;
 
  typename ImageType::PointType point;
  point[0] = region.GetIndex()[0];
  point[1] = region.GetIndex()[1];
  image->TransformPhysicalPointToIndex(point, index);
 
  point[0] = region.GetIndex()[0] + region.GetSize()[0];
  point[1] = region.GetIndex()[1] + region.GetSize()[1];
  image->TransformPhysicalPointToIndex(point, index2);
 
  typename ImageType::RegionType::SizeType size;
  size[0] = std::abs(index2[0] - index[0]);
  size[1] = std::abs(index2[1] - index[1]);
 
  index[0] = std::min(index2[0], index[0]);
  index[1] = std::min(index2[1], index[1]);
 
  outputRegion.SetIndex(index);
  outputRegion.SetSize(size);
  return outputRegion;
}
 
 
} // end namespace otb
 
#endif