freSpatialRegionOfInterestImageFilter.h

Go to the documentation of this file.

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

  Program:   F.R.E.E. - flexible registration evaluation engine
  Version:   v.1.0.0
  Date:      $Date: 2006/09/01 12:00:00 $
  Module:    $RCSfile: freSpatialRegionOfInterestImageFilter.h,v $
  Language:  C++



  Copyright (c) 2007 Ralf o Floca (Department of Medical Informatics,
  Institute for Medical Biometry and Informatics, University of Heidelberg,
  Germany). All rights reserved.
  See FREECopyright.txt or http://www.mi.med.uni-hd.de/free/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 __freSpatialRegionOfInterestImageFilter_h
#define __freSpatialRegionOfInterestImageFilter_h

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

namespace FREE
{

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

  itkNewMacro(Self);  

  itkTypeMacro(SpatialRegionOfInterestImageFilter, ImageToImageFilter);

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

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

  typedef itk::SpatialObject< TInputImage::ImageDimension >  SpatialObjectType;
  typedef typename SpatialObjectType::Pointer  SpatialObjectPointer;

  virtual void SetSpatialRegionOfInterest(SpatialObjectType* pROI);
  virtual SpatialObjectType* GetSpatialRegionOfInterest();

  itkSetMacro(OutsideValue, OutputImagePixelType);
  itkGetMacro(OutsideValue, OutputImagePixelType);

  itkSetMacro(CropByInput, bool);
  itkGetMacro(CropByInput, bool);

  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:
  SpatialRegionOfInterestImageFilter();
  ~SpatialRegionOfInterestImageFilter() {};
  void PrintSelf(std::ostream& os, itk::Indent indent) const;


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


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

  RegionType GenerateLargestSpatialRegion(const TInputImage* pInput);

private:
  SpatialRegionOfInterestImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
  SpatialObjectPointer  m_SpatialObject;
  OutputImagePixelType  m_OutsideValue;
  bool m_CropByInput;
};

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

---