itkPathIterator.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 itkPathIterator_h
#define itkPathIterator_h
 
#include "itkPathConstIterator.h"
 
namespace itk
{
template <typename TImage, typename TPath>
class ITK_TEMPLATE_EXPORT PathIterator : public PathConstIterator<TImage, TPath>
{
public:
  using Self = PathIterator;

  static constexpr unsigned int ImageIteratorDimension = TImage::ImageDimension;

  using Superclass = PathConstIterator<TImage, TPath>;

  using typename Superclass::IndexType;
  using typename Superclass::OffsetType;
  using typename Superclass::SizeType;
  using typename Superclass::ImageType;
  using typename Superclass::PixelContainer;
  using typename Superclass::PixelContainerPointer;
  using typename Superclass::InternalPixelType;
  using typename Superclass::PixelType;
  using typename Superclass::AccessorType;
  using typename Superclass::PathType;
  using typename Superclass::PathInputType;
  using typename Superclass::PathOutputType;

  itkOverrideGetNameOfClassMacro(PathIterator);

  void
  Set(const PixelType & value)
  {
    // Normally, this would just be the following:
    //   m_Image->SetPixel(m_CurrentImageIndex,value);
    // However, we don't want a warning about m_Image being a ConstPointer
    // in the Superclass.
    const_cast<ImageType *>(this->m_Image.GetPointer())->SetPixel(this->m_CurrentImageIndex, value);
  }

  PixelType &
  Value()
  {
    return this->GetImage()->GetPixel(this->m_ImageIndex);
  }

  Self &
  operator=(const Self & it);

  PathIterator(ImageType * imagePtr, const PathType * pathPtr);

  ~PathIterator() override = default;
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkPathIterator.hxx"
#endif
 
#endif