otbVectorImage.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 otbVectorImage_h
#define otbVectorImage_h
 
#if defined(__GNUC__) || defined(__clang__)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-parameter"
#include "itkVectorImage.h"
#pragma GCC diagnostic pop
#else
#include "itkVectorImage.h"
#endif
#include "otbImageMetadataInterfaceBase.h"
#include "otbImageCommons.h"
#include "OTBImageBaseExport.h"
 
namespace otb
{
template <class TPixel, unsigned int VImageDimension = 2>
class OTBImageBase_EXPORT_TEMPLATE VectorImage
  : public itk::VectorImage<TPixel, VImageDimension>
  , public ImageCommons
{
public:
  using Self = VectorImage;
  using Superclass = itk::VectorImage<TPixel, VImageDimension>;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;
  using ConstWeakPointer = itk::WeakPointer<const Self>;
 
  using VectorType = ImageMetadataInterfaceBase::VectorType;
 
  itkNewMacro(Self);
 
  itkTypeMacro(VectorImage, itk::VectorImage);
 
  typedef typename Superclass::PixelType PixelType;
 
  typedef typename Superclass::ValueType ValueType;
 
  typedef typename Superclass::InternalPixelType InternalPixelType;
 
  typedef typename Superclass::IOPixelType IOPixelType;
 
  // typedef itk::DefaultVectorPixelAccessor< InternalPixelType > AccessorType;
 
  typedef itk::DefaultVectorPixelAccessorFunctor<Self> AccessorFunctorType;
 
  typedef itk::VectorImageNeighborhoodAccessorFunctor<Self> NeighborhoodAccessorFunctorType;
 
  itkStaticConstMacro(ImageDimension, unsigned int, VImageDimension);
 
  typedef typename Superclass::PixelContainer PixelContainer;
 
  typedef typename Superclass::IndexType IndexType;
 
  typedef typename Superclass::OffsetType OffsetType;
 
  typedef typename Superclass::SizeType SizeType;
 
  typedef typename Superclass::DirectionType DirectionType;
 
  typedef typename Superclass::RegionType RegionType;
 
  typedef typename Superclass::SpacingType SpacingType;
 
  typedef typename Superclass::PointType PointType;
 
  virtual VectorType GetGeoTransform(void) const;
 
  // TODO: GenericRSTransform should be instantiated to translate from physical
  // space to EPSG:4328 ?
  VectorType GetUpperLeftCorner(void) const;
  VectorType GetUpperRightCorner(void) const;
  VectorType GetLowerLeftCorner(void) const;
  VectorType GetLowerRightCorner(void) const;
 
 
  SpacingType GetSignedSpacing() const;
 
  virtual void SetSignedSpacing(SpacingType spacing);
  virtual void SetSignedSpacing(double spacing[VImageDimension]);
 
  virtual void SetNumberOfComponentsPerPixel(unsigned int n) override;
 
  void CopyInformation(const itk::DataObject*) override;
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  //   AccessorType GetPixelAccessor( void )
  //   {
  //     return AccessorType( this->GetNumberOfComponentsPerPixel() );
  //   }
 
  //   const AccessorType GetPixelAccessor( void ) const
  //   {
  //     return AccessorType( this->GetNumberOfComponentsPerPixel() );
  //   }
 
  NeighborhoodAccessorFunctorType GetNeighborhoodAccessor()
  {
    return NeighborhoodAccessorFunctorType(this->GetNumberOfComponentsPerPixel());
  }
 
  const NeighborhoodAccessorFunctorType GetNeighborhoodAccessor() const
  {
    return NeighborhoodAccessorFunctorType(this->GetNumberOfComponentsPerPixel());
  }
 
protected:
  VectorImage();
  ~VectorImage() override
  {
  }
 
private:
  VectorImage(const Self&) = delete;
  void operator=(const Self&) = delete;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbVectorImage.hxx"
#endif
 
#include <complex>
 
namespace otb
{
 
// Prevent implicit instantiation of common types to improve build performance
// Explicit instantiations are provided in the .cxx
extern template class OTBImageBase_EXPORT_TEMPLATE VectorImage<unsigned int, 2>;
extern template class OTBImageBase_EXPORT_TEMPLATE VectorImage<int, 2>;
extern template class OTBImageBase_EXPORT_TEMPLATE VectorImage<unsigned char, 2>;
extern template class OTBImageBase_EXPORT_TEMPLATE VectorImage<char, 2>;
extern template class OTBImageBase_EXPORT_TEMPLATE VectorImage<unsigned short, 2>;
extern template class OTBImageBase_EXPORT_TEMPLATE VectorImage<short, 2>;
extern template class OTBImageBase_EXPORT_TEMPLATE VectorImage<float, 2>;
extern template class OTBImageBase_EXPORT_TEMPLATE VectorImage<double, 2>;
extern template class OTBImageBase_EXPORT_TEMPLATE VectorImage<std::complex<int>, 2>;
extern template class OTBImageBase_EXPORT_TEMPLATE VectorImage<std::complex<short>, 2>;
extern template class OTBImageBase_EXPORT_TEMPLATE VectorImage<std::complex<float>, 2>;
extern template class OTBImageBase_EXPORT_TEMPLATE VectorImage<std::complex<double>, 2>;
}
 
#endif