itkTemporalProcessObject.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 itkTemporalProcessObject_h
#define itkTemporalProcessObject_h
 
#include "itkProcessObject.h"
#include "itkTemporalRegion.h"
#include "ITKVideoCoreExport.h"
 
namespace itk
{
 
// Forward reference because of circular dependencies
class ITK_FORWARD_EXPORT TemporalDataObject;

class ITKVideoCore_EXPORT TemporalProcessObject : public ProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(TemporalProcessObject);
 
  /*-TYPEDEFS----------------------------------------------------------------*/

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

  itkOverrideGetNameOfClassMacro(TemporalProcessObject);
 
  /*-PUBLIC METHODS----------------------------------------------------------*/

  void
  EnlargeOutputRequestedRegion(DataObject * output) override;
 
  void
  GenerateOutputRequestedRegion(DataObject * output) override;
 
  void
  GenerateInputRequestedRegion() override;

  itkGetMacro(UnitInputNumberOfFrames, SizeValueType);

  itkGetMacro(UnitOutputNumberOfFrames, SizeValueType);

  void
  UpdateOutputInformation() override;

  void
  UpdateOutputData(DataObject * output) override;

  void
  GenerateData() override;

  virtual void
  TemporalStreamingGenerateData();
 
protected:
  /*-PROTECTED METHODS-------------------------------------------------------*/

  TemporalProcessObject();

  ~TemporalProcessObject() override = default;

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

  virtual void
  EnlargeOutputRequestedTemporalRegion(TemporalDataObject * output);

  virtual void
  GenerateOutputRequestedTemporalRegion(TemporalDataObject * output);

  virtual void
  GenerateInputRequestedTemporalRegion();

  virtual std::vector<TemporalRegion>
  SplitRequestedTemporalRegion();

  virtual void
  BeforeTemporalStreamingGenerateData()
  {}

  virtual void
  AfterTemporalStreamingGenerateData()
  {}

  virtual TemporalRegion
  GenerateDefaultLargestPossibleTemporalRegion();
 
  itkSetMacro(UnitInputNumberOfFrames, SizeValueType);
  itkSetMacro(UnitOutputNumberOfFrames, SizeValueType);
  itkSetMacro(FrameSkipPerOutput, OffsetValueType);
  itkSetMacro(InputStencilCurrentFrameIndex, SizeValueType);
  itkGetMacro(InputStencilCurrentFrameIndex, SizeValueType);
 
  /*-PROTECTED MEMBERS-------------------------------------------------------*/

  SizeValueType m_UnitInputNumberOfFrames{ 1 };
  SizeValueType m_UnitOutputNumberOfFrames{ 1 };

  OffsetValueType m_FrameSkipPerOutput{ 1 };

  SizeValueType m_InputStencilCurrentFrameIndex{ 0 };
}; // end class TemporalProcessObject
 
} // end namespace itk
 
#endif