itkTemporalRegion.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 itkTemporalRegion_h
#define itkTemporalRegion_h
 
#include "itkRegion.h"
#include "itkRealTimeStamp.h"
#include "itkRealTimeInterval.h"
#include "itkNumericTraits.h"
#include <climits>
#include "ITKVideoCoreExport.h"

#define ITK_INFINITE_FRAME_DURATION itk::NumericTraits<itk::SizeValueType>::max()
#define ITK_INFINITE_REAL_DURATION RealTimeInterval(ITK_INFINITE_FRAME_DURATION, 0)
 
namespace itk
{
class ITKVideoCore_EXPORT TemporalRegion : public Region
{
public:

  using Self = TemporalRegion;
  using Superclass = Region;
 
  itkOverrideGetNameOfClassMacro(TemporalRegion);

  using FrameOffsetType = itk::SizeValueType;

  void
  SetRealStart(const RealTimeStamp s);
  RealTimeStamp
  GetRealStart() const;

  void
  SetRealDuration(const RealTimeInterval d);
  RealTimeInterval
  GetRealDuration() const;

  void
  SetFrameStart(const FrameOffsetType s);
  FrameOffsetType
  GetFrameStart() const;

  void
  SetFrameDuration(const FrameOffsetType d);
  FrameOffsetType
  GetFrameDuration() const;

  RegionEnum
  GetRegionType() const override;

  TemporalRegion();

  ~TemporalRegion() override;

  virtual bool
  IsEqualInFrames(const Self & region) const;

  bool
  IsEqualInRealTime(const Self & region) const;

  bool
  operator==(const Self & region) const;
 
  ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(Self);
 
protected:
  void
  PrintSelf(std::ostream & os, Indent indent) const override;


  RealTimeStamp m_RealStart{};

  RealTimeInterval m_RealDuration{};

  FrameOffsetType m_FrameStart{ 0 };

  FrameOffsetType m_FrameDuration{ 0 };
 
}; // end class TemporalRegion

ITKVideoCore_EXPORT std::ostream &
                    operator<<(std::ostream & os, const TemporalRegion & region);
 
} // end namespace itk
 
#endif