itkStreamingProcessObject.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 itkStreamingProcessObject_h
#define itkStreamingProcessObject_h
 
#include "itkProcessObject.h"
 
namespace itk
{

class ITKCommon_EXPORT StreamingProcessObject : public ProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(StreamingProcessObject);

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

  itkOverrideGetNameOfClassMacro(StreamingProcessObject);

  void
  PropagateRequestedRegion(DataObject * output) override;
 
  void
  GenerateData() override;

  void
  UpdateOutputData(DataObject * output) override;

  virtual int
  GetCurrentRequestNumber() const;
 
  void
  ResetPipeline() override;
 
protected:
  StreamingProcessObject();
  ~StreamingProcessObject() override;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  virtual unsigned int
  GetNumberOfInputRequestedRegions() = 0;
 

  virtual void
  GenerateNthInputRequestedRegion(unsigned int inputRequestedRegionNumber) = 0;

  virtual void
  StreamedGenerateData(unsigned int inputRequestedRegionNumber) = 0;

  virtual void
  BeforeStreamedGenerateData();

  virtual void
  AfterStreamedGenerateData();
 
private:
  int m_CurrentRequestNumber{ -1 };
};
 
} // end namespace itk
 
#endif // itkStreamingProcessObject_h