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"
#include "itkImageSourceCommon.h"

namespace itk
{

template< typename TOutputImage >
class ITK_TEMPLATE_EXPORT ImageSource
  : public ProcessObject, private ImageSourceCommon
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(ImageSource);

  using Self = ImageSource;
  using Superclass = ProcessObject;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  using DataObjectPointer = DataObject::Pointer;

  using DataObjectIdentifierType = Superclass::DataObjectIdentifierType;
  using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType;

  itkTypeMacro(ImageSource, ProcessObject);

  using OutputImageType = TOutputImage;
  using OutputImagePointer = typename OutputImageType::Pointer;
  using OutputImageRegionType = typename OutputImageType::RegionType;
  using OutputImagePixelType = typename OutputImageType::PixelType;

  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;

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

  ProcessObject::DataObjectPointer MakeOutput(ProcessObject::DataObjectPointerArraySizeType idx) override;
  ProcessObject::DataObjectPointer MakeOutput(const ProcessObject::DataObjectIdentifierType &) override;

protected:
  ImageSource();
  ~ImageSource() override = default;

  void GenerateData() override;

  void ClassicMultiThread(ThreadFunctionType callbackFunction);

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

  virtual void AllocateOutputs();

  virtual void BeforeThreadedGenerateData() {}

  virtual void AfterThreadedGenerateData() {}

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

  virtual const ImageRegionSplitterBase* GetImageRegionSplitter() const;

  virtual
  unsigned int SplitRequestedRegion(unsigned int i, unsigned int pieces, OutputImageRegionType & splitRegion);

  static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback(void *arg);

  struct ThreadStruct
  {
    Pointer Filter;
  };

  void PrintSelf(std::ostream & os, Indent indent) const override;

  itkGetConstMacro(DynamicMultiThreading, bool);
  itkSetMacro(DynamicMultiThreading, bool);
  itkBooleanMacro(DynamicMultiThreading);

  bool m_DynamicMultiThreading;
};
} // end namespace itk

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

#endif