itkImageTransformer.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 itkImageTransformer_h
#define itkImageTransformer_h

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

namespace itk
{
template< typename TInputImage >
class ITK_TEMPLATE_EXPORT ImageTransformer:public ProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(ImageTransformer);

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

  using DataObjectPointer = DataObject::Pointer;

  itkTypeMacro(ImageTransformer, ProcessObject);

  using InputImageType = TInputImage;
  using InputImagePointer = typename InputImageType::Pointer;
  using InputImageRegionType = typename InputImageType::RegionType;
  using InputImagePixelType = typename InputImageType::PixelType;

  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;

  using Superclass::SetInput;
  virtual void SetInput(const InputImageType *image);
  virtual void SetInput(unsigned int, const TInputImage *image);
  const InputImageType * GetInput() const;
  InputImageType * GetInput();
  const InputImageType * GetInput(unsigned int idx) const;

  virtual void PushBackInput(const InputImageType *image);
  void PopBackInput() override;
  virtual void PushFrontInput(const InputImageType *image);
  void PopFrontInput() override;

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

  void GenerateInputRequestedRegion() override;

  void GenerateData() override;

  virtual
  void ThreadedGenerateData(const InputImageRegionType & inputRegionForThread,
                            ThreadIdType threadId);

  void ClassicMultiThread(ThreadFunctionType callbackFunction);

  virtual void AllocateOutputs();

  virtual void BeforeThreadedGenerateData() {}

  virtual void AfterThreadedGenerateData() {}

  virtual
  unsigned int SplitRequestedRegion(unsigned int i, unsigned int num, InputImageRegionType & splitRegion);

  static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback(void *arg);

  void PushBackInput(const DataObject *input) override
  { Superclass::PushBackInput(input); }
  void PushFrontInput(const DataObject *input) override
  { Superclass::PushFrontInput(input); }

  struct ThreadStruct {
    Pointer Filter;
  };
};
} // end namespace itk

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

#endif