itk::TemporalRegion Class Reference

#include <itkTemporalRegion.h>

Inheritance diagram for itk::TemporalRegion:

Collaboration diagram for itk::TemporalRegion:

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 41 of file itkTemporalRegion.h.

Public Types
typedef ::itk::SizeValueType	FrameOffsetType
typedef TemporalRegion	Self
typedef Region	Superclass
Public Types inherited from itk::Region
enum	RegionType {   ITK_UNSTRUCTURED_REGION,   ITK_STRUCTURED_REGION }
typedef Region	Self

Public Member Functions
virtual const char *	GetNameOfClass () const
virtual RegionType	GetRegionType () const ITK_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
	TemporalRegion ()
virtual	~TemporalRegion ()
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
virtual void	Print (std::ostream &os, Indent indent=0) const
	Region ()
virtual	~Region ()

Protected Member Functions
virtual void	PrintSelf (std::ostream &os, Indent indent) const ITK_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
FrameOffsetType	m_FrameStart
RealTimeInterval	m_RealDuration
RealTimeStamp	m_RealStart

Member Typedef Documentation

typedef ::itk::SizeValueType itk::TemporalRegion::FrameOffsetType

Typedef for frame offsets

Definition at line 49 of file itkTemporalRegion.h.

typedef TemporalRegion itk::TemporalRegion::Self

Standard class typedefs

Definition at line 46 of file itkTemporalRegion.h.

typedef Region itk::TemporalRegion::Superclass

Definition at line 47 of file itkTemporalRegion.h.

Constructor & Destructor Documentation

itk::TemporalRegion::TemporalRegion

(

)

Constructor

virtual itk::TemporalRegion::~TemporalRegion ( )

virtual

Destructor

Member Function Documentation

FrameOffsetType itk::TemporalRegion::GetFrameDuration

(

)

const

Get/Set FrameDuration

FrameOffsetType itk::TemporalRegion::GetFrameStart

(

)

const

Get/Set FrameStart

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

virtual

Standard part of all itk objects.

Reimplemented from itk::Region.

RealTimeInterval itk::TemporalRegion::GetRealDuration

(

)

const

Get/Set RealDuration

RealTimeStamp itk::TemporalRegion::GetRealStart

(

)

const

Get/Set RealStart

virtual RegionType itk::TemporalRegion::GetRegionType ( ) const

virtual

Return RegionType (SRUCTURED_REGION)

Implements itk::Region.

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

virtual

Compare two temporal regions in Frame space

bool itk::TemporalRegion::IsEqualInRealTime

(

const Self &

region

)

const

Compare two temporal regions in Frame space

bool itk::TemporalRegion::operator!=

(

const Self &

region

)

const

bool itk::TemporalRegion::operator==

(

const Self &

region

)

const

Compare two temporal regions. (Both Frame and RealTime)

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

protectedvirtual

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.

void itk::TemporalRegion::SetFrameDuration

(

const FrameOffsetType

d

)

Get/Set FrameDuration

void itk::TemporalRegion::SetFrameStart

(

const FrameOffsetType

s

)

Get/Set FrameStart

void itk::TemporalRegion::SetRealDuration

(

const RealTimeInterval

d

)

Get/Set RealDuration

void itk::TemporalRegion::SetRealStart

(

const RealTimeStamp

s

)

Get/Set RealStart

Member Data Documentation

FrameOffsetType itk::TemporalRegion::m_FrameDuration

protected

Definition at line 102 of file itkTemporalRegion.h.

FrameOffsetType itk::TemporalRegion::m_FrameStart

protected

Definition at line 101 of file itkTemporalRegion.h.

RealTimeInterval itk::TemporalRegion::m_RealDuration

protected

Definition at line 100 of file itkTemporalRegion.h.

RealTimeStamp itk::TemporalRegion::m_RealStart

protected

Time boundaries

Definition at line 99 of file itkTemporalRegion.h.

---

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

• itkTemporalRegion.h