itkImageLinearConstIteratorWithIndex.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  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 itkImageLinearConstIteratorWithIndex_h
#define itkImageLinearConstIteratorWithIndex_h
 
#include "itkImageConstIteratorWithIndex.h"
#include <type_traits> // For remove_const_t.
 
namespace itk
{
template <typename TImage>
class ITK_TEMPLATE_EXPORT ImageLinearConstIteratorWithIndex : public ImageConstIteratorWithIndex<TImage>
{
public:
  using Self = ImageLinearConstIteratorWithIndex;
  using Superclass = ImageConstIteratorWithIndex<TImage>;

  using IndexType = typename TImage::IndexType;

  using RegionType = typename TImage::RegionType;

  using ImageType = TImage;

  using PixelContainer = typename TImage::PixelContainer;
  using PixelContainerPointer = typename PixelContainer::Pointer;

  ImageLinearConstIteratorWithIndex()
    : ImageConstIteratorWithIndex<TImage>()
 
  {}

  ImageLinearConstIteratorWithIndex(const TImage * ptr, const RegionType & region);

  ImageLinearConstIteratorWithIndex(const ImageConstIteratorWithIndex<TImage> & it)
  {
    this->ImageConstIteratorWithIndex<TImage>::operator=(it);
  }

  inline void
  NextLine();

  inline void
  PreviousLine();

  void
  GoToBeginOfLine();

  void
  GoToReverseBeginOfLine();

  void
  GoToEndOfLine();

  [[nodiscard]] inline bool
  IsAtEndOfLine() const
  {
    return this->m_PositionIndex[m_Direction] >= this->m_EndIndex[m_Direction];
  }

  [[nodiscard]] inline bool
  IsAtReverseEndOfLine() const
  {
    return this->m_PositionIndex[m_Direction] < this->m_BeginIndex[m_Direction];
  }

  inline void
  SetDirection(unsigned int direction)
  {
    if (direction >= TImage::ImageDimension)
    {
      itkGenericExceptionMacro("In image of dimension " << TImage::ImageDimension << " Direction " << direction
                                                        << " was selected");
    }
    m_Direction = direction;
    m_Jump = this->m_OffsetTable[m_Direction];
  }

  unsigned int
  GetDirection()
  {
    return m_Direction;
  }

  inline Self &
  operator++()
  {
    this->m_PositionIndex[m_Direction]++;
    this->m_Position += m_Jump;
    return *this;
  }

  inline Self &
  operator--()
  {
    this->m_PositionIndex[m_Direction]--;
    this->m_Position -= m_Jump;
    return *this;
  }
 
private:
  OffsetValueType m_Jump{ 0 };
  unsigned int    m_Direction{ 0 };
};
 
// Deduction guide for class template argument deduction (CTAD).
template <typename TImage>
ImageLinearConstIteratorWithIndex(SmartPointer<TImage>, const typename TImage::RegionType &)
  -> ImageLinearConstIteratorWithIndex<std::remove_const_t<TImage>>;
 
 
//----------------------------------------------------------------------
//  Go to next line
//----------------------------------------------------------------------
template <typename TImage>
inline void
ImageLinearConstIteratorWithIndex<TImage>::NextLine()
{
  this->m_Position -=
    this->m_OffsetTable[m_Direction] * (this->m_PositionIndex[m_Direction] - this->m_BeginIndex[m_Direction]);
 
  this->m_PositionIndex[m_Direction] = this->m_BeginIndex[m_Direction];
 
  for (unsigned int n = 0; n < TImage::ImageDimension; ++n)
  {
    this->m_Remaining = false;
 
    if (n == m_Direction)
    {
      continue;
    }
 
    this->m_PositionIndex[n]++;
    if (this->m_PositionIndex[n] < this->m_EndIndex[n])
    {
      this->m_Position += this->m_OffsetTable[n];
      this->m_Remaining = true;
      break;
    }
 
    this->m_Position -= this->m_OffsetTable[n] * (this->m_Region.GetSize()[n] - 1);
    this->m_PositionIndex[n] = this->m_BeginIndex[n];
  }
}
 
//----------------------------------------------------------------------
//  Pass to the last pixel on the previous line
//----------------------------------------------------------------------
template <typename TImage>
inline void
ImageLinearConstIteratorWithIndex<TImage>::PreviousLine()
{
  this->m_Position +=
    this->m_OffsetTable[m_Direction] * (this->m_EndIndex[m_Direction] - 1 - this->m_PositionIndex[m_Direction]);
 
  this->m_PositionIndex[m_Direction] = this->m_EndIndex[m_Direction] - 1;
 
  for (unsigned int n = 0; n < TImage::ImageDimension; ++n)
  {
    this->m_Remaining = false;
 
    if (n == m_Direction)
    {
      continue;
    }
 
    this->m_PositionIndex[n]--;
    if (this->m_PositionIndex[n] >= this->m_BeginIndex[n])
    {
      this->m_Position -= this->m_OffsetTable[n];
      this->m_Remaining = true;
      break;
    }
 
    this->m_Position += this->m_OffsetTable[n] * (this->m_Region.GetSize()[n] - 1);
    this->m_PositionIndex[n] = this->m_EndIndex[n] - 1;
  }
}
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkImageLinearConstIteratorWithIndex.hxx"
#endif
 
#endif