itkImageDuplicator.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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.
 *
 *=========================================================================*/
#ifndef itkImageDuplicator_h
#define itkImageDuplicator_h
 
#include "itkObject.h"
#include "itkImage.h"
 
namespace itk
{
template <typename TInputImage>
class ITK_TEMPLATE_EXPORT ImageDuplicator : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ImageDuplicator);

  using Self = ImageDuplicator;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ImageDuplicator);

  using ImageType = TInputImage;
  using ImagePointer = typename TInputImage::Pointer;
  using ImageConstPointer = typename TInputImage::ConstPointer;
  using PixelType = typename TInputImage::PixelType;
  using IndexType = typename TInputImage::IndexType;
 
  static constexpr unsigned int ImageDimension = ImageType::ImageDimension;
 
  itkSetConstObjectMacro(InputImage, ImageType);

  // NOTE:  The m_DuplicateImage is only
  //       exposed via the Source generation interface
  //       by the GetOutput() method that mimics
  //       a process object.
  virtual const ImageType *
  GetOutput() const
  {
    return this->m_DuplicateImage.GetPointer();
  }
  virtual ImageType *
  GetOutput()
  {
    return this->m_DuplicateImage.GetPointer();
  }

#if !defined(ITK_LEGACY_REMOVE)
  // This interface was exposed in ITKv4 when the itkGetModifiableObjectMacro was used
  virtual ImageType *
  GetModifiableOutput()
  {
    return this->m_DuplicateImage.GetPointer();
  }
#endif

  void
  Update();
 
protected:
  ImageDuplicator() = default;
  ~ImageDuplicator() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  ImageConstPointer m_InputImage{};
  ImagePointer      m_DuplicateImage{};
  ModifiedTimeType  m_InternalImageTime{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkImageDuplicator.hxx"
#endif
 
#endif /* itkImageDuplicator_h */