itkNeighborhoodIterator.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
 *
 *         http://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 itkNeighborhoodIterator_h
#define itkNeighborhoodIterator_h
 
#include <vector>
#include <cstring>
#include <iostream>
#include "itkConstNeighborhoodIterator.h"
 
namespace itk
{
template <typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
class ITK_TEMPLATE_EXPORT NeighborhoodIterator : public ConstNeighborhoodIterator<TImage, TBoundaryCondition>
{
public:
  using Self = NeighborhoodIterator;
  using Superclass = ConstNeighborhoodIterator<TImage, TBoundaryCondition>;
 
  using InternalPixelType = typename Superclass::InternalPixelType;
  using PixelType = typename Superclass::PixelType;
  using SizeType = typename Superclass::SizeType;
  using ImageType = typename Superclass::ImageType;
  using RegionType = typename Superclass::RegionType;
  using IndexType = typename Superclass::IndexType;
  using OffsetType = typename Superclass::OffsetType;
  using RadiusType = typename Superclass::RadiusType;
  using NeighborhoodType = typename Superclass::NeighborhoodType;
  using Iterator = typename Superclass::Iterator;
  using ConstIterator = typename Superclass::ConstIterator;
  using ImageBoundaryConditionPointerType = typename Superclass::ImageBoundaryConditionPointerType;
 
  NeighborhoodIterator()
    : Superclass()
  {}
 
  NeighborhoodIterator(const NeighborhoodIterator & n)
    : Superclass(n)
  {}
 
  Self &
  operator=(const Self & orig)
  {
    Superclass::operator=(orig);
    return *this;
  }
 
  NeighborhoodIterator(const SizeType & radius, ImageType * ptr, const RegionType & region)
    : Superclass(radius, ptr, region)
  {}
 
  void
  PrintSelf(std::ostream &, Indent) const override;
 
  InternalPixelType *
  GetCenterPointer()
  {
    return (this->operator[]((this->Size()) >> 1));
  }
 
  ITK_ITERATOR_VIRTUAL void
  SetCenterPixel(const PixelType & p) ITK_ITERATOR_FINAL
  {
    this->m_NeighborhoodAccessorFunctor.Set(this->operator[]((this->Size()) >> 1), p);
  }
 
  ITK_ITERATOR_VIRTUAL void
  SetNeighborhood(const NeighborhoodType &) ITK_ITERATOR_FINAL;
 
  ITK_ITERATOR_VIRTUAL void
  SetPixel(const unsigned i, const PixelType & v, bool & status) ITK_ITERATOR_FINAL;
 
  ITK_ITERATOR_VIRTUAL void
  SetPixel(const unsigned i, const PixelType & v) ITK_ITERATOR_FINAL;
 
  //  { *(this->operator[](i)) = v; }
 
  ITK_ITERATOR_VIRTUAL void
  SetPixel(const OffsetType o, const PixelType & v) ITK_ITERATOR_FINAL
  {
    this->SetPixel(this->GetNeighborhoodIndex(o), v);
  }
  //  { *(this->operator[](o)) = v; }
 
  ITK_ITERATOR_VIRTUAL void
  SetNext(const unsigned axis, const unsigned i, const PixelType & v) ITK_ITERATOR_FINAL
  {
    this->SetPixel(this->GetCenterNeighborhoodIndex() + (i * this->GetStride(axis)), v);
  }
 
  ITK_ITERATOR_VIRTUAL void
  SetNext(const unsigned axis, const PixelType & v) ITK_ITERATOR_FINAL
  {
    this->SetPixel(this->GetCenterNeighborhoodIndex() + this->GetStride(axis), v);
  }
 
  ITK_ITERATOR_VIRTUAL void
  SetPrevious(const unsigned axis, const unsigned i, const PixelType & v) ITK_ITERATOR_FINAL
  {
    this->SetPixel(this->GetCenterNeighborhoodIndex() - (i * this->GetStride(axis)), v);
  }
 
  ITK_ITERATOR_VIRTUAL void
  SetPrevious(const unsigned axis, const PixelType & v) ITK_ITERATOR_FINAL
  {
    this->SetPixel(this->GetCenterNeighborhoodIndex() - this->GetStride(axis), v);
  }
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkNeighborhoodIterator.hxx"
#endif
 
#endif