itkImageSink.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 itkImageSink_h
#define itkImageSink_h
 
#include "itkStreamingProcessObject.h"
#include "itkImage.h"
#include "itkImageRegionSplitterBase.h"
#include "itkImageRegionSplitterSlowDimension.h"
#include "itkImageToImageFilterCommon.h"
 
namespace itk
{

template <typename TInputImage>
class ImageSink
  : public StreamingProcessObject
  , private ImageToImageFilterCommon
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ImageSink);

  using Self = ImageSink;
  using Superclass = StreamingProcessObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(ImageSink);

  using DataObjectPointer = DataObject::Pointer;

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

  using SplitterType = ImageRegionSplitterBase;
  using RegionSplitterPointer = typename SplitterType::Pointer;
 
  using typename Superclass::DataObjectIdentifierType;

  static constexpr unsigned int InputImageDimension = InputImageType::ImageDimension;
 
 
  using Superclass::SetInput;
  virtual void
  SetInput(const InputImageType * input);
 
  virtual const InputImageType *
  GetInput() const;
 
  virtual const InputImageType *
  GetInput(unsigned int idx) const;
 
  virtual const InputImageType *
  GetInput(const DataObjectIdentifierType & key) const;
 
  void
  Update() override;
 
  void
  UpdateLargestPossibleRegion() override;

  itkSetMacro(CoordinateTolerance, double);
  itkGetConstMacro(CoordinateTolerance, double);

  itkSetMacro(DirectionTolerance, double);
  itkGetConstMacro(DirectionTolerance, double);

  using ImageToImageFilterCommon::SetGlobalDefaultDirectionTolerance;
  using ImageToImageFilterCommon::GetGlobalDefaultDirectionTolerance;
 

  using ImageToImageFilterCommon::SetGlobalDefaultCoordinateTolerance;
  using ImageToImageFilterCommon::GetGlobalDefaultCoordinateTolerance;
 
protected:
  ImageSink();
  ~ImageSink() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  unsigned int
  GetNumberOfInputRequestedRegions() override;
 
  void
  GenerateNthInputRequestedRegion(unsigned int inputRequestedRegionNumber) override;
 
  virtual void
  AllocateOutputs()
  {}
 
  void
  VerifyInputInformation() const override;
 
  void
  BeforeStreamedGenerateData() override
  {
    this->AllocateOutputs();
  }
 
  void
  StreamedGenerateData(unsigned int inputRequestedRegionNumber) override;
 
  virtual void
  ThreadedStreamedGenerateData(const InputImageRegionType & inputRegionForChunk) = 0;
 

  itkSetMacro(NumberOfStreamDivisions, unsigned int);

  itkGetConstMacro(NumberOfStreamDivisions, unsigned int);

  itkSetObjectMacro(RegionSplitter, SplitterType);
  itkGetModifiableObjectMacro(RegionSplitter, SplitterType);
 
 
private:
  unsigned int          m_NumberOfStreamDivisions{ 1 };
  RegionSplitterPointer m_RegionSplitter{};
  InputImageRegionType  m_CurrentInputRegion{};

  double m_CoordinateTolerance{ Self::GetGlobalDefaultCoordinateTolerance() };
  double m_DirectionTolerance{ Self::GetGlobalDefaultDirectionTolerance() };
};

 
} // namespace itk
 
#include "itkImageSink.hxx"
 
#endif // itkImageSink_h