itkKernelImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkKernelImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2008-08-12 12:08:09 $
  Version:   $Revision: 1.3 $

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

#include "itkBoxImageFilter.h"
#include "itkCastImageFilter.h"
#include "itkFlatStructuringElement.h"


namespace itk {

template<class TInputImage, class TOutputImage, class TKernel/*=Neighborhood<bool, TInputImage::ImageDimension>*/ >
class ITK_EXPORT KernelImageFilter : 
public BoxImageFilter<TInputImage, TOutputImage>
{
public:
  typedef KernelImageFilter                         Self;
  typedef BoxImageFilter<TInputImage,TOutputImage>  Superclass;
  typedef SmartPointer<Self>                        Pointer;
  typedef SmartPointer<const Self>                  ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(KernelImageFilter,
               BoxImageFilter);

  typedef TInputImage                               InputImageType;
  typedef typename TInputImage::RegionType          RegionType;
  typedef typename TInputImage::SizeType            SizeType;
  typedef typename TInputImage::IndexType           IndexType;
  typedef typename TInputImage::OffsetType          OffsetType;

  typedef typename TInputImage::PixelType           InputPixelType;
  
  typedef TOutputImage                              OutputImageType;
  typedef typename TOutputImage::PixelType          OutputPixelType;

  typedef TKernel KernelType;

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

  typedef FlatStructuringElement< itkGetStaticConstMacro(ImageDimension) >
                                                    FlatKernelType;

  typedef typename TInputImage::SizeType RadiusType;

  virtual void SetKernel( const KernelType& kernel );
  itkGetConstReferenceMacro(Kernel, KernelType);

  virtual void SetRadius( const RadiusType & radius );
  virtual void SetRadius( const unsigned long & radius )
    {
    // needed because of the overloading of the method
    Superclass::SetRadius( radius );
    }

protected:
  KernelImageFilter();
  ~KernelImageFilter() {};

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

  KernelType m_Kernel;

private:
  KernelImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

};

}

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

#endif