itkShapedNeighborhoodIterator.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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 itkShapedNeighborhoodIterator_h
#define itkShapedNeighborhoodIterator_h

#include <vector>
#include <list>
#include "itkConstShapedNeighborhoodIterator.h"

namespace itk
{
template< typename TImage,
          typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >
          >
class ITK_TEMPLATE_EXPORT ShapedNeighborhoodIterator:
    public ConstShapedNeighborhoodIterator< TImage,
                                            TBoundaryCondition >
{
public:
  using InternalPixelType = typename TImage::InternalPixelType;
  using PixelType = typename TImage::PixelType;

  static constexpr unsigned int Dimension = TImage::ImageDimension;

  using Self = ShapedNeighborhoodIterator;
  using Superclass = ConstShapedNeighborhoodIterator< TImage,
                                                      TBoundaryCondition>;

  using OffsetType = typename Superclass::OffsetType;
  using OffsetValueType = typename OffsetType::OffsetValueType;
  using RadiusType = typename Superclass::RadiusType;
  using SizeType = typename Superclass::SizeType;
  using SizeValueType = typename Superclass::SizeValueType;
  using ConstIterator = typename Superclass::ConstIterator;
  using IndexListType = typename Superclass::IndexListType;
  using BoundaryConditionType = typename Superclass::BoundaryConditionType;
  using ImageBoundaryConditionPointerType = typename Superclass::ImageBoundaryConditionPointerType;
  using NeighborhoodType = typename Superclass::NeighborhoodType;
  using IndexType = typename Superclass::IndexType;
  using ImageType = typename Superclass::ImageType;
  using RegionType = typename Superclass::RegionType;
  using IndexValueType = typename Superclass::IndexValueType;

  struct Iterator:public ConstIterator {
    Iterator() = default;
    Iterator(Self *s) :
      ConstIterator(s) {}

    ~Iterator() ITK_ITERATOR_OVERRIDE = default;
    Iterator & operator=(const Iterator & o)
    {
      ConstIterator::operator=(o);
      return *this;
    }

    // Promote to public
    void Set(const PixelType & v) const
    { ConstIterator::ProtectedSet(v); }
  protected:

    friend Self;

    Iterator( const Self *s, const typename IndexListType::const_iterator &li )
      : ConstIterator(s,li) { }

  };

  ShapedNeighborhoodIterator() = default;

  ~ShapedNeighborhoodIterator() override = default;

  ShapedNeighborhoodIterator(const SizeType & radius,
                             const ImageType *ptr,
                             const RegionType & region
                             ):Superclass(radius, const_cast< ImageType * >( ptr ),
                                          region)
  {
  }

  // Expose the following methods from the superclass.  This is a restricted
  // subset of the methods available for NeighborhoodIterator.
  using Superclass::SetPixel;
  using Superclass::SetCenterPixel;


  Self & operator=(const Self & orig)
  {
    Superclass::operator=(orig);
    return *this;
  }

  void PrintSelf(std::ostream &, Indent) const override;

  Iterator Begin() { return Iterator(this, this->m_ActiveIndexList.begin()); }
  Iterator End() { return Iterator(this, this->m_ActiveIndexList.end()); }

  using Superclass::Begin;
  using Superclass::End;

protected:

  friend Superclass;

  ShapedNeighborhoodIterator(const ShapedNeighborhoodIterator & o) = delete;

  using NeighborIndexType = typename Superclass::NeighborIndexType;

};
} // namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkShapedNeighborhoodIterator.hxx"
#endif

#endif