itkNeighborhoodIterator.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkNeighborhoodIterator.h,v $
  Language:  C++
  Date:      $Date: 2009-02-06 20:53:13 $
  Version:   $Revision: 1.50 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkNeighborhoodIterator_h
#define __itkNeighborhoodIterator_h

#include <vector>
#include <string.h>
#include <iostream>
#include "itkConstNeighborhoodIterator.h"

namespace itk {


template<class TImage, class TBoundaryCondition
                       = ZeroFluxNeumannBoundaryCondition<TImage> >
class ITK_EXPORT NeighborhoodIterator
  :  public ConstNeighborhoodIterator<TImage,TBoundaryCondition>
{
public:
  typedef NeighborhoodIterator                                 Self;
  typedef ConstNeighborhoodIterator<TImage,TBoundaryCondition> Superclass;

  typedef typename Superclass::InternalPixelType InternalPixelType;
  typedef typename Superclass::PixelType         PixelType;
  typedef typename Superclass::SizeType          SizeType;
  typedef typename Superclass::ImageType         ImageType;
  typedef typename Superclass::RegionType        RegionType;
  typedef typename Superclass::IndexType         IndexType;
  typedef typename Superclass::OffsetType        OffsetType;
  typedef typename OffsetType::OffsetValueType   OffsetValueType;
  typedef typename Superclass::RadiusType        RadiusType;
  typedef typename Superclass::NeighborhoodType  NeighborhoodType;
  typedef typename Superclass::Iterator          Iterator;
  typedef typename Superclass::ConstIterator     ConstIterator;
  typedef typename Superclass::ImageBoundaryConditionPointerType
                                                 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) { }

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

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

  virtual void SetCenterPixel(const PixelType &p)
  { this->m_NeighborhoodAccessorFunctor.Set(this->operator[]((this->Size())>>1), p); }

  virtual void SetNeighborhood(const NeighborhoodType &);

  virtual void SetPixel(const unsigned i, const PixelType &v,
                        bool  &status);

  virtual void SetPixel(const unsigned i, const PixelType &v);
  //  { *(this->operator[](i)) = v; }

  virtual void SetPixel(const OffsetType o, const PixelType &v)
  { this->SetPixel(this->GetNeighborhoodIndex(o), v); }
    //  { *(this->operator[](o)) = v; }

  virtual void SetNext(const unsigned axis, const unsigned i,
                            const PixelType &v)
  {   this->SetPixel(this->GetCenterNeighborhoodIndex()
                     + (i * this->GetStride(axis)), v); }

  
  virtual void SetNext(const unsigned axis, const PixelType &v)
    {   this->SetPixel(this->GetCenterNeighborhoodIndex()
                       + this->GetStride(axis), v); }

  virtual void SetPrevious(const unsigned axis, const unsigned i,
                                const PixelType &v)
    { this->SetPixel(this->GetCenterNeighborhoodIndex()
                     - (i * this->GetStride(axis)), v); }

  
  virtual void SetPrevious(const unsigned axis,
                                const PixelType &v)
    { this->SetPixel(this->GetCenterNeighborhoodIndex()
                     - this->GetStride(axis), v); }

};

} // namespace itk


#ifndef ITK_MANUAL_INSTANTIATION
#include "itkNeighborhoodIterator.txx"
#endif

#endif