itkTemporalProcessObject.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.
 *
 *=========================================================================*/
#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:

  /*-TYPEDEFS----------------------------------------------------------------*/

  typedef TemporalProcessObject      Self;
  typedef ProcessObject              Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkTypeMacro(TemporalProcessObject, ProcessObject);

  /*-PUBLIC METHODS----------------------------------------------------------*/

  virtual void EnlargeOutputRequestedRegion(DataObject* output) ITK_OVERRIDE;

  virtual void GenerateOutputRequestedRegion(DataObject* output) ITK_OVERRIDE;

  virtual void GenerateInputRequestedRegion() ITK_OVERRIDE;

  itkGetMacro(UnitInputNumberOfFrames, SizeValueType);

  itkGetMacro(UnitOutputNumberOfFrames, SizeValueType);

  virtual void UpdateOutputInformation() ITK_OVERRIDE;

  virtual void UpdateOutputData(DataObject* output) ITK_OVERRIDE;

  virtual void GenerateData() ITK_OVERRIDE;

  virtual void TemporalStreamingGenerateData();

protected:

  /*-PROTECTED METHODS-------------------------------------------------------*/

  TemporalProcessObject();

  virtual ~TemporalProcessObject() ITK_OVERRIDE {}

  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_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;
  SizeValueType  m_UnitOutputNumberOfFrames;

  OffsetValueType  m_FrameSkipPerOutput;

  SizeValueType  m_InputStencilCurrentFrameIndex;

private:
  ITK_DISALLOW_COPY_AND_ASSIGN(TemporalProcessObject);

};  // end class TemporalProcessObject

} // end namespace itk

#endif