itkConstantBoundaryCondition.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkConstantBoundaryCondition.h,v $
  Language:  C++
  Date:      $Date: 2006-04-20 16:59:33 $
  Version:   $Revision: 1.19 $

  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 __itkConstantBoundaryCondition_h
#define __itkConstantBoundaryCondition_h
#include "itkNeighborhood.h"
#include "itkNumericTraits.h"
#include "itkImageBoundaryCondition.h"

namespace itk
{

template<class TImage>
class ITK_EXPORT ConstantBoundaryCondition
  : public ImageBoundaryCondition<TImage>
{
public:
  typedef ConstantBoundaryCondition      Self;
  typedef ImageBoundaryCondition<TImage> Superclass;

  typedef typename Superclass::PixelType        PixelType;
  typedef typename Superclass::PixelPointerType PixelPointerType;
  typedef typename Superclass::IndexType        IndexType;
  typedef typename Superclass::OffsetType       OffsetType;
  typedef typename Superclass::NeighborhoodType NeighborhoodType;

  typedef typename Superclass::NeighborhoodAccessorFunctorType 
                                 NeighborhoodAccessorFunctorType;

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

  ConstantBoundaryCondition()
    { m_Constant = NumericTraits<PixelType>::Zero; }

  virtual PixelType operator()(const OffsetType&,
                               const OffsetType&,
                               const NeighborhoodType *) const
    { return m_Constant; }

  virtual PixelType operator()(
      const OffsetType& ,
      const OffsetType& ,
      const NeighborhoodType *,
      const NeighborhoodAccessorFunctorType & ) const
    { return m_Constant; }

  void SetConstant(const PixelType &c)
    {  m_Constant = c; }

  const PixelType &GetConstant() const
    {  return m_Constant;  }

  bool RequiresCompleteNeighborhood() { return false; }

private:
  PixelType m_Constant;
};

} // end namespace itk

#endif