itkImageSource.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkImageSource.h,v $
  Language:  C++
  Date:      $Date: 2005/12/03 22:15:26 $
  Version:   $Revision: 1.50.10.1 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

  Portions of this code are covered under the VTK copyright.
  See VTKCopyright.txt or http://www.kitware.com/VTKCopyright.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 __itkImageSource_h
#define __itkImageSource_h

#include "itkProcessObject.h"
#include "itkImage.h"

namespace itk
{

template <class TOutputImage>
class ITK_EXPORT ImageSource : public ProcessObject
{
public:
  typedef ImageSource         Self;
  typedef ProcessObject  Superclass;
  typedef SmartPointer<Self>  Pointer;
  typedef SmartPointer<const Self>  ConstPointer;
  
  typedef DataObject::Pointer DataObjectPointer;

  itkTypeMacro(ImageSource,ProcessObject);

  typedef TOutputImage OutputImageType;
  typedef typename OutputImageType::Pointer OutputImagePointer;
  typedef typename OutputImageType::RegionType OutputImageRegionType;
  typedef typename OutputImageType::PixelType OutputImagePixelType;

  OutputImageType * GetOutput(void);
  OutputImageType * GetOutput(unsigned int idx);
  
  virtual void GraftOutput(DataObject *output);

  virtual void GraftNthOutput(unsigned int idx, DataObject *output);

  virtual DataObjectPointer MakeOutput(unsigned int idx);
  
protected:
  ImageSource();
  virtual ~ImageSource() {}
  
  virtual void GenerateData();

  virtual
  void ThreadedGenerateData(const OutputImageRegionType& outputRegionForThread,
                            int threadId );


  virtual void AllocateOutputs();

  virtual void BeforeThreadedGenerateData() {};
  
  virtual void AfterThreadedGenerateData() {};
  
  virtual
  int SplitRequestedRegion(int i, int num, OutputImageRegionType& splitRegion);

  static ITK_THREAD_RETURN_TYPE ThreaderCallback( void *arg );

  struct ThreadStruct
  {
   Pointer Filter;
  };
  
private:
  ImageSource(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

};
#ifdef ITK_EXPLICIT_INSTANTIATION
   extern template class ImageSource<Image<float         ,2> >;
   extern template class ImageSource<Image<double        ,2> >;
   extern template class ImageSource<Image<unsigned char ,2> >;
   extern template class ImageSource<Image<unsigned short,2> >;
   extern template class ImageSource<Image<unsigned int  ,2> >;
   extern template class ImageSource<Image<signed char   ,2> >;
   extern template class ImageSource<Image<signed short  ,2> >;
   extern template class ImageSource<Image<signed int    ,2> >;
   extern template class ImageSource<Image<float         ,3> >;
   extern template class ImageSource<Image<double        ,3> >;
   extern template class ImageSource<Image<unsigned char ,3> >;
   extern template class ImageSource<Image<unsigned short,3> >;
   extern template class ImageSource<Image<unsigned int  ,3> >;
   extern template class ImageSource<Image<signed char   ,3> >;
   extern template class ImageSource<Image<signed short  ,3> >;
   extern template class ImageSource<Image<signed int    ,3> >;
#endif

} // end namespace itk

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

#endif
  

---