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

#include <itkTemporalDataObject.h>

+ Inheritance diagram for itk::TemporalDataObject:
+ Collaboration diagram for itk::TemporalDataObject:

Public Types

using BufferType = RingBuffer< DataObject >
 
using ConstPointer = SmartPointer< const Self >
 
using ConstWeakPointer = WeakPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = TemporalDataObject
 
using Superclass = DataObject
 
using TemporalRegionType = TemporalRegion
 
using TemporalUnitEnum = TemporalDataObjectEnums::TemporalUnit
 
using TemporalUnitType = TemporalUnitEnum
 
- Public Types inherited from itk::DataObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = std::string
 
using DataObjectPointerArraySizeType = std::vector< Pointer >::size_type
 
using Pointer = SmartPointer< Self >
 
using Self = DataObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
virtual TemporalUnitType GetTemporalUnit () const
 
- Public Member Functions inherited from itk::DataObject
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointer< ProcessObjectGetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual void Initialize ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
void SetReleaseDataFlag (bool flag)
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
virtual void UpdateOutputInformation ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp () const
 
virtual void PrepareForNewData ()
 
virtual void DataHasBeenGenerated ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static Pointer New ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
BufferType::Pointer m_DataObjectBuffer
 
TemporalRegionType m_LargestPossibleTemporalRegion
 
TemporalRegionType m_RequestedTemporalRegion
 
TemporalRegionType m_BufferedTemporalRegion
 
TemporalUnitEnum m_TemporalUnit { TemporalUnitEnum::Frame }
 
virtual void SetTemporalUnitToFrame ()
 
virtual void SetTemporalUnitToRealTime ()
 
virtual void SetTemporalUnitToFrameAndRealTime ()
 
SizeValueType GetNumberOfBuffers ()
 
void SetNumberOfBuffers (SizeValueType num)
 
virtual void SetLargestPossibleTemporalRegion (const TemporalRegionType &region)
 
virtual const TemporalRegionTypeGetLargestPossibleTemporalRegion () const
 
virtual void SetBufferedTemporalRegion (const TemporalRegionType &region)
 
virtual const TemporalRegionTypeGetBufferedTemporalRegion () const
 
virtual void SetRequestedTemporalRegion (const TemporalRegionType &region)
 
virtual const TemporalRegionTypeGetRequestedTemporalRegion () 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
 
 TemporalDataObject ()
 
 ~TemporalDataObject () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
 ~DataObject () override
 
virtual void PropagateResetPipeline ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

DataObject subclass with knowledge of temporal region.

This class represents a data object that relies on temporal regions. It uses an itk::RingBuffer to store DataObject pointers in sequential order. The pointers in the ring buffer should correspond to the BufferedTemporalRegion. The LargestPossibleTemporalRegion should indicate the maximum extent that data object is logically capable of holding, and the RequestedTemporalRegion is used in the pipeline to request that a certain temporal region be buffered

Definition at line 65 of file itkTemporalDataObject.h.

Member Typedef Documentation

◆ BufferType

Definition at line 77 of file itkTemporalDataObject.h.

◆ ConstPointer

Definition at line 74 of file itkTemporalDataObject.h.

◆ ConstWeakPointer

Definition at line 75 of file itkTemporalDataObject.h.

◆ Pointer

Definition at line 73 of file itkTemporalDataObject.h.

◆ Self

Standard class type aliases

Definition at line 71 of file itkTemporalDataObject.h.

◆ Superclass

Definition at line 72 of file itkTemporalDataObject.h.

◆ TemporalRegionType

Definition at line 78 of file itkTemporalDataObject.h.

◆ TemporalUnitEnum

Definition at line 80 of file itkTemporalDataObject.h.

◆ TemporalUnitType

Definition at line 81 of file itkTemporalDataObject.h.

Constructor & Destructor Documentation

◆ TemporalDataObject()

itk::TemporalDataObject::TemporalDataObject ( )
protected

Buffer for holding component data objects

◆ ~TemporalDataObject()

itk::TemporalDataObject::~TemporalDataObject ( )
overrideprotected

Buffer for holding component data objects

Member Function Documentation

◆ CopyInformation()

void itk::TemporalDataObject::CopyInformation ( const DataObject )
overridevirtual

Buffer for holding component data objects

Reimplemented from itk::DataObject.

◆ CreateAnother()

virtual::itk::LightObject::Pointer itk::TemporalDataObject::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

Reimplemented in itk::VideoStream< TFrameType >.

◆ GetBufferedTemporalRegion()

virtual const TemporalRegionType& itk::TemporalDataObject::GetBufferedTemporalRegion ( ) const
virtual

Buffer for holding component data objects

◆ GetLargestPossibleTemporalRegion()

virtual const TemporalRegionType& itk::TemporalDataObject::GetLargestPossibleTemporalRegion ( ) const
virtual

