itkRegionOfInterestImageFilter.h

Go to the documentation of this file.

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

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

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

#include "itkImageToImageFilter.h"
#include "itkSmartPointer.h"

namespace itk
{

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

  itkNewMacro(Self);  

  itkTypeMacro(RegionOfInterestImageFilter, ImageToImageFilter);

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

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

  itkSetMacro(RegionOfInterest, RegionType);
  itkGetMacro(RegionOfInterest, RegionType);

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

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(SameDimensionCheck,
    (Concept::SameDimension<ImageDimension, OutputImageDimension>));
  itkConceptMacro(InputConvertibleToOutputCheck,
    (Concept::Convertible<InputImagePixelType, OutputImagePixelType>));

#endif

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


  virtual void GenerateInputRequestedRegion();
  virtual void EnlargeOutputRequestedRegion(DataObject *output);
  
  virtual void GenerateOutputInformation();


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

private:
  RegionOfInterestImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
  RegionType      m_RegionOfInterest;
};

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