Detailed Description

template<typename TFrameType>
class itk::VideoStream< TFrameType >

A DataObject that holds a buffered portion of a video.

The function of VideoStream is to provide an Image-specific subclass of TemporalDataObject. It provides several convenient typedefs to get common attributes of the frames. Additionally, the VideoStream caches meta information (lagest/requested/buffered spatial regions, origin, spacing, and direction) about all frames in the video, even those not currently buffered. This is done primarily in order to allow the meta data to be set before the frame is buffered.

Definition at line 41 of file itkVideoStream.h.

Public Types
using	BufferType = typename Superclass::BufferType

using	ConstPointer = SmartPointer< const Self >

using	ConstWeakPointer = WeakPointer< const Self >

using	DirectionMapType = typename std::map< SizeValueType, DirectionType >

using	DirectionType = typename FrameType::DirectionType

using	FrameConstPointer = typename FrameType::ConstPointer

using	FramePointer = typename FrameType::Pointer

using	FrameType = TFrameType

using	IndexType = typename FrameType::IndexType

using	PixelType = typename FrameType::PixelType

using	Pointer = SmartPointer< Self >

using	PointMapType = typename std::map< SizeValueType, PointType >

using	PointType = typename FrameType::PointType

using	Self = VideoStream

using	SizeType = typename FrameType::SizeType

using	SpacingMapType = typename std::map< SizeValueType, SpacingType >

using	SpacingType = typename FrameType::SpacingType

using	SpatialRegionMapType = typename std::map< SizeValueType, SpatialRegionType >

using	SpatialRegionType = typename FrameType::RegionType

using	Superclass = TemporalDataObject

Public Types inherited from itk::TemporalDataObject
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

enum	TemporalUnitType { Frame, RealTime, FrameAndRealTime }

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

const SpatialRegionMapType &	GetBufferedSpatialRegionCache () const

const DirectionMapType &	GetDirectionCache () const

const SpatialRegionType &	GetFrameBufferedSpatialRegion (SizeValueType frameNumber) const

const DirectionType &	GetFrameDirection (SizeValueType frameNumber) const

const SpatialRegionType &	GetFrameLargestPossibleSpatialRegion (SizeValueType frameNumber) const

const PointType &	GetFrameOrigin (SizeValueType frameNumber) const

const SpatialRegionType &	GetFrameRequestedSpatialRegion (SizeValueType frameNumber) const

const SpacingType &	GetFrameSpacing (SizeValueType frameNumber) const

virtual const char *	GetNameOfClass () const

const PointMapType &	GetOriginCache () const

const SpatialRegionMapType &	GetRequestedSpatialRegionCache () const

const SpacingMapType &	GetSpacingCache () const

void	InitializeEmptyFrames ()

void	SetAllBufferedSpatialRegions (SpatialRegionType region)

void	SetAllFramesDirection (DirectionType direction)

void	SetAllFramesOrigin (PointType origin)

void	SetAllFramesSpacing (SpacingType spacing)

void	SetAllLargestPossibleSpatialRegions (SpatialRegionType region)

void	SetAllRequestedSpatialRegions (SpatialRegionType region)

void	SetBufferedSpatialRegionCache (SpatialRegionMapType map)

void	SetDirectionCache (DirectionMapType map)

void	SetFrame (SizeValueType frameNumber, FramePointer frame)

void	SetFrameBuffer (BufferType *buffer)

void	SetFrameBufferedSpatialRegion (SizeValueType frameNumber, SpatialRegionType region)

void	SetFrameDirection (SizeValueType frameNumber, DirectionType direction)

void	SetFrameLargestPossibleSpatialRegion (SizeValueType frameNumber, SpatialRegionType region)

void	SetFrameOrigin (SizeValueType frameNumber, PointType origin)

void	SetFrameRequestedSpatialRegion (SizeValueType frameNumber, SpatialRegionType region)

void	SetFrameSpacing (SizeValueType frameNumber, SpacingType spacing)

void	SetMinimumBufferSize (SizeValueType minimumNumberOfFrames)

void	SetOriginCache (PointMapType map)

void	SetRequestedSpatialRegionCache (SpatialRegionMapType map)

void	SetSpacingCache (SpacingMapType map)


BufferType *	GetFrameBuffer ()

const BufferType *	GetFrameBuffer () const


const SpatialRegionMapType &	GetLargestPossibleSpatialRegionCache () const

void	SetLargestPossibleSpatialRegionCache (SpatialRegionMapType map)


FramePointer	GetFrame (SizeValueType frameNumber)

FrameConstPointer	GetFrame (SizeValueType frameNumber) const

Public Member Functions inherited from itk::TemporalDataObject
void	CopyInformation (const DataObject *) override

virtual const TemporalRegionType &	GetBufferedTemporalRegion () const

virtual const TemporalRegionType &	GetLargestPossibleTemporalRegion () const

virtual const TemporalRegionType &	GetRequestedTemporalRegion () const

virtual TemporalUnitType	GetTemporalUnit () const

virtual const TemporalRegionType	GetUnbufferedRequestedTemporalRegion ()

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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexceptoverride

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 unsigned int	GetFrameDimension ()

static Pointer	New ()

Static Public Member Functions inherited from itk::TemporalDataObject
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 ()

Static Public Attributes
static constexpr unsigned int	FrameDimension = FrameType::ImageDimension

SpatialRegionMapType	m_LargestPossibleSpatialRegionCache

SpatialRegionMapType	m_RequestedSpatialRegionCache

SpatialRegionMapType	m_BufferedSpatialRegionCache

SpacingMapType	m_SpacingCache

DirectionMapType	m_DirectionCache

PointMapType	m_OriginCache

void	Allocate ()

void	Graft (const DataObject *data) override

	VideoStream ()=default

	~VideoStream () override=default

void	PrintSelf (std::ostream &os, Indent indent) const override

Additional Inherited Members
Protected Member Functions inherited from itk::TemporalDataObject
	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 &time)

	~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 inherited from itk::TemporalDataObject
TemporalRegionType	m_BufferedTemporalRegion

BufferType::Pointer	m_DataObjectBuffer

TemporalRegionType	m_LargestPossibleTemporalRegion

TemporalRegionType	m_RequestedTemporalRegion

TemporalUnitType	m_TemporalUnit {Frame}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount