itkImageSliceConstIteratorWithIndex.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 itkImageSliceConstIteratorWithIndex_h
#define itkImageSliceConstIteratorWithIndex_h
 
#include "itkImageConstIteratorWithIndex.h"
#include <type_traits> // For remove_const_t.
 
namespace itk
{
template <typename TImage>
class ITK_TEMPLATE_EXPORT ImageSliceConstIteratorWithIndex : public ImageConstIteratorWithIndex<TImage>
{
public:
  using Self = ImageSliceConstIteratorWithIndex;
  using Superclass = ImageConstIteratorWithIndex<TImage>;

  using typename Superclass::IndexType;
  using typename Superclass::SizeType;
  using typename Superclass::OffsetType;
  using typename Superclass::RegionType;
  using typename Superclass::ImageType;
  using typename Superclass::PixelContainer;
  using typename Superclass::PixelContainerPointer;
  using typename Superclass::InternalPixelType;
  using typename Superclass::PixelType;
  using typename Superclass::AccessorType;

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

  ImageSliceConstIteratorWithIndex(const TImage * ptr, const RegionType & region)
    : ImageConstIteratorWithIndex<TImage>(ptr, region)
    , m_PixelJump(0)
    , m_LineJump(0)
    , m_Direction_A(0)
    , m_Direction_B(1)
  {}

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

  void
  NextLine();

  void
  GoToBeginOfSlice();

  void
  NextSlice();

  void
  PreviousLine();

  void
  PreviousSlice();

  [[nodiscard]] bool
  IsAtEndOfLine() const;

  [[nodiscard]] bool
  IsAtEndOfSlice() const;

  [[nodiscard]] bool
  IsAtReverseEndOfLine() const;

  [[nodiscard]] bool
  IsAtReverseEndOfSlice() const;

  void
  SetFirstDirection(unsigned int direction);

  void
  SetSecondDirection(unsigned int direction);

  inline Self &
  operator++();

  inline Self &
  operator--();
 
private:
  SizeValueType m_PixelJump;
  SizeValueType m_LineJump;
  unsigned int  m_Direction_A;
  unsigned int  m_Direction_B;
};
 
// Deduction guide for class template argument deduction (CTAD).
template <typename TImage>
ImageSliceConstIteratorWithIndex(SmartPointer<TImage>, const typename TImage::RegionType &)
  -> ImageSliceConstIteratorWithIndex<std::remove_const_t<TImage>>;
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkImageSliceConstIteratorWithIndex.hxx"
#endif
 
#endif