ITK  4.13.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
itk::VideoSource< TOutputVideoStream > Class Template Reference

#include <itkVideoSource.h>

+ Inheritance diagram for itk::VideoSource< TOutputVideoStream >:
+ Collaboration diagram for itk::VideoSource< TOutputVideoStream >:

Detailed Description

template<typename TOutputVideoStream>
class itk::VideoSource< TOutputVideoStream >

A TemporalProcessObject that produces a VideoStream.

VideoSource acts as the base class for all TemporalProcess objects that produce a VideoStream as their output. This class defines GetOutput() which returns a pointer to the VideoStream object on output port 0.

The other roll that VideoSource plays is to implement the framework for spatial streaming to complement the temporal streaming implemented in TemporalProcessObject. This implementation mirrors the implementation in ImageSource except that each thread will be able to operate on a spatial region of each frame in the current temporal region that is being processed.

Definition at line 43 of file itkVideoSource.h.

Classes

struct  ThreadStruct
 

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef WeakPointer< const SelfConstWeakPointer
 
typedef
ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef
OutputVideoStreamType::DirectionType 
OutputFrameDirectionType
 
typedef
OutputVideoStreamType::IndexType 
OutputFrameIndexType
 
typedef
OutputVideoStreamType::PixelType 
OutputFramePixelType
 
typedef
OutputVideoStreamType::PointType 
OutputFramePointType
 
typedef
OutputVideoStreamType::SizeType 
OutputFrameSizeType
 
typedef
OutputVideoStreamType::SpacingType 
OutputFrameSpacingType
 
typedef
OutputVideoStreamType::SpatialRegionType 
OutputFrameSpatialRegionType
 
typedef
OutputVideoStreamType::FrameType 
OutputFrameType
 
typedef TOutputVideoStream OutputVideoStreamType
 
typedef SmartPointer< SelfPointer
 
typedef VideoSource Self
 
typedef TemporalProcessObject Superclass
 
- Public Types inherited from itk::TemporalProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef TemporalProcessObject Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef MultiThreader MultiThreaderType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
OutputVideoStreamTypeGetOutput ()
 
OutputVideoStreamTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, OutputVideoStreamType *output)
 
virtual void GraftOutput (OutputVideoStreamType *output)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
- Public Member Functions inherited from itk::TemporalProcessObject
virtual void EnlargeOutputRequestedRegion (DataObject *output) override
 
virtual void GenerateData () override
 
virtual void GenerateInputRequestedRegion () override
 
virtual void GenerateOutputRequestedRegion (DataObject *output) override
 
virtual SizeValueType GetUnitInputNumberOfFrames ()
 
virtual SizeValueType GetUnitOutputNumberOfFrames ()
 
virtual void UpdateOutputData (DataObject *output) override
 
virtual void UpdateOutputInformation () override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
void UpdateProgress (float progress)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () 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
 
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
 
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::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 AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void GenerateOutputRequestedTemporalRegion (TemporalDataObject *output) override
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual int SplitRequestedSpatialRegion (int i, int num, OutputFrameSpatialRegionType &splitRegion)
 
virtual void TemporalStreamingGenerateData () override
 
virtual void ThreadedGenerateData (const OutputFrameSpatialRegionType &outputRegionForThread, int threadId)
 
 VideoSource ()
 
virtual ~VideoSource () override
 
- Protected Member Functions inherited from itk::TemporalProcessObject
virtual void AfterTemporalStreamingGenerateData ()
 
virtual void BeforeTemporalStreamingGenerateData ()
 
virtual void EnlargeOutputRequestedTemporalRegion (TemporalDataObject *output)
 
virtual TemporalRegion GenerateDefaultLargestPossibleTemporalRegion ()
 
virtual void GenerateInputRequestedTemporalRegion ()
 
virtual SizeValueType GetInputStencilCurrentFrameIndex ()
 
virtual void SetFrameSkipPerOutput (OffsetValueType _arg)
 
virtual void SetInputStencilCurrentFrameIndex (SizeValueType _arg)
 
virtual void SetUnitInputNumberOfFrames (SizeValueType _arg)
 
virtual void SetUnitOutputNumberOfFrames (SizeValueType _arg)
 
virtual std::vector
< TemporalRegion
SplitRequestedTemporalRegion ()
 
 TemporalProcessObject ()
 
virtual ~TemporalProcessObject () override
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputInformation ()
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- 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 ()
 

Static Protected Member Functions

static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 
static const unsigned int OutputFrameDimension = OutputFrameType::ImageDimension
 
static unsigned int GetOutputFrameDimension ()
 

Additional Inherited Members

- Protected Attributes inherited from itk::TemporalProcessObject
OffsetValueType m_FrameSkipPerOutput
 
SizeValueType m_InputStencilCurrentFrameIndex
 
SizeValueType m_UnitInputNumberOfFrames
 
SizeValueType m_UnitOutputNumberOfFrames
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TOutputVideoStream>
typedef SmartPointer< const Self > itk::VideoSource< TOutputVideoStream >::ConstPointer

Definition at line 53 of file itkVideoSource.h.

