itkTemporalDataObject.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 itkTemporalDataObject_h
#define itkTemporalDataObject_h
 
#include "itkDataObject.h"
#include "itkRingBuffer.h"
#include "itkTemporalRegion.h"
#include "ITKVideoCoreExport.h"
 
namespace itk
{
class TemporalDataObjectEnums
{
public:
  enum class TemporalUnit : uint8_t
  {
    Frame,
    RealTime,
    FrameAndRealTime
  };
};
// Define how to print enumeration
extern ITKVideoCore_EXPORT std::ostream &
                           operator<<(std::ostream & out, TemporalDataObjectEnums::TemporalUnit value);

class ITK_FORCE_EXPORT_MACRO(ITKVideoCore) TemporalDataObject : public DataObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(TemporalDataObject);

  using Self = TemporalDataObject;
  using Superclass = DataObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  using ConstWeakPointer = WeakPointer<const Self>;
 
  using BufferType = RingBuffer<DataObject>;
  using TemporalRegionType = TemporalRegion;
 
  using TemporalUnitEnum = TemporalDataObjectEnums::TemporalUnit;
  using TemporalUnitType = TemporalUnitEnum;
 
#if !defined(ITK_LEGACY_REMOVE)
  static constexpr TemporalUnitEnum Frame = TemporalUnitEnum::Frame;
  static constexpr TemporalUnitEnum RealTime = TemporalUnitEnum::RealTime;
  static constexpr TemporalUnitEnum FrameAndRealTime = TemporalUnitEnum::FrameAndRealTime;
#endif
 
  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(TemporalDataObject);

  virtual TemporalUnitType
  GetTemporalUnit() const;

  virtual void
  SetTemporalUnitToFrame();
  virtual void
  SetTemporalUnitToRealTime();
  virtual void
  SetTemporalUnitToFrameAndRealTime();

  SizeValueType
  GetNumberOfBuffers();
  void
  SetNumberOfBuffers(SizeValueType num);
 
  virtual void
  SetLargestPossibleTemporalRegion(const TemporalRegionType & region);
  virtual const TemporalRegionType &
  GetLargestPossibleTemporalRegion() const;
 
  virtual void
  SetBufferedTemporalRegion(const TemporalRegionType & region);
  virtual const TemporalRegionType &
  GetBufferedTemporalRegion() const;
  virtual void
  SetRequestedTemporalRegion(const TemporalRegionType & region);
  virtual const TemporalRegionType &
  GetRequestedTemporalRegion() const;

  virtual const TemporalRegionType
  GetUnbufferedRequestedTemporalRegion();
 
  void
  SetRequestedRegionToLargestPossibleRegion() override;
 
  bool
  RequestedRegionIsOutsideOfTheBufferedRegion() override;
 
  bool
  VerifyRequestedRegion() override;
 
  void
  CopyInformation(const DataObject *) override;
 
  void
  SetRequestedRegion(const DataObject *) override;
 
  void
  Graft(const DataObject *) override;
 
protected:
  TemporalDataObject();
  ~TemporalDataObject() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  BufferType::Pointer m_DataObjectBuffer{};

  TemporalRegionType m_LargestPossibleTemporalRegion{};
  TemporalRegionType m_RequestedTemporalRegion{};
  TemporalRegionType m_BufferedTemporalRegion{};
 
  TemporalUnitEnum m_TemporalUnit{ TemporalUnitEnum::Frame };
}; // end class TemporalDataObject
} // end namespace itk
 
#endif