itkImageSource.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  Portions of this file are subject to the VTK Toolkit Version 3 copyright.
 *
 *  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 *
 *  For complete copyright, license and disclaimer of warranty information
 *  please refer to the NOTICE file at the top of the ITK source tree.
 *
 *=========================================================================*/
#ifndef __itkImageSource_h
#define __itkImageSource_h

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

namespace itk
{

struct ITKCommon_EXPORT ImageSourceCommon
{
  static  const ImageRegionSplitterBase*  GetGlobalDefaultSplitter(void);
};

template< class TOutputImage >
class ITK_EXPORT ImageSource
  : public ProcessObject, private ImageSourceCommon
{
public:
  typedef ImageSource                Self;
  typedef ProcessObject              Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  typedef DataObject::Pointer DataObjectPointer;

  typedef Superclass::DataObjectIdentifierType       DataObjectIdentifierType;
  typedef Superclass::DataObjectPointerArraySizeType DataObjectPointerArraySizeType;

  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);
  const OutputImageType * GetOutput(void) const;

  OutputImageType * GetOutput(unsigned int idx);

  virtual void GraftOutput(DataObject *output);

  virtual void GraftOutput(const DataObjectIdentifierType & key, DataObject *output);

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

  using Superclass::MakeOutput;
  virtual ProcessObject::DataObjectPointer MakeOutput(ProcessObject::DataObjectPointerArraySizeType idx);

protected:
  ImageSource();
  virtual ~ImageSource() {}

  virtual void GenerateData();

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

  virtual void AllocateOutputs();

  virtual void BeforeThreadedGenerateData() {}

  virtual void AfterThreadedGenerateData() {}

  static const ImageRegionSplitterBase* GetGlobalDefaultSplitter()
  {
    return ImageSourceCommon::GetGlobalDefaultSplitter();
  }

  virtual const ImageRegionSplitterBase* GetImageRegionSplitter(void) const;

  virtual
  unsigned int SplitRequestedRegion(unsigned int i, unsigned 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

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

#endif