itkCheckerBoardImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkCheckerBoardImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2008-10-13 18:54:27 $
  Version:   $Revision: 1.6 $

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

#include "itkImageToImageFilter.h"

namespace itk
{

template <class TImage>
class ITK_EXPORT CheckerBoardImageFilter:
    public ImageToImageFilter<TImage, TImage>
{
public:
  typedef CheckerBoardImageFilter            Self;
  typedef ImageToImageFilter<TImage,TImage>  Superclass;
  typedef SmartPointer<Self>                 Pointer;
  typedef SmartPointer<const Self>           ConstPointer;

  typedef TImage                                InputImageType;
  typedef TImage                                OutputImageType;
  typedef typename InputImageType::ConstPointer InputImageConstPointer;
  typedef typename OutputImageType::Pointer     OutputImagePointer;
  typedef typename OutputImageType::RegionType  ImageRegionType;

  itkNewMacro(Self);  

  itkTypeMacro(CheckerBoardImageFilter, ImageToImageFilter);

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

  typedef FixedArray< unsigned int, 
      ::itk::GetImageDimension<TImage>::ImageDimension >  PatternArrayType;

  void SetInput1( const TImage * image1);

  void SetInput2( const TImage * image2);

  itkSetMacro( CheckerPattern, PatternArrayType );
  itkGetConstReferenceMacro( CheckerPattern, PatternArrayType );

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

  void ThreadedGenerateData(const ImageRegionType& outputRegionForThread,
                            int threadId );

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

  PatternArrayType  m_CheckerPattern;
};

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