itk::TemporalDataObject Class Reference

#include <itkTemporalDataObject.h>

Inheritance diagram for itk::TemporalDataObject:

Collaboration diagram for itk::TemporalDataObject:

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 42 of file itkTemporalDataObject.h.

Public Types
typedef RingBuffer< DataObject >	BufferType
typedef SmartPointer< const Self >	ConstPointer
typedef WeakPointer< const Self >	ConstWeakPointer
typedef SmartPointer< Self >	Pointer
typedef TemporalDataObject	Self
typedef DataObject	Superclass
typedef TemporalRegion	TemporalRegionType
enum	TemporalUnitType {   Frame,   RealTime,   FrameAndRealTime }
Public Types inherited from itk::DataObject
typedef SmartPointer< const Self >	ConstPointer
typedef std::string	DataObjectIdentifierType
typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType
typedef SmartPointer< Self >	Pointer
typedef DataObject	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual void	CopyInformation (const DataObject *) override
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const TemporalRegionType &	GetBufferedTemporalRegion () const
virtual const TemporalRegionType &	GetLargestPossibleTemporalRegion () const
virtual const char *	GetNameOfClass () const
virtual const TemporalRegionType &	GetRequestedTemporalRegion () const
virtual TemporalUnitType	GetTemporalUnit () const
virtual const TemporalRegionType	GetUnbufferedRequestedTemporalRegion ()
virtual void	Graft (const DataObject *) override
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion () override
virtual void	SetBufferedTemporalRegion (const TemporalRegionType &region)
virtual void	SetLargestPossibleTemporalRegion (const TemporalRegionType &region)
virtual void	SetRequestedRegion (const DataObject *) override
virtual void	SetRequestedRegionToLargestPossibleRegion () override
virtual void	SetRequestedTemporalRegion (const TemporalRegionType &region)
virtual 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
SmartPointerForwardReference < 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	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 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 *)
unsigned long	AddObserver (const EventObject &event, Command *) const
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
virtual void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) override
virtual void	UnRegister () const noexceptoverride
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 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 ()

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

Member Typedef Documentation

typedef RingBuffer<DataObject> itk::TemporalDataObject::BufferType

Definition at line 53 of file itkTemporalDataObject.h.

typedef SmartPointer< const Self > itk::TemporalDataObject::ConstPointer

Definition at line 50 of file itkTemporalDataObject.h.

typedef WeakPointer< const Self > itk::TemporalDataObject::ConstWeakPointer

Definition at line 51 of file itkTemporalDataObject.h.

typedef SmartPointer< Self > itk::TemporalDataObject::Pointer

Definition at line 49 of file itkTemporalDataObject.h.

typedef TemporalDataObject itk::TemporalDataObject::Self

Standard class typedefs

Definition at line 47 of file itkTemporalDataObject.h.

typedef DataObject itk::TemporalDataObject::Superclass

Definition at line 48 of file itkTemporalDataObject.h.

typedef TemporalRegion itk::TemporalDataObject::TemporalRegionType

Definition at line 54 of file itkTemporalDataObject.h.

Member Enumeration Documentation

enum itk::TemporalDataObject::TemporalUnitType

Enum for defining the way in which to compare temporal regions

Enumerator
Frame
RealTime
FrameAndRealTime

Definition at line 57 of file itkTemporalDataObject.h.

Constructor & Destructor Documentation

itk::TemporalDataObject::TemporalDataObject ( )

protected

virtual itk::TemporalDataObject::~TemporalDataObject ( )

overrideprotectedvirtual

Member Function Documentation

virtual 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.

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

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

virtual

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

virtual

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::DataObject.

Reimplemented in itk::VideoStream< TFrameType >.

SizeValueType itk::TemporalDataObject::GetNumberOfBuffers

(

)

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

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

virtual

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

virtual

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

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

virtual

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

virtual 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 >.

static Pointer itk::TemporalDataObject::New ( )

static

virtual 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 >.

virtual 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.

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

virtual

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

virtual

void itk::TemporalDataObject::SetNumberOfBuffers

(

SizeValueType

num

)

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

virtual 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.

virtual 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.

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

virtual

virtual void itk::TemporalDataObject::SetTemporalUnitToFrame ( )

virtual

Explicity set temporal units (Defaults to Frame)

virtual void itk::TemporalDataObject::SetTemporalUnitToFrameAndRealTime ( )

virtual

Explicity set temporal units (Defaults to Frame)

virtual void itk::TemporalDataObject::SetTemporalUnitToRealTime ( )

virtual

Explicity set temporal units (Defaults to Frame)

virtual 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

TemporalRegionType itk::TemporalDataObject::m_BufferedTemporalRegion

protected

Definition at line 115 of file itkTemporalDataObject.h.

BufferType::Pointer itk::TemporalDataObject::m_DataObjectBuffer

protected

Buffer for holding component data objects

Definition at line 110 of file itkTemporalDataObject.h.

TemporalRegionType itk::TemporalDataObject::m_LargestPossibleTemporalRegion

protected

We want to keep track of our regions in time.

Definition at line 113 of file itkTemporalDataObject.h.

TemporalRegionType itk::TemporalDataObject::m_RequestedTemporalRegion

protected

Definition at line 114 of file itkTemporalDataObject.h.

TemporalUnitType itk::TemporalDataObject::m_TemporalUnit

protected

Definition at line 117 of file itkTemporalDataObject.h.

---

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

• itkTemporalDataObject.h