DataObject subclass with knowledge of temporal region. More...

#include <itkTemporalDataObject.h>

Inheritance diagram for itk::TemporalDataObject:

Collaboration diagram for itk::TemporalDataObject:

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 Member Functions
virtual void	CopyInformation (const DataObject *)
virtual ::itk::LightObject::Pointer	CreateAnother (void) 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 *)
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual void	SetBufferedTemporalRegion (const TemporalRegionType &region)
virtual void	SetLargestPossibleTemporalRegion (const TemporalRegionType &region)
virtual void	SetRequestedRegion (const DataObject *)
virtual void	SetRequestedRegionToLargestPossibleRegion ()
virtual void	SetRequestedTemporalRegion (const TemporalRegionType &region)
virtual bool	VerifyRequestedRegion ()

virtual void	SetTemporalUnitToFrame ()
virtual void	SetTemporalUnitToRealTime ()
virtual void	SetTemporalUnitToFrameAndRealTime ()

SizeValueType	GetNumberOfBuffers ()
void	SetNumberOfBuffers (SizeValueType num)
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
virtual void	PrintSelf (std::ostream &os, Indent indent) const
	TemporalDataObject ()
virtual	~TemporalDataObject ()
Protected Attributes
TemporalRegionType	m_BufferedTemporalRegion
BufferType::Pointer	m_DataObjectBuffer
TemporalRegionType	m_LargestPossibleTemporalRegion
TemporalRegionType	m_RequestedTemporalRegion
TemporalUnitType	m_TemporalUnit
Private Member Functions
void	operator= (const Self &)
	TemporalDataObject (const Self &)

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

Member Typedef Documentation

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

Reimplemented in itk::VideoStream< TFrameType >.

Definition at line 52 of file itkTemporalDataObject.h.

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

Reimplemented from itk::DataObject.

Reimplemented in itk::VideoStream< TFrameType >.

Definition at line 49 of file itkTemporalDataObject.h.

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

Reimplemented in itk::VideoStream< TFrameType >.

Definition at line 50 of file itkTemporalDataObject.h.

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

Reimplemented from itk::DataObject.

Reimplemented in itk::VideoStream< TFrameType >.

Definition at line 48 of file itkTemporalDataObject.h.

typedef TemporalDataObject itk::TemporalDataObject::Self

Standard class typedefs

Reimplemented from itk::DataObject.

Reimplemented in itk::VideoStream< TFrameType >.

Definition at line 46 of file itkTemporalDataObject.h.

typedef DataObject itk::TemporalDataObject::Superclass

Reimplemented from itk::DataObject.

Reimplemented in itk::VideoStream< TFrameType >.

Definition at line 47 of file itkTemporalDataObject.h.

typedef TemporalRegion itk::TemporalDataObject::TemporalRegionType

Definition at line 53 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 56 of file itkTemporalDataObject.h.

Constructor & Destructor Documentation

itk::TemporalDataObject::TemporalDataObject ( ) [protected]

virtual itk::TemporalDataObject::~TemporalDataObject ( ) [protected, virtual]

itk::TemporalDataObject::TemporalDataObject ( const Self & ) [private]

Member Function Documentation

virtual void itk::TemporalDataObject::CopyInformation ( const DataObject * ) [virtual]

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 ( void ) 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 * ) [virtual]

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]

Method for creation through the object factory.

Reimplemented from itk::Object.

Reimplemented in itk::VideoStream< TFrameType >.

void itk::TemporalDataObject::operator= ( const Self & ) [private]

Reimplemented from itk::DataObject.

Reimplemented in itk::VideoStream< TFrameType >.

virtual void itk::TemporalDataObject::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const `[protected, virtual]`

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

virtual bool itk::TemporalDataObject::RequestedRegionIsOutsideOfTheBufferedRegion ( ) [virtual]

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 * ) [virtual]

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 ( ) [virtual]

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 ( ) [virtual]

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.