otbSubsampledImageRegionConstIterator.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 * Copyright (C) 2007-2012 Institut Mines Telecom / Telecom Bretagne
 *
 * 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 otbSubsampledImageRegionConstIterator_h
#define otbSubsampledImageRegionConstIterator_h
 
#include "itkImageRegionConstIterator.h"
 
namespace otb
{
 
template <class TImage>
class ITK_EXPORT SubsampledImageRegionConstIterator : public itk::ImageRegionConstIterator<TImage>
{
public:
 
  typedef SubsampledImageRegionConstIterator    Self;
  typedef itk::ImageRegionConstIterator<TImage> Superclass;
 
  itkTypeMacro(SubsampledImageRegionConstIterator, ImageRegionConstIterator);
 
  itkStaticConstMacro(ImageIteratorDimension, unsigned int, Superclass::ImageIteratorDimension);
 
  typedef typename Superclass::IndexType IndexType;
 
  typedef typename Superclass::SizeType SizeType;
 
  typedef typename Superclass::RegionType RegionType;
 
  typedef typename Superclass::ImageType ImageType;
 
  // typedef typename Superclass::OffsetType OffsetType;
  typedef unsigned long OffsetType;
 
  typedef typename Superclass::PixelContainer        PixelContainer;
  typedef typename Superclass::PixelContainerPointer PixelContainerPointer;
 
  typedef typename Superclass::InternalPixelType InternalPixelType;
 
  typedef typename Superclass::PixelType PixelType;
 
  typedef typename Superclass::AccessorType AccessorType;
 
  // typedef typename Superclass::IndexValueType IndexValueType;
  typedef typename IndexType::IndexValueType IndexValueType;
 
  SubsampledImageRegionConstIterator();
 
  SubsampledImageRegionConstIterator(const ImageType* ptr, const RegionType& region);
 
  SubsampledImageRegionConstIterator(const itk::ImageIterator<TImage>& it);
 
  SubsampledImageRegionConstIterator(const itk::ImageConstIterator<TImage>& it);
 
  void SetSubsampleFactor(IndexValueType factor);
 
  void SetSubsampleFactor(const IndexType& factor);
 
  const IndexType& GetSubsampleFactor() const
  {
    return this->m_SubsampleFactor;
  }
 
  void GoToBegin();
 
  void GoToEnd();
 
  bool IsAtBegin(void) const
  {
    return (this->m_Offset <= m_SubSampledBeginOffset);
  }
 
  bool IsAtEnd(void) const
  {
    return (this->m_Offset >= m_SubSampledEndOffset);
  }
 
  void SetIndex(const IndexType& ind) override;
 
  IndexType GetIndex() const
  {
    return Superclass::GetIndex();
  }
 
  Self& operator++()
  {
    // On the contrary to itk::ImageRegionConstIterator, m_Offset to
    // not incremented before the test
    if (this->m_Offset + m_SubsampleFactor[0] >= this->m_SpanEndOffset)
    {
      this->Increment();
    }
    else
    {
      // Now, the increment is performed
      this->m_Offset += m_SubsampleFactor[0];
    }
    return *this;
  }
 
  Self& operator--()
  {
    // On the contrary to itk::ImageRegionConstIterator, m_Offset
    // is not decremented here (it may become negative!)
    if (this->m_Offset < this->m_SpanBeginOffset + m_SubsampleFactor[0])
    {
      this->Decrement();
    }
    else
    {
      // Now we can
      this->m_Offset -= m_SubsampleFactor[0];
    }
    return *this;
  }
 
  void SetOffset(const OffsetType& offset);
  OffsetType GetOffset() const
  {
    return this->m_Offset;
  }
 
  RegionType GenerateOutputInformation() const;
 
protected:
  IndexType     m_SubsampleFactor;
  unsigned long m_SubSampledBeginOffset;
  // unsigned long m_SubSampledReverseEndOffset;
  long      m_SubSampledEndOffset;
  IndexType m_FirstUsableIndex;
  IndexType m_LastUsableIndex;
 
private:
  void Increment(); // jump in a direction other than the fastest moving
  void Decrement(); // go back in a direction other than the fastest moving
};
 
} // end of namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbSubsampledImageRegionConstIterator.hxx"
#endif
 
#endif