itkImageBoundaryCondition.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkImageBoundaryCondition.h,v $
  Language:  C++
  Date:      $Date: 2008-10-17 01:41:59 $
  Version:   $Revision: 1.14 $

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

#include "itkIndex.h"
#include "itkOffset.h"
#include "itkNeighborhood.h"

namespace itk
{

template <class TImageType>
class ITK_EXPORT ImageBoundaryCondition
{
public:

  itkStaticConstMacro(ImageDimension, unsigned int,
                      TImageType::ImageDimension);

  typedef ImageBoundaryCondition           Self;

  typedef typename TImageType::PixelType                    PixelType;
  typedef typename TImageType::InternalPixelType *          PixelPointerType;
  typedef Index<itkGetStaticConstMacro(ImageDimension)>     IndexType;
  typedef Offset<itkGetStaticConstMacro(ImageDimension)>    OffsetType;

  typedef Neighborhood<PixelPointerType,
                      itkGetStaticConstMacro(ImageDimension)> NeighborhoodType;

  typedef typename TImageType::NeighborhoodAccessorFunctorType
                                 NeighborhoodAccessorFunctorType;

  ImageBoundaryCondition() {}

  virtual PixelType operator()(const OffsetType& point_index,
                               const OffsetType &boundary_offset,
                               const NeighborhoodType *data) const = 0;

  virtual PixelType operator()(
      const OffsetType& point_index,
      const OffsetType& boundary_offset,
      const NeighborhoodType *data,
      const NeighborhoodAccessorFunctorType &neighborhoodAccessorFunctor) const = 0;

  virtual ~ImageBoundaryCondition() {}

  virtual bool RequiresCompleteNeighborhood() { return true; }
};

}// end namespace itk


#endif