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

#include <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

virtual const char * GetNameOfClass () const
- Public Member Functions inherited from itk::Region
 itkTypeMacroNoParent (Region)
virtual void Print (std::ostream &os, Indent indent=0) const
 Region ()=default
virtual ~Region ()=default
RealTimeStamp m_RealStart
RealTimeInterval m_RealDuration
FrameOffsetType m_FrameStart { 0 }
FrameOffsetType m_FrameDuration { 0 }
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
bool operator!= (const Self &region) const
void PrintSelf (std::ostream &os, Indent indent) const override

Additional Inherited Members

- 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

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.

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 ( )


◆ ~TemporalRegion()

itk::TemporalRegion::~TemporalRegion ( )


Member Function Documentation

◆ GetFrameDuration()

FrameOffsetType itk::TemporalRegion::GetFrameDuration ( ) const

Time boundaries

◆ GetFrameStart()

FrameOffsetType itk::TemporalRegion::GetFrameStart ( ) const

Time boundaries

◆ GetNameOfClass()

virtual const char* itk::TemporalRegion::GetNameOfClass ( ) const

◆ GetRealDuration()

RealTimeInterval itk::TemporalRegion::GetRealDuration ( ) const

Time boundaries

◆ GetRealStart()

RealTimeStamp itk::TemporalRegion::GetRealStart ( ) const

Time boundaries

◆ GetRegionType()

RegionEnum itk::TemporalRegion::GetRegionType ( ) const

Return RegionType (SRUCTURED_REGION)

Implements itk::Region.

◆ IsEqualInFrames()

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

Compare two temporal regions in Frame space

◆ IsEqualInRealTime()

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

Compare two temporal regions in Frame space

◆ operator!=()

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

Time boundaries

◆ 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

Time boundaries

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 }

Time boundaries

Definition at line 117 of file itkTemporalRegion.h.

◆ m_FrameStart

FrameOffsetType itk::TemporalRegion::m_FrameStart { 0 }

Time boundaries

Definition at line 116 of file itkTemporalRegion.h.

◆ m_RealDuration

RealTimeInterval itk::TemporalRegion::m_RealDuration

Time boundaries

Definition at line 115 of file itkTemporalRegion.h.

◆ m_RealStart

RealTimeStamp itk::TemporalRegion::m_RealStart

Time boundaries

Definition at line 114 of file itkTemporalRegion.h.

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