itkPadImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkPadImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2008-10-17 16:30:46 $
  Version:   $Revision: 1.15 $

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

#include "itkImageToImageFilter.h"
#include "itkSize.h"

namespace itk
{

template <class TInputImage, class TOutputImage>
class ITK_EXPORT PadImageFilter:
    public ImageToImageFilter<TInputImage,TOutputImage>
{
public:
  typedef PadImageFilter                                Self;
  typedef ImageToImageFilter<TInputImage,TOutputImage>  Superclass;
  typedef SmartPointer<Self>                            Pointer;
  typedef SmartPointer<const Self>                      ConstPointer;

  itkNewMacro(Self);  

  typedef typename TOutputImage::RegionType OutputImageRegionType;
  typedef typename TInputImage::RegionType  InputImageRegionType;

  typedef typename TOutputImage::PixelType OutputImagePixelType;
  typedef typename TInputImage::PixelType  InputImagePixelType;

  typedef typename TOutputImage::IndexType OutputImageIndexType;
  typedef typename TInputImage::IndexType  InputImageIndexType;
  typedef typename TOutputImage::SizeType  OutputImageSizeType;
  typedef typename TInputImage::SizeType   InputImageSizeType;

  itkTypeMacro(PadImageFilter, ImageToImageFilter);

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

  itkSetVectorMacro(PadLowerBound, const unsigned long, ImageDimension);
  itkSetVectorMacro(PadUpperBound, const unsigned long, ImageDimension);
  itkGetVectorMacro(PadLowerBound, const unsigned long, ImageDimension);
  itkGetVectorMacro(PadUpperBound, const unsigned long, ImageDimension);

  
  void SetPadLowerBound(const InputImageSizeType & bound)
    {
    this->SetPadLowerBound( bound.m_Size );
    }
    
  void SetPadUpperBound(const InputImageSizeType & bound)
    {
    this->SetPadUpperBound( bound.m_Size );
    }
    
  void SetPadBound(const InputImageSizeType & bound)
    {
    this->SetPadLowerBound( bound );
    this->SetPadUpperBound( bound );
    }

  virtual void GenerateOutputInformation();

  virtual void GenerateInputRequestedRegion();

protected:
  PadImageFilter();
  ~PadImageFilter() {};
  void PrintSelf(std::ostream& os, Indent indent) const;

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

  unsigned long m_PadLowerBound[ImageDimension];
  unsigned long m_PadUpperBound[ImageDimension];
};

  
} // end namespace itk
  
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkPadImageFilter.txx"
#endif
  
#endif