ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::TemporalDataObject Class Reference
Group Video » Module ITKVideoCore

#include <itkTemporalDataObject.h>

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.

+ 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

void CopyInformation (const DataObject *) override
 
virtual const TemporalRegionType & GetBufferedTemporalRegion () const
 
virtual const TemporalRegionType & GetLargestPossibleTemporalRegion () const
 
const char * GetNameOfClass () const override
 
virtual const TemporalRegionType & GetRequestedTemporalRegion () const
 
virtual TemporalUnitType GetTemporalUnit () const
 
virtual const TemporalRegionType GetUnbufferedRequestedTemporalRegion ()
 
void Graft (const DataObject *) override
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
virtual void SetBufferedTemporalRegion (const TemporalRegionType &region)
 
virtual void SetLargestPossibleTemporalRegion (const TemporalRegionType &region)
 
void SetRequestedRegion (const DataObject *) override
 
void SetRequestedRegionToLargestPossibleRegion () override
 
virtual void SetRequestedTemporalRegion (const TemporalRegionType &region)
 
bool VerifyRequestedRegion () override
 
virtual void SetTemporalUnitToFrame ()
 
virtual void SetTemporalUnitToRealTime ()
 
virtual void SetTemporalUnitToFrameAndRealTime ()
 
SizeValueType GetNumberOfBuffers ()
 
void SetNumberOfBuffers (SizeValueType num)
 
- Public Member Functions inherited from itk::DataObject
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointer< ProcessObject > GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierType & GetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void Initialize ()
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
void SetReleaseDataFlag (bool flag)
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
virtual void UpdateOutputInformation ()
 
void UpdateSource () const
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual const ModifiedTimeType & GetPipelineMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStamp & GetRealTimeStamp () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStamp & GetTimeStamp () 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) const
 
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
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 TemporalDataObject ()
 
 ~TemporalDataObject () override
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
 ~DataObject () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- 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

TemporalRegionType m_BufferedTemporalRegion {}
 
BufferType::Pointer m_DataObjectBuffer {}
 
TemporalRegionType m_LargestPossibleTemporalRegion {}
 
TemporalRegionType m_RequestedTemporalRegion {}
 
TemporalUnitEnum m_TemporalUnit { TemporalUnitEnum::Frame }
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ BufferType

using itk::TemporalDataObject::BufferType = RingBuffer<DataObject>

Definition at line 77 of file itkTemporalDataObject.h.

◆ ConstPointer

using itk::TemporalDataObject::ConstPointer = SmartPointer<const Self>

Definition at line 74 of file itkTemporalDataObject.h.

◆ ConstWeakPointer

using itk::TemporalDataObject::ConstWeakPointer = WeakPointer<const Self>

Definition at line 75 of file itkTemporalDataObject.h.

◆ Pointer

using itk::TemporalDataObject::Pointer = SmartPointer<Self>

Definition at line 73 of file itkTemporalDataObject.h.

◆ Self

using itk::TemporalDataObject::Self = TemporalDataObject

Standard class type aliases

Definition at line 71 of file itkTemporalDataObject.h.

◆ Superclass

using itk::TemporalDataObject::Superclass = DataObject

Definition at line 72 of file itkTemporalDataObject.h.

◆ TemporalRegionType

using itk::TemporalDataObject::TemporalRegionType = TemporalRegion

Definition at line 78 of file itkTemporalDataObject.h.

◆ TemporalUnitEnum

using itk::TemporalDataObject::TemporalUnitEnum = TemporalDataObjectEnums::TemporalUnit

Definition at line 80 of file itkTemporalDataObject.h.

◆ TemporalUnitType

using itk::TemporalDataObject::TemporalUnitType = TemporalUnitEnum

Definition at line 81 of file itkTemporalDataObject.h.

Constructor & Destructor Documentation

◆ TemporalDataObject()

itk::TemporalDataObject::TemporalDataObject ( )
protected

◆ ~TemporalDataObject()

itk::TemporalDataObject::~TemporalDataObject ( )
overrideprotected

Member Function Documentation

◆ CopyInformation()

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

Copy information from the specified data set. This method is part of the pipeline execution model. By default, a ProcessObject will copy meta-data from the first input to all of its outputs. See ProcessObject::GenerateOutputInformation(). Each subclass of DataObject is responsible for being able to copy whatever meta-data it needs from from another DataObject. The default implementation of this method is empty. If a subclass overrides this method, it should always call its superclass' version.

Reimplemented from itk::DataObject.

◆ GetBufferedTemporalRegion()

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

◆ GetLargestPossibleTemporalRegion()

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

◆ GetNameOfClass()

const char* itk::TemporalDataObject::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

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

◆ 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

Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.

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

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::DataObject.

Reimplemented in itk::VideoStream< TFrameType >.

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

bool itk::TemporalDataObject::RequestedRegionIsOutsideOfTheBufferedRegion ( )
overridevirtual

Determine whether the RequestedRegion is outside of the BufferedRegion. This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute

Reimplemented from itk::DataObject.

◆ SetBufferedTemporalRegion()

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

◆ SetLargestPossibleTemporalRegion()

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

◆ SetNumberOfBuffers()

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

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

◆ SetRequestedRegion()

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

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. For DataObject's that do not support Regions, this method does nothing. Subclasses of DataObject that do support Regions, provide an alternative implementation.

Reimplemented from itk::DataObject.

◆ SetRequestedRegionToLargestPossibleRegion()

void itk::TemporalDataObject::SetRequestedRegionToLargestPossibleRegion ( )
overridevirtual

Set the RequestedRegion to the LargestPossibleRegion. This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update().

Reimplemented from itk::DataObject.

◆ SetRequestedTemporalRegion()

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

◆ SetTemporalUnitToFrame()

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

Explicitly set temporal units (Defaults to Frame)

◆ SetTemporalUnitToFrameAndRealTime()

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

Explicitly set temporal units (Defaults to Frame)

◆ SetTemporalUnitToRealTime()

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

Explicitly set temporal units (Defaults to Frame)

◆ VerifyRequestedRegion()

bool itk::TemporalDataObject::VerifyRequestedRegion ( )
overridevirtual

Verify that the RequestedRegion is within the LargestPossibleRegion.

If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possibly satisfy the request. This method returns true if the request can be satisfied (even if it will be necessary to process the entire LargestPossibleRegion) and returns false otherwise. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception if the requested region is not within the LargestPossibleRegion. Default implementation simply returns true in order to support DataObjects that do not need regions (for instance itk::EquivalencyTable).

Reimplemented from itk::DataObject.

Member Data Documentation

◆ m_BufferedTemporalRegion

TemporalRegionType itk::TemporalDataObject::m_BufferedTemporalRegion {}
protected

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

Definition at line 163 of file itkTemporalDataObject.h.

◆ m_TemporalUnit

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

Definition at line 166 of file itkTemporalDataObject.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16