itkConstNeighborhoodIteratorWithOnlyIndex.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 itkConstNeighborhoodIteratorWithOnlyIndex_h
#define itkConstNeighborhoodIteratorWithOnlyIndex_h

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

namespace itk
{
template< typename TImage >
class ITK_TEMPLATE_EXPORT ConstNeighborhoodIteratorWithOnlyIndex:
  public Neighborhood< char, TImage::ImageDimension >
{
public:

  typedef unsigned int                  DimensionValueType;

  itkStaticConstMacro(Dimension, DimensionValueType, TImage::ImageDimension);

  typedef char                          DummyNeighborhoodPixelType;

  typedef ConstNeighborhoodIteratorWithOnlyIndex Self;
  typedef Neighborhood< DummyNeighborhoodPixelType, 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< DummyNeighborhoodPixelType, itkGetStaticConstMacro(Dimension) > NeighborhoodType;

  typedef typename NeighborhoodType::NeighborIndexType  NeighborIndexType;

  ConstNeighborhoodIteratorWithOnlyIndex();

  virtual ~ConstNeighborhoodIteratorWithOnlyIndex() {}

  ConstNeighborhoodIteratorWithOnlyIndex(const ConstNeighborhoodIteratorWithOnlyIndex &);

  ConstNeighborhoodIteratorWithOnlyIndex(const SizeType & radius, const ImageType *ptr, const RegionType & region);

  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 ImageType * GetImagePointer(void) const
  {
    return m_ConstImage;
  }

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

  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;

  virtual void GoToBegin();

  virtual void GoToEnd();

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

  virtual bool IsAtBegin() const
  {
    return ( this->GetIndex() == m_BeginIndex );
  }

  virtual bool IsAtEnd() const;

  Self & operator++();

  Self & operator--();

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

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

  bool operator<(const Self & it) const;

  bool operator<=(const Self & it) const;

  bool operator>(const Self & it) const;

  bool operator>=(const Self & it) const;

  void SetLocation(const IndexType & position)
  {
    this->SetLoop(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(const NeighborIndexType n, OffsetType & internalIndex, OffsetType & offset ) const;

  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 SetBeginIndex(const IndexType & start)
  {
    m_BeginIndex = start;
  }

  virtual void SetEndIndex();

  IndexType m_BeginIndex;

  IndexType m_Bound;

  typename ImageType::ConstPointer m_ConstImage;

  IndexType m_EndIndex;

  IndexType m_Loop;

  RegionType m_Region;

  mutable bool m_InBounds[Dimension];

  mutable bool m_IsInBounds;

  mutable bool m_IsInBoundsValid;

  IndexType m_InnerBoundsLow;

  IndexType m_InnerBoundsHigh;

  bool m_NeedToUseBoundaryCondition;
};

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

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

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

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

#endif