otbImageReference.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 otbImageReference_h
#define otbImageReference_h
 
#include "itkPoint.h"
 
namespace otb
{
namespace ogr
{
template <typename TPrecision>
class ImageReference
{
public:
  typedef TPrecision PrecisionType;
  enum
  {
    Dimension = 2
  };
 
 
  bool GetDebug() const
  {
    return m_Holder.GetDebug();
  }
 
  typedef itk::Vector<PrecisionType, 2> SpacingType;
  typedef itk::Point<PrecisionType, 2>  OriginType;
  typedef itk::Point<PrecisionType, 2>  PointType;
 
  inline const char* GetNameOfClass()
  {
    return "ImageReference";
  }
 
  ImageReference(itk::Object const& holder) : m_Holder(holder)
  {
    m_Spacing.Fill(1);
    m_Origin.Fill(0);
  }
 
  ImageReference(SpacingType const& spacing, OriginType const& origin, itk::Object const& holder) : m_Holder(holder), m_Spacing(spacing), m_Origin(origin)
  {
  }
 
  void Modified() const
  {
    m_Holder.Modified();
  }
 
  itkGetConstReferenceMacro(Origin, OriginType);     
  itkSetMacro(Origin, OriginType);                   
  void SetOrigin(const TPrecision origin[Dimension]) 
  {
    const OriginType p(origin);
    this->SetOrigin(p);
  }
 
 
  itkGetConstReferenceMacro(Spacing, SpacingType); 
  void SetSpacing(const SpacingType& spacing)      
  {
    // itkDebugMacro("setting Spacing to " << spacing);
    if (this->m_Spacing != spacing)
    {
      this->m_Spacing = spacing;
      this->Modified();
    }
  }
  void SetSpacing(const TPrecision spacing[Dimension]) 
  {
    const SpacingType s(spacing);
    this->SetSpacing(s);
  }
 
 
  void TransformPointToPhysicalPoint(const PointType& point, PointType& physicalPoint) const
  {
    for (size_t i      = 0; i != Dimension; ++i)
      physicalPoint[i] = point[i] * m_Spacing[i] + m_Origin[i];
  }
 
  PointType TransformPointToPhysicalPoint(const PointType& point) const
  {
    // why no loop on VDimension ?
    PointType physicalPoint;
    for (size_t i      = 0; i != Dimension; ++i)
      physicalPoint[i] = point[i] * m_Spacing[i] + m_Origin[i];
    return physicalPoint;
  }
 
  ImageReference& operator=(ImageReference const& rhs)
  {
    m_Spacing = rhs.m_Spacing;
    m_Origin  = rhs.m_Origin;
    return *this;
  }
 
private:
  itk::Object const& m_Holder;
  SpacingType        m_Spacing;
  OriginType         m_Origin;
};
 
} // ogr namespace
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
// #include "otbImageReference.hxx"
#endif
 
#endif // otbImageReference_h