itkConstShapedNeighborhoodIterator.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 __itkConstShapedNeighborhoodIterator_h
#define __itkConstShapedNeighborhoodIterator_h

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

namespace itk
{
template< typename TImage,  typename TBoundaryCondition =
            ZeroFluxNeumannBoundaryCondition< TImage > >
class ConstShapedNeighborhoodIterator:
  private NeighborhoodIterator< TImage, TBoundaryCondition >
{
public:

  typedef typename TImage::InternalPixelType InternalPixelType;
  typedef typename TImage::PixelType         PixelType;

  itkStaticConstMacro(Dimension, unsigned int, TImage::ImageDimension);

  typedef ConstShapedNeighborhoodIterator                    Self;
  typedef NeighborhoodIterator< TImage, TBoundaryCondition > Superclass;

  typedef typename Superclass::OffsetType      OffsetType;
  typedef typename OffsetType::OffsetValueType OffsetValueType;
  typedef typename Superclass::RadiusType      RadiusType;
  typedef typename Superclass::SizeType        SizeType;
  typedef typename SizeType::SizeValueType     SizeValueType;

  typedef TImage                                     ImageType;
  typedef typename TImage::RegionType                RegionType;
  typedef Index< itkGetStaticConstMacro(Dimension) > IndexType;
  typedef typename IndexType::IndexValueType         IndexValueType;
  typedef Neighborhood< PixelType, itkGetStaticConstMacro(Dimension) >
  NeighborhoodType;

  typedef typename NeighborhoodType::NeighborIndexType  NeighborIndexType;

  typedef std::list< NeighborIndexType >             IndexListType;

  typedef typename IndexListType::iterator        IndexListIterator;
  typedef typename IndexListType::const_iterator  IndexListConstIterator;

  typedef TBoundaryCondition BoundaryConditionType;

  typedef ImageBoundaryCondition< ImageType > *ImageBoundaryConditionPointerType;

  struct ConstIterator {
    ConstIterator() { m_NeighborhoodIterator = ITK_NULLPTR; }
    ConstIterator(Self *s)
    {
      m_NeighborhoodIterator = s;
      this->GoToBegin();
    }

    virtual ~ConstIterator() {}

    ConstIterator & operator=(const ConstIterator & o)
    {
      m_NeighborhoodIterator = o.m_NeighborhoodIterator;
      m_ListIterator = o.m_ListIterator;
      return *this;
    }

    ConstIterator(const ConstIterator & o)
    {
      m_NeighborhoodIterator = o.m_NeighborhoodIterator;
      m_ListIterator = o.m_ListIterator;
    }

    void operator++(int)
    { m_ListIterator++; }

    void operator--(int)
    { m_ListIterator--; }

    const ConstIterator & operator++()
    {
      m_ListIterator++;
      return *this;
    }

    const ConstIterator & operator--()
    {
      m_ListIterator--;
      return *this;
    }

    bool operator!=(const ConstIterator & o) const
    { return m_ListIterator != o.m_ListIterator; }
    bool operator==(const ConstIterator & o) const
    { return m_ListIterator == o.m_ListIterator; }

    bool IsAtEnd() const
    {
      if ( m_ListIterator == m_NeighborhoodIterator->GetActiveIndexList().end() )
        {
        return true;
        }
      else
        {
        return false;
        }
    }

    void GoToBegin()
    {
      m_ListIterator = m_NeighborhoodIterator->GetActiveIndexList().begin();
    }

    void GoToEnd()
    {
      m_ListIterator = m_NeighborhoodIterator->GetActiveIndexList().end();
    }

    PixelType Get() const
    { return m_NeighborhoodIterator->GetPixel(*m_ListIterator); }

    OffsetType GetNeighborhoodOffset() const
    { return m_NeighborhoodIterator->GetOffset(*m_ListIterator); }

    typename IndexListType::value_type GetNeighborhoodIndex() const
    { return *m_ListIterator; }

protected:

    Self *m_NeighborhoodIterator;

    typename IndexListType::const_iterator m_ListIterator;

    void ProtectedSet(const PixelType & v) const
    { m_NeighborhoodIterator->SetPixel(*m_ListIterator, v); }
  };

  const ConstIterator & Begin() const
  { return m_ConstBeginIterator; }

  const ConstIterator & End() const
  { return m_ConstEndIterator; }

  ConstShapedNeighborhoodIterator()
  {
    InitializeConstShapedNeighborhoodIterator();
  }

  void InitializeConstShapedNeighborhoodIterator()
  {
    m_ConstBeginIterator = ConstIterator(this);
    m_ConstEndIterator = ConstIterator(this);
    m_ConstEndIterator.GoToEnd();
    m_CenterIsActive = false;
  }

  virtual ~ConstShapedNeighborhoodIterator()  {}

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

  // Expose the following methods from the superclass.  This is a
  // restricted subset of the methods available for
  // ConstNeighborhoodIterator.
  using Superclass::GetImagePointer;
  using Superclass::GetRadius;
  using Superclass::GetIndex;
  using Superclass::GetNeighborhoodIndex;
  using Superclass::GetCenterNeighborhoodIndex;
  using Superclass::GetRegion;
  using Superclass::GetBeginIndex;
  using Superclass::GoToBegin;
  using Superclass::GoToEnd;
  using Superclass::IsAtBegin;
  using Superclass::IsAtEnd;
  using Superclass::GetOffset;
  using Superclass::operator==;
  using Superclass::operator!=;
  using Superclass::operator<;
  using Superclass::operator>;
  using Superclass::operator>=;
  using Superclass::operator<=;
  using Superclass::operator[];
  using Superclass::GetElement;
  using Superclass::SetLocation;
  using Superclass::GetCenterPointer;
  using Superclass::GetCenterPixel;
  using Superclass::OverrideBoundaryCondition;
  using Superclass::ResetBoundaryCondition;
  using Superclass::GetBoundaryCondition;
  using Superclass::GetNeedToUseBoundaryCondition;
  using Superclass::SetNeedToUseBoundaryCondition;
  using Superclass::NeedToUseBoundaryConditionOn;
  using Superclass::NeedToUseBoundaryConditionOff;
  using Superclass::Print;
  using Superclass::operator-;
  using Superclass::GetPixel;
  using Superclass::SetRegion;

  Self & operator=(const Self & orig)
  {
    if(this != &orig)
      {
      Superclass::operator=(orig);
      m_ActiveIndexList = orig.m_ActiveIndexList;
      m_CenterIsActive = orig.m_CenterIsActive;

      // Reset begin and end pointers
      m_ConstBeginIterator.GoToBegin();
      m_ConstEndIterator.GoToBegin();
      }
    return *this;
  }

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

  virtual void ActivateOffset(const OffsetType & off)
  { this->ActivateIndex( Superclass::GetNeighborhoodIndex(off) ); }
  virtual void DeactivateOffset(const OffsetType & off)
  { this->DeactivateIndex( Superclass::GetNeighborhoodIndex(off) ); }

  virtual void ClearActiveList()
  {
    m_ActiveIndexList.clear();
    m_ConstBeginIterator.GoToBegin();
    m_ConstEndIterator.GoToEnd();
    m_CenterIsActive = false;
  }

  const IndexListType & GetActiveIndexList() const
  { return m_ActiveIndexList; }

  typename IndexListType::size_type GetActiveIndexListSize() const
  { return m_ActiveIndexList.size(); }

  void CreateActiveListFromNeighborhood(const NeighborhoodType &);

  Self & operator++();

  Self & operator--();

  Self & operator+=(const OffsetType &);

  Self & operator-=(const OffsetType &);

protected:
  using Superclass::SetPixel;
  using Superclass::SetCenterPixel;
  ConstShapedNeighborhoodIterator(const ConstShapedNeighborhoodIterator &);
  // purposely not implemented

  friend struct ConstIterator;

  //  Superclass::SetPixel;
  //  Superclass::SetCenterPixel;

  virtual void ActivateIndex( NeighborIndexType );

  virtual void DeactivateIndex( NeighborIndexType );

  bool          m_CenterIsActive;
  IndexListType m_ActiveIndexList;
  ConstIterator m_ConstEndIterator;
  ConstIterator m_ConstBeginIterator;
};
} // namespace itk

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

#endif