ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::TemporalRegion Class Reference

#include <itkTemporalRegion.h>

Detailed Description

Region subclass that holds a region in time.

A temporal region is represented using a starting point and a duration. Here time can be measured both in frame numbers or real time (or both).

Definition at line 43 of file itkTemporalRegion.h.

+ Inheritance diagram for itk::TemporalRegion:
+ Collaboration diagram for itk::TemporalRegion:

Public Types

using FrameOffsetType = itk::SizeValueType
 
using Self = TemporalRegion
 
using Superclass = Region
 
- Public Types inherited from itk::Region
using RegionEnum = ObjectEnums::RegionEnum
 
using Self = Region
 

Public Member Functions

RegionEnum GetRegionType () const override
 
virtual bool IsEqualInFrames (const Self &region) const
 
bool IsEqualInRealTime (const Self &region) const
 
 ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)
 
 itkOverrideGetNameOfClassMacro (TemporalRegion)
 
bool operator== (const Self &region) const
 
 TemporalRegion ()
 
 ~TemporalRegion () override
 
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
 
- Public Member Functions inherited from itk::Region
 itkVirtualGetNameOfClassMacro (Region)
 
virtual void Print (std::ostream &os, Indent indent=0) const
 
 Region ()=default
 
virtual ~Region ()=default
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::Region
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 

Protected Attributes

FrameOffsetType m_FrameDuration { 0 }
 
FrameOffsetType m_FrameStart { 0 }
 
RealTimeInterval m_RealDuration {}
 
RealTimeStamp m_RealStart {}
 

Member Typedef Documentation

◆ FrameOffsetType

Typedef for frame offsets

Definition at line 54 of file itkTemporalRegion.h.

◆ Self

Standard class type aliases

Definition at line 48 of file itkTemporalRegion.h.

◆ Superclass

Definition at line 49 of file itkTemporalRegion.h.

Constructor & Destructor Documentation

◆ TemporalRegion()

itk::TemporalRegion::TemporalRegion ( )

Constructor

◆ ~TemporalRegion()

itk::TemporalRegion::~TemporalRegion ( )
override

Destructor

Member Function Documentation

◆ GetFrameDuration()

FrameOffsetType itk::TemporalRegion::GetFrameDuration ( ) const

Get/Set FrameDuration

◆ GetFrameStart()

FrameOffsetType itk::TemporalRegion::GetFrameStart ( ) const

Get/Set FrameStart

◆ GetRealDuration()

RealTimeInterval itk::TemporalRegion::GetRealDuration ( ) const

Get/Set RealDuration

◆ GetRealStart()

RealTimeStamp itk::TemporalRegion::GetRealStart ( ) const

Get/Set RealStart

◆ GetRegionType()

RegionEnum itk::TemporalRegion::GetRegionType ( ) const
overridevirtual

Return RegionType (SRUCTURED_REGION)

Implements itk::Region.

◆ IsEqualInFrames()

virtual bool itk::TemporalRegion::IsEqualInFrames ( const Self region) const
virtual

Compare two temporal regions in Frame space

◆ IsEqualInRealTime()

bool itk::TemporalRegion::IsEqualInRealTime ( const Self region) const

Compare two temporal regions in Frame space

◆ ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION()

itk::TemporalRegion::ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION ( Self  )

◆ itkOverrideGetNameOfClassMacro()

itk::TemporalRegion::itkOverrideGetNameOfClassMacro ( TemporalRegion  )

◆ operator==()

bool itk::TemporalRegion::operator== ( const Self region) const

Compare two temporal regions. (Both Frame and RealTime)

◆ PrintSelf()

void itk::TemporalRegion::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Region.

◆ SetFrameDuration()

void itk::TemporalRegion::SetFrameDuration ( const FrameOffsetType  d)

Get/Set FrameDuration

◆ SetFrameStart()

void itk::TemporalRegion::SetFrameStart ( const FrameOffsetType  s)

Get/Set FrameStart

◆ SetRealDuration()

void itk::TemporalRegion::SetRealDuration ( const RealTimeInterval  d)

Get/Set RealDuration

◆ SetRealStart()

void itk::TemporalRegion::SetRealStart ( const RealTimeStamp  s)

Get/Set RealStart

Member Data Documentation

◆ m_FrameDuration

FrameOffsetType itk::TemporalRegion::m_FrameDuration { 0 }
protected

Total number of frames represented by the region (NOT individual frame duration)

Definition at line 125 of file itkTemporalRegion.h.

◆ m_FrameStart

FrameOffsetType itk::TemporalRegion::m_FrameStart { 0 }
protected

Index of the first frame in the region

Definition at line 122 of file itkTemporalRegion.h.

◆ m_RealDuration

RealTimeInterval itk::TemporalRegion::m_RealDuration {}
protected

Time interval corresponding to the entire length of time represented by the region over ALL frames

Definition at line 119 of file itkTemporalRegion.h.

◆ m_RealStart

RealTimeStamp itk::TemporalRegion::m_RealStart {}
protected

Time boundaries Timestamp corresponding to the first frame in the region.

Definition at line 115 of file itkTemporalRegion.h.


The documentation for this class was generated from the following file: