itkImageSource.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkImageSource.h,v $
  Language:  C++
  Date:      $Date: 2009-03-12 01:11:08 $
  Version:   $Revision: 1.59 $

  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;

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

  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 ) ITK_NO_RETURN;


  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

};

} // end namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_ImageSource(_, EXPORT, x, y) namespace itk { \
  _(1(class EXPORT ImageSource< ITK_TEMPLATE_1 x >)) \
  namespace Templates { typedef ImageSource< ITK_TEMPLATE_1 x > ImageSource##y; } \
  }

#if ITK_TEMPLATE_EXPLICIT
# include "Templates/itkImageSource+-.h"
#endif

#if ITK_TEMPLATE_TXX
# include "itkImageSource.txx"
#endif

#endif