itkNeighborhood.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkNeighborhood.h,v $
  Language:  C++
  Date:      $Date: 2009-02-07 23:09:24 $
  Version:   $Revision: 1.46 $

  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 __itkNeighborhood_h
#define __itkNeighborhood_h

#include <iostream>
#include "itkNeighborhoodAllocator.h"
#include "itkSize.h"
#include "itkIndent.h"
#include "itkSliceIterator.h"
#include "vnl/vnl_vector.h"
#include "itkOffset.h"
#include <vector>

namespace itk {

template<class TPixel, unsigned int VDimension = 2,
         class TAllocator = NeighborhoodAllocator<TPixel> >
class ITK_EXPORT Neighborhood
{
public:
  typedef Neighborhood Self;

  typedef TAllocator AllocatorType;

  itkStaticConstMacro(NeighborhoodDimension, unsigned int, VDimension);

  typedef TPixel PixelType;

  typedef typename AllocatorType::iterator       Iterator;
  typedef typename AllocatorType::const_iterator ConstIterator;

  typedef ::itk::Size<VDimension>          SizeType;
  typedef typename SizeType::SizeValueType SizeValueType;

  typedef ::itk::Size<VDimension> RadiusType;

  typedef Offset<VDimension> OffsetType;

  typedef SliceIterator<TPixel, Self> SliceIteratorType;

  Neighborhood() { m_Radius.Fill(0); m_Size.Fill(0);  }

  virtual ~Neighborhood() {}

  Neighborhood(const Self& other);

  Self &operator=(const Self& other);

  bool
  operator==(const Self& other) const
    {
    return (m_Radius == other.m_Radius &&
            m_Size   == other.m_Size &&
            m_DataBuffer == other.m_DataBuffer);
    }

  bool operator!=(const Self& other) const
    {
    return (m_Radius != other.m_Radius ||
            m_Size   != other.m_Size ||
            m_DataBuffer != other.m_DataBuffer);
    }

  const SizeType GetRadius() const
    { return m_Radius; }

  unsigned long GetRadius(const unsigned long n) const
    { return m_Radius[n]; }

  unsigned long GetSize(const unsigned long n) const
    { return m_Size[n]; }

  SizeType GetSize() const
    { return m_Size; }

  unsigned GetStride(const unsigned axis) const
  {     return m_StrideTable[axis];  }

  Iterator End()
    { return m_DataBuffer.end(); }
  Iterator Begin()
    { return m_DataBuffer.begin(); }
  ConstIterator End() const
    { return m_DataBuffer.end(); }
  ConstIterator Begin() const
    { return m_DataBuffer.begin(); }

  unsigned int Size() const
    { return m_DataBuffer.size(); }

  TPixel &operator[](unsigned int i)
    { return m_DataBuffer[i]; }
  const TPixel &operator[](unsigned int i) const
    { return m_DataBuffer[i]; }
  TPixel &GetElement(unsigned int i)
    { return m_DataBuffer[i]; }

  TPixel GetCenterValue() const
    { return (this->operator[]((this->Size())>>1)); }

  void SetRadius(const SizeType &);

  void SetRadius(const unsigned long *rad)
    {
    SizeType s;
    memcpy(s.m_Size, rad, sizeof(unsigned long) * VDimension);
    this->SetRadius(s);
    }

  void SetRadius(const unsigned long);

  void Print(std::ostream& os) const
    { this->PrintSelf(os, Indent(0));  }

  AllocatorType &GetBufferReference()
    { return m_DataBuffer; }
  const AllocatorType &GetBufferReference() const
    { return m_DataBuffer; }

  TPixel &operator[](const OffsetType &o)
    { return this->operator[](this->GetNeighborhoodIndex(o)); }
  const TPixel &operator[](const OffsetType &o) const
    { return this->operator[](this->GetNeighborhoodIndex(o)); }

  OffsetType GetOffset(unsigned int i) const
    { return m_OffsetTable[i]; }

  virtual unsigned int GetNeighborhoodIndex(const OffsetType &) const;

  unsigned int GetCenterNeighborhoodIndex() const
    {
    return  static_cast<unsigned int>(this->Size()/2);
    }

  std::slice GetSlice(unsigned int) const;

protected:
  void SetSize()
    {
    for (unsigned int i=0; i<VDimension; ++i)
      {
      m_Size[i] = m_Radius[i]*2+1;
      }
    }

  virtual void Allocate(unsigned int i)
    { m_DataBuffer.set_size(i); }

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

  virtual void ComputeNeighborhoodStrideTable();

  virtual void ComputeNeighborhoodOffsetTable();

private:
  SizeType m_Radius;

  SizeType m_Size;

  AllocatorType m_DataBuffer;

  unsigned int m_StrideTable[VDimension];

  std::vector<OffsetType> m_OffsetTable;

};

template <class TPixel, unsigned int VDimension, class TContainer>
std::ostream & operator<<(std::ostream &os, const Neighborhood<TPixel,VDimension,TContainer> &neighborhood)
{
  os << "Neighborhood:" << std::endl;
  os << "    Radius:" << neighborhood.GetRadius() << std::endl;
  os << "    Size:" << neighborhood.GetSize() << std::endl;
  os << "    DataBuffer:" << neighborhood.GetBufferReference() << std::endl;

  return os;
}

} // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_Neighborhood(_, EXPORT, x, y) namespace itk { \
  _(2(class EXPORT Neighborhood< ITK_TEMPLATE_2 x >)) \
  namespace Templates { typedef Neighborhood< ITK_TEMPLATE_2 x > \
                                                  Neighborhood##y; } \
  }

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

#if ITK_TEMPLATE_TXX
# include "itkNeighborhood.txx"
#endif

/*
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkNeighborhood.txx"
#endif
*/

#endif