itkConstNeighborhoodIterator.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 __itkConstNeighborhoodIterator_h
#define __itkConstNeighborhoodIterator_h

#include <vector>
#include <string.h>
#include <iostream>
#include "itkImage.h"
#include "itkNeighborhood.h"
#include "itkMacro.h"
#include "itkZeroFluxNeumannBoundaryCondition.h"

namespace itk
{
template< class TImage,  class TBoundaryCondition =
            ZeroFluxNeumannBoundaryCondition< TImage > >
class ITK_EXPORT ConstNeighborhoodIterator:
  public Neighborhood< typename TImage::InternalPixelType *,
                       TImage::ImageDimension >
{
public:
  typedef typename TImage::InternalPixelType InternalPixelType;
  typedef typename TImage::PixelType         PixelType;

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

  typedef unsigned int                  DimensionValueType;

  typedef ConstNeighborhoodIterator Self;
  typedef Neighborhood< InternalPixelType *,
                        itkGetStaticConstMacro(Dimension) >    Superclass;

  typedef typename Superclass::OffsetType      OffsetType;
  typedef typename Superclass::RadiusType      RadiusType;
  typedef typename Superclass::SizeType        SizeType;
  typedef typename Superclass::Iterator        Iterator;
  typedef typename Superclass::ConstIterator   ConstIterator;

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

  typedef typename NeighborhoodType::NeighborIndexType  NeighborIndexType;

  typedef typename ImageType::NeighborhoodAccessorFunctorType
  NeighborhoodAccessorFunctorType;

  typedef TBoundaryCondition BoundaryConditionType;

  typedef ImageBoundaryCondition< ImageType > *ImageBoundaryConditionPointerType;
  typedef ImageBoundaryCondition< ImageType > const *
  ImageBoundaryConditionConstPointerType;

  ConstNeighborhoodIterator();

  virtual ~ConstNeighborhoodIterator() {}

  ConstNeighborhoodIterator(const ConstNeighborhoodIterator &);

  ConstNeighborhoodIterator(const SizeType & radius,
                            const ImageType *ptr,
                            const RegionType & region)
  {
    this->Initialize(radius, ptr, region);
    for ( unsigned int i = 0; i < Dimension; i++ )
              { m_InBounds[i] = false; }
    this->ResetBoundaryCondition();
    m_NeighborhoodAccessorFunctor = ptr->GetNeighborhoodAccessor();
    m_NeighborhoodAccessorFunctor.SetBegin( ptr->GetBufferPointer() );
  }

  Self & operator=(const Self & orig);

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

  OffsetType ComputeInternalIndex(NeighborIndexType n) const;

  IndexType GetBound() const
  {    return m_Bound;   }

  IndexValueType GetBound(NeighborIndexType n) const
  {    return m_Bound[n];  }

  const InternalPixelType * GetCenterPointer() const
  {    return ( this->operator[]( ( this->Size() ) >> 1 ) );  }

  PixelType GetCenterPixel() const
  { return m_NeighborhoodAccessorFunctor.Get( this->GetCenterPointer() ); }

  const ImageType * GetImagePointer(void) const
  { return m_ConstImage; }

  virtual IndexType GetIndex(void) const
  { return m_Loop;  }

  virtual NeighborhoodType GetNeighborhood() const;

  virtual PixelType GetPixel(NeighborIndexType i) const
  {
    if ( !m_NeedToUseBoundaryCondition )
      {
      return ( m_NeighborhoodAccessorFunctor.Get( this->operator[](i) ) );
      }
    bool inbounds;
    return this->GetPixel(i, inbounds);
  }

  virtual PixelType GetPixel(NeighborIndexType i, bool & IsInBounds) const;

  virtual PixelType GetPixel(const OffsetType & o) const
  {
    bool inbounds;

    return ( this->GetPixel(this->GetNeighborhoodIndex(o), inbounds) );
  }

  virtual PixelType GetPixel(const OffsetType & o,
                             bool & IsInBounds) const
  { return ( this->GetPixel(this->GetNeighborhoodIndex(o), IsInBounds) ); }

  virtual PixelType GetNext(const unsigned axis, NeighborIndexType i) const
  {
    return ( this->GetPixel( this->GetCenterNeighborhoodIndex()
                             + ( i * this->GetStride(axis) ) ) );
  }

  virtual PixelType GetNext(const unsigned axis) const
  {
    return ( this->GetPixel( this->GetCenterNeighborhoodIndex()
                             + this->GetStride(axis) ) );
  }

  virtual PixelType GetPrevious(const unsigned axis, NeighborIndexType i) const
  {
    return ( this->GetPixel( this->GetCenterNeighborhoodIndex()
                             - ( i * this->GetStride(axis) ) ) );
  }

  virtual PixelType GetPrevious(const unsigned axis) const
  {
    return ( this->GetPixel( this->GetCenterNeighborhoodIndex()
                             - this->GetStride(axis) ) );
  }

  virtual IndexType GetIndex(const OffsetType & o) const
  { return ( this->GetIndex() + o ); }

  virtual IndexType GetIndex(NeighborIndexType i) const
  { return ( this->GetIndex() + this->GetOffset(i) ); }

  RegionType GetRegion() const
  { return m_Region; }

  IndexType GetBeginIndex() const
  { return m_BeginIndex; }

  RegionType GetBoundingBoxAsImageRegion() const;

  OffsetType GetWrapOffset() const
  {  return m_WrapOffset;  }

  OffsetValueType GetWrapOffset(NeighborIndexType n) const
  {    return m_WrapOffset[n];   }

  virtual void GoToBegin();

  virtual void GoToEnd();

  virtual void Initialize(const SizeType & radius, const ImageType *ptr,
                          const RegionType & region);

  virtual bool IsAtBegin() const
  {    return ( this->GetCenterPointer() == m_Begin );   }

  virtual bool IsAtEnd() const
  {
    if ( this->GetCenterPointer() > m_End )
      {
      ExceptionObject    e(__FILE__, __LINE__);
      std::ostringstream msg;
      msg << "In method IsAtEnd, CenterPointer = " << this->GetCenterPointer()
          << " is greater than End = " << m_End
          << std::endl
          << "  " << *this;
      e.SetDescription( msg.str().c_str() );
      throw e;
      }
    return ( this->GetCenterPointer() == m_End );
  }

  Self & operator++();

  Self & operator--();

  bool operator==(const Self & it) const
  {   return it.GetCenterPointer() == this->GetCenterPointer();   }

  bool operator!=(const Self & it) const
  {    return it.GetCenterPointer() != this->GetCenterPointer();  }

  bool operator<(const Self & it) const
  {  return this->GetCenterPointer() < it.GetCenterPointer();  }

  bool operator<=(const Self & it) const
  {    return this->GetCenterPointer() <= it.GetCenterPointer();  }

  bool operator>(const Self & it) const
  {    return this->GetCenterPointer() > it.GetCenterPointer();  }

  bool operator>=(const Self & it) const
  {    return this->GetCenterPointer() >= it.GetCenterPointer();  }

  void SetLocation(const IndexType & position)
  {
    this->SetLoop(position);
    this->SetPixelPointers(position);
  }

  Self & operator+=(const OffsetType &);

  Self & operator-=(const OffsetType &);

  OffsetType operator-(const Self & b)
  {  return m_Loop - b.m_Loop;  }

  bool InBounds() const;

  bool IndexInBounds(NeighborIndexType n, OffsetType & internalIndex, OffsetType & offset ) const;

  virtual void OverrideBoundaryCondition(const
                                         ImageBoundaryConditionPointerType i)
  { m_BoundaryCondition = i; }

  virtual void ResetBoundaryCondition()
  { m_BoundaryCondition = &m_InternalBoundaryCondition;  }

  void SetBoundaryCondition(const TBoundaryCondition & c)
  { m_InternalBoundaryCondition = c; }

  ImageBoundaryConditionPointerType GetBoundaryCondition() const
  { return m_BoundaryCondition; }

  void NeedToUseBoundaryConditionOn()
  {
    this->SetNeedToUseBoundaryCondition(true);
  }

  void NeedToUseBoundaryConditionOff()
  {
    this->SetNeedToUseBoundaryCondition(false);
  }

  void SetNeedToUseBoundaryCondition(bool b)
  {
    m_NeedToUseBoundaryCondition = b;
  }

  bool GetNeedToUseBoundaryCondition() const
  {
    return m_NeedToUseBoundaryCondition;
  }

protected:

  virtual void SetLoop(const IndexType & p)
  {  m_Loop = p; m_IsInBoundsValid = false; }

  virtual void SetBound(const SizeType &);

  virtual void SetPixelPointers(const IndexType &);

  virtual void SetBeginIndex(const IndexType & start)
  {  m_BeginIndex = start;  }

  virtual void SetEndIndex();

  IndexType m_BeginIndex;

  IndexType m_Bound;

  const InternalPixelType *m_Begin;

  typename ImageType::ConstWeakPointer m_ConstImage;

  const InternalPixelType *m_End;

  IndexType m_EndIndex;

  IndexType m_Loop;

  RegionType m_Region;

  OffsetType m_WrapOffset;

  ImageBoundaryConditionPointerType m_BoundaryCondition;

  mutable bool m_InBounds[Dimension];

  mutable bool m_IsInBounds;

  mutable bool m_IsInBoundsValid;

  IndexType m_InnerBoundsLow;

  IndexType m_InnerBoundsHigh;

  TBoundaryCondition m_InternalBoundaryCondition;

  bool m_NeedToUseBoundaryCondition;

  NeighborhoodAccessorFunctorType m_NeighborhoodAccessorFunctor;
};

template< class TImage >
inline ConstNeighborhoodIterator< TImage >
operator+(const ConstNeighborhoodIterator< TImage > & it,
          const typename ConstNeighborhoodIterator< TImage >
          ::OffsetType & ind)
{
  ConstNeighborhoodIterator< TImage > ret;
  ret = it;
  ret += ind;
  return ret;
}

template< class TImage >
inline ConstNeighborhoodIterator< TImage >
operator+(const typename ConstNeighborhoodIterator< TImage >
          ::OffsetType & ind,
          const ConstNeighborhoodIterator< TImage > & it)
{  return ( it + ind ); }

template< class TImage >
inline ConstNeighborhoodIterator< TImage >
operator-(const ConstNeighborhoodIterator< TImage > & it,
          const typename ConstNeighborhoodIterator< TImage >
          ::OffsetType & ind)
{
  ConstNeighborhoodIterator< TImage > ret;
  ret = it;
  ret -= ind;
  return ret;
}
} // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_ConstNeighborhoodIterator(_, EXPORT, TypeX, TypeY)     \
  namespace itk                                                             \
  {                                                                         \
  _( 2 ( class EXPORT ConstNeighborhoodIterator< ITK_TEMPLATE_2 TypeX > ) ) \
  namespace Templates                                                       \
  {                                                                         \
  typedef ConstNeighborhoodIterator< ITK_TEMPLATE_2 TypeX >                 \
  ConstNeighborhoodIterator##TypeY;                                       \
  }                                                                         \
  }

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkConstNeighborhoodIterator+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkConstNeighborhoodIterator.hxx"
#endif

/*
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkConstNeighborhoodIterator.hxx"
#endif
*/
#endif