Buffer for holding component data objects

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::DataObject.

Reimplemented in itk::VideoStream< TFrameType >.

◆ GetNumberOfBuffers()

SizeValueType itk::TemporalDataObject::GetNumberOfBuffers ( )

Get/Set the number of frames that the internal buffer can hold

◆ GetRequestedTemporalRegion()

virtual const TemporalRegionType& itk::TemporalDataObject::GetRequestedTemporalRegion ( ) const
virtual

Buffer for holding component data objects

◆ GetTemporalUnit()

virtual TemporalUnitType itk::TemporalDataObject::GetTemporalUnit ( ) const
virtual

Get the type of temporal units we care about (Defaults to Frame)

◆ GetUnbufferedRequestedTemporalRegion()

virtual const TemporalRegionType itk::TemporalDataObject::GetUnbufferedRequestedTemporalRegion ( )
virtual

Get the portion of the requested region that is not covered by the buffered region

◆ Graft()

void itk::TemporalDataObject::Graft ( const DataObject )
overridevirtual

Buffer for holding component data objects

Reimplemented from itk::DataObject.

Reimplemented in itk::VideoStream< TFrameType >.

◆ New()

static Pointer itk::TemporalDataObject::New ( )
static

◆ PrintSelf()

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

Buffer for holding component data objects

Reimplemented from itk::DataObject.

Reimplemented in itk::VideoStream< TFrameType >.

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

bool itk::TemporalDataObject::RequestedRegionIsOutsideOfTheBufferedRegion ( )
overridevirtual

Buffer for holding component data objects

Reimplemented from itk::DataObject.

◆ SetBufferedTemporalRegion()

virtual void itk::TemporalDataObject::SetBufferedTemporalRegion ( const TemporalRegionType region)
virtual

Buffer for holding component data objects

◆ SetLargestPossibleTemporalRegion()

virtual void itk::TemporalDataObject::SetLargestPossibleTemporalRegion ( const TemporalRegionType region)
virtual

Buffer for holding component data objects

◆ SetNumberOfBuffers()

void itk::TemporalDataObject::SetNumberOfBuffers ( SizeValueType  num)

Buffer for holding component data objects

◆ SetRequestedRegion()

void itk::TemporalDataObject::SetRequestedRegion ( const DataObject )
overridevirtual

Buffer for holding component data objects

Reimplemented from itk::DataObject.

◆ SetRequestedRegionToLargestPossibleRegion()

void itk::TemporalDataObject::SetRequestedRegionToLargestPossibleRegion ( )
overridevirtual

Buffer for holding component data objects

Reimplemented from itk::DataObject.

◆ SetRequestedTemporalRegion()

virtual void itk::TemporalDataObject::SetRequestedTemporalRegion ( const TemporalRegionType region)
virtual

Buffer for holding component data objects

◆ SetTemporalUnitToFrame()

virtual void itk::TemporalDataObject::SetTemporalUnitToFrame ( )
virtual

Explicity set temporal units (Defaults to Frame)

◆ SetTemporalUnitToFrameAndRealTime()

virtual void itk::TemporalDataObject::SetTemporalUnitToFrameAndRealTime ( )
virtual

Buffer for holding component data objects

◆ SetTemporalUnitToRealTime()

virtual void itk::TemporalDataObject::SetTemporalUnitToRealTime ( )
virtual

Buffer for holding component data objects

◆ VerifyRequestedRegion()

bool itk::TemporalDataObject::VerifyRequestedRegion ( )
overridevirtual

Buffer for holding component data objects

Reimplemented from itk::DataObject.

Member Data Documentation

◆ m_BufferedTemporalRegion

TemporalRegionType itk::TemporalDataObject::m_BufferedTemporalRegion
protected

Buffer for holding component data objects

Definition at line 164 of file itkTemporalDataObject.h.

◆ m_DataObjectBuffer

BufferType::Pointer itk::TemporalDataObject::m_DataObjectBuffer
protected

Buffer for holding component data objects

Definition at line 159 of file itkTemporalDataObject.h.

◆ m_LargestPossibleTemporalRegion

TemporalRegionType itk::TemporalDataObject::m_LargestPossibleTemporalRegion
protected

We want to keep track of our regions in time.

Definition at line 162 of file itkTemporalDataObject.h.

◆ m_RequestedTemporalRegion

TemporalRegionType itk::TemporalDataObject::m_RequestedTemporalRegion
protected

Buffer for holding component data objects

Definition at line 163 of file itkTemporalDataObject.h.

◆ m_TemporalUnit

TemporalUnitEnum itk::TemporalDataObject::m_TemporalUnit { TemporalUnitEnum::Frame }
protected

Buffer for holding component data objects

Definition at line 166 of file itkTemporalDataObject.h.


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