template<typename TOutputVideoStream>
typedef WeakPointer< const Self > itk::VideoSource< TOutputVideoStream >::ConstWeakPointer

Definition at line 54 of file itkVideoSource.h.

template<typename TOutputVideoStream>
typedef ProcessObject::DataObjectPointerArraySizeType itk::VideoSource< TOutputVideoStream >::DataObjectPointerArraySizeType

Make a DataObject of the correct type for the specified output port. The default always creates an OutputVideoStreamType object, so subclasses with multiple types of output must override this to return the proper type.

Definition at line 101 of file itkVideoSource.h.

template<typename TOutputVideoStream>
typedef OutputVideoStreamType::DirectionType itk::VideoSource< TOutputVideoStream >::OutputFrameDirectionType

Definition at line 64 of file itkVideoSource.h.

template<typename TOutputVideoStream>
typedef OutputVideoStreamType::IndexType itk::VideoSource< TOutputVideoStream >::OutputFrameIndexType

Definition at line 59 of file itkVideoSource.h.

template<typename TOutputVideoStream>
typedef OutputVideoStreamType::PixelType itk::VideoSource< TOutputVideoStream >::OutputFramePixelType

Definition at line 60 of file itkVideoSource.h.

template<typename TOutputVideoStream>
typedef OutputVideoStreamType::PointType itk::VideoSource< TOutputVideoStream >::OutputFramePointType

Definition at line 61 of file itkVideoSource.h.

template<typename TOutputVideoStream>
typedef OutputVideoStreamType::SizeType itk::VideoSource< TOutputVideoStream >::OutputFrameSizeType

Definition at line 63 of file itkVideoSource.h.

template<typename TOutputVideoStream>
typedef OutputVideoStreamType::SpacingType itk::VideoSource< TOutputVideoStream >::OutputFrameSpacingType

Definition at line 62 of file itkVideoSource.h.

template<typename TOutputVideoStream>
typedef OutputVideoStreamType::SpatialRegionType itk::VideoSource< TOutputVideoStream >::OutputFrameSpatialRegionType

Definition at line 58 of file itkVideoSource.h.

template<typename TOutputVideoStream>
typedef OutputVideoStreamType::FrameType itk::VideoSource< TOutputVideoStream >::OutputFrameType

Definition at line 57 of file itkVideoSource.h.

template<typename TOutputVideoStream>
typedef TOutputVideoStream itk::VideoSource< TOutputVideoStream >::OutputVideoStreamType

Definition at line 55 of file itkVideoSource.h.

template<typename TOutputVideoStream>
typedef SmartPointer< Self > itk::VideoSource< TOutputVideoStream >::Pointer

Definition at line 52 of file itkVideoSource.h.

template<typename TOutputVideoStream>
typedef VideoSource itk::VideoSource< TOutputVideoStream >::Self

Standard class typedefs

Definition at line 50 of file itkVideoSource.h.

template<typename TOutputVideoStream>
typedef TemporalProcessObject itk::VideoSource< TOutputVideoStream >::Superclass

Definition at line 51 of file itkVideoSource.h.

Constructor & Destructor Documentation

template<typename TOutputVideoStream>
itk::VideoSource< TOutputVideoStream >::VideoSource ( )
protected
template<typename TOutputVideoStream>
virtual itk::VideoSource< TOutputVideoStream >::~VideoSource ( )
overrideprotectedvirtual

Member Function Documentation

template<typename TOutputVideoStream>
virtual void itk::VideoSource< TOutputVideoStream >::AfterThreadedGenerateData ( void  )
inlineprotectedvirtual

Method that gets called after all threads finish in TemporalStreamingGenerateData

Definition at line 156 of file itkVideoSource.h.

template<typename TOutputVideoStream>
virtual void itk::VideoSource< TOutputVideoStream >::AllocateOutputs ( )
protectedvirtual

The GenerateData method normally allocates the buffers for all of the outputs of a filter. Some filters may want to override this default behavior. For example, a filter may have multiple outputs with varying resolution. Or a filter may want to process data in place by grafting its input to its output.

template<typename TOutputVideoStream>
virtual void itk::VideoSource< TOutputVideoStream >::BeforeThreadedGenerateData ( void  )
inlineprotectedvirtual

Method that gets called before threads are dispatched from TemporalStreamingGeneratData

Definition at line 151 of file itkVideoSource.h.

template<typename TOutputVideoStream>
virtual::itk::LightObject::Pointer itk::VideoSource< TOutputVideoStream >::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::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >, itk::VideoToVideoFilter< itk::VideoStream< TImageToImageFilter::InputImageType >, itk::VideoStream< TImageToImageFilter::OutputImageType > >, itk::VideoToVideoFilter< TVideoStream, TVideoStream >, itk::VideoFileReader< TOutputVideoStream >, itk::FrameDifferenceVideoFilter< TInputVideoStream, TOutputVideoStream >, and itk::FrameAverageVideoFilter< TInputVideoStream, TOutputVideoStream >.

template<typename TOutputVideoStream>
virtual void itk::VideoSource< TOutputVideoStream >::GenerateOutputRequestedTemporalRegion ( TemporalDataObject output)
overrideprotectedvirtual

Override GenerateOutputRequestedTemporalRegion to make sure that if the requested temporal region is not set, it gets set to the largest possible temporal region (using TemporalProcessObject's implementation) and the output has enough frame buffer slots to hold the entire request. We don't want the number of buffers to be changed for mid-pipeline filters since they will usually operate on fewer frames than requested at any given time. The solution is to only change the number of buffers if the requested temporal region was unset at the beginning of the call since mid-pipeline filters will always have their outputs' requested spatial regions set by the GenerateInputRequestedRegion call from the filter one further down the pipeline.

Reimplemented from itk::TemporalProcessObject.

template<typename TOutputVideoStream>
virtual const char* itk::VideoSource< TOutputVideoStream >::GetNameOfClass ( ) const
virtual
template<typename TOutputVideoStream>
OutputVideoStreamType* itk::VideoSource< TOutputVideoStream >::GetOutput ( )

GetOutput() returns a pointer to the VideoStream on output port 0. This is analogous to the GetOutput on ImageSource and will be used to pass VideoStream data between TemporalProcessObjects (typically video filters)

template<typename TOutputVideoStream>
OutputVideoStreamType* itk::VideoSource< TOutputVideoStream >::GetOutput ( unsigned int  idx)
template<typename TOutputVideoStream>
static unsigned int itk::VideoSource< TOutputVideoStream >::GetOutputFrameDimension ( )
inlinestatic

Access the spacial dimensionality of the frames

Definition at line 75 of file itkVideoSource.h.

template<typename TOutputVideoStream>
virtual void itk::VideoSource< TOutputVideoStream >::GraftNthOutput ( unsigned int  idx,
OutputVideoStreamType output 
)
virtual

Graft the provided VideoStream onto the TemporalProcessObject's idx'th output using VideoStream's Graft implementation

template<typename TOutputVideoStream>
virtual void itk::VideoSource< TOutputVideoStream >::GraftOutput ( OutputVideoStreamType output)
virtual

Graft the provided VideoStream onto the 0th output. This is useful for ImageSources that use a mini-pipeline internally. See comment in ImageSource for more information.

template<typename TOutputVideoStream>
virtual DataObjectPointer itk::VideoSource< TOutputVideoStream >::MakeOutput ( DataObjectPointerArraySizeType  idx)
overridevirtual

Make a DataObject of the correct type to used as the specified output.

Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

template<typename TOutputVideoStream>
static Pointer itk::VideoSource< TOutputVideoStream >::New ( )
static
template<typename TOutputVideoStream>
virtual void itk::VideoSource< TOutputVideoStream >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual
template<typename TOutputVideoStream>
virtual int itk::VideoSource< TOutputVideoStream >::SplitRequestedSpatialRegion ( int  i,
int  num,
OutputFrameSpatialRegionType splitRegion 
)
protectedvirtual

This method functions like SplitRequestedRegion in ImageSource and is used by the implementation of TemporalStreamingGenerateData to dispatch threads that call ThreadedGenerateData.

template<typename TOutputVideoStream>
virtual void itk::VideoSource< TOutputVideoStream >::TemporalStreamingGenerateData ( )
overrideprotectedvirtual

We override the default implementation of TemporalStreamingGenerateData from TemporalProcessObject to provide functionality for spatial streaming. This implementation works exactly the same way as the implementation of GenerateData in ImageSource. The filter-specific implementation of ThreadedGenerateData will be responsible of accessing the correct frames.

Reimplemented from itk::TemporalProcessObject.

Reimplemented in itk::VideoFileReader< TOutputVideoStream >, and itk::ImageFilterToVideoFilterWrapper< TImageToImageFilter >.

template<typename TOutputVideoStream>
virtual void itk::VideoSource< TOutputVideoStream >::ThreadedGenerateData ( const OutputFrameSpatialRegionType outputRegionForThread,
int  threadId 
)
protectedvirtual

ThreadedGenerateData here serves the same symnatic purpose as ThreadedGenerateData in ProcessObjects that handle Images. This is to say that ThreadedGenerateData is in charge of performing a single algorithmic operation on a portion of the requested region. The difference will come in the implementation of each filter. Subclass implementations must access the passed spatial region across the desired number of frames in the buffered TemporalRegion of the input.

WARNING: subclasses may need to handle the case where different frames have different spatial dimensions and thus some frames may not be accessible at the requested spatial region.

Reimplemented in itk::FrameDifferenceVideoFilter< TInputVideoStream, TOutputVideoStream >, and itk::FrameAverageVideoFilter< TInputVideoStream, TOutputVideoStream >.

template<typename TOutputVideoStream>
static ITK_THREAD_RETURN_TYPE itk::VideoSource< TOutputVideoStream >::ThreaderCallback ( void *  arg)
staticprotected

Static thread callback function for the MultiThreader. This gives control to ThreadedGenerateData().

Member Data Documentation

template<typename TOutputVideoStream>
const unsigned int itk::VideoSource< TOutputVideoStream >::OutputFrameDimension = OutputFrameType::ImageDimension
static

Access the spacial dimensionality of the frames

Definition at line 74 of file itkVideoSource.h.


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