ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions
itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream > Class Template Reference

#include <itkVideoToVideoFilter.h>

+ Inheritance diagram for itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >:
+ Collaboration diagram for itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef WeakPointer< const SelfConstWeakPointer
typedef
InputVideoStreamType::DirectionType 
InputFrameDirectionType
typedef
InputVideoStreamType::IndexType 
InputFrameIndexType
typedef
InputVideoStreamType::PixelType 
InputFramePixelType
typedef
InputVideoStreamType::PointType 
InputFramePointType
typedef
InputVideoStreamType::SizeType 
InputFrameSizeType
typedef
InputVideoStreamType::SpacingType 
InputFrameSpacingType
typedef
InputVideoStreamType::SpatialRegionType 
InputFrameSpatialRegionType
typedef
InputVideoStreamType::FrameType 
InputFrameType
typedef TInputVideoStream InputVideoStreamType
typedef
Superclass::OutputFrameSpatialRegionType 
OutputFrameSpatialRegionType
typedef Superclass::OutputFrameType OutputFrameType
typedef TOutputVideoStream OutputVideoStreamType
typedef SmartPointer< SelfPointer
typedef VideoToVideoFilter
< InputVideoStreamType,
OutputVideoStreamType
Self
typedef VideoSource
< OutputVideoStreamType
Superclass
- Public Types inherited from itk::VideoSource< TOutputVideoStream >
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
- Public Types inherited from itk::TemporalProcessObject
- Public Types inherited from itk::ProcessObject
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
typedef DataObject::Pointer DataObjectPointer
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
typedef std::vector
< DataObjectIdentifierType
NameArray
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
const InputVideoStreamTypeGetInput () const
const InputVideoStreamTypeGetInput (unsigned int idx) const
virtual const char * GetNameOfClass () const
virtual void SetInput (const InputVideoStreamType *videoStream)
virtual void SetInput (unsigned int idx, const InputVideoStreamType *videoStream)
virtual void UpdateOutputInformation ()
- Public Member Functions inherited from itk::VideoSource< TOutputVideoStream >
OutputVideoStreamTypeGetOutput ()
OutputVideoStreamTypeGetOutput (unsigned int idx)
virtual void GraftNthOutput (unsigned int idx, OutputVideoStreamType *output)
virtual void GraftOutput (OutputVideoStreamType *output)
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
- Public Member Functions inherited from itk::TemporalProcessObject
virtual void EnlargeOutputRequestedRegion (DataObject *output)
virtual void GenerateData ()
virtual SizeValueType GetUnitInputNumberOfFrames ()
virtual SizeValueType GetUnitOutputNumberOfFrames ()
virtual void UpdateOutputData (DataObject *output)
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
virtual void AbortGenerateDataOn ()
virtual const bool & GetAbortGenerateData ()
NameArray GetInputNames () const
MultiThreader * GetMultiThreader () const
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType GetNumberOfInputs () const
DataObjectPointerArraySizeType GetNumberOfOutputs () const
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
NameArray GetOutputNames () const
virtual const float & GetProgress ()
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 SetProgress (float _arg)
virtual void Update ()
virtual void UpdateLargestPossibleRegion ()
void UpdateProgress (float amount)
DataObjectPointerArray GetInputs ()
DataObjectPointerArray GetOutputs ()
DataObjectPointerArray GetIndexedInputs ()
DataObjectPointerArray GetIndexedOutputs ()
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
virtual void SetReleaseDataFlag (bool flag)
virtual bool GetReleaseDataFlag () const
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool & GetReleaseDataBeforeUpdateFlag ()
virtual void ReleaseDataBeforeUpdateFlagOn ()
virtual void ReleaseDataBeforeUpdateFlagOff ()
virtual void SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdTypeGetNumberOfThreads ()
- 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 (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long 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
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () 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 unsigned int GetOutputFrameDimension ()

Protected Member Functions

virtual void BeforeTemporalStreamingGenerateData ()
virtual void GenerateInputRequestedRegion ()
virtual void GenerateOutputRequestedRegion (DataObject *output)
InputVideoStreamTypeGetInput ()
InputVideoStreamTypeGetInput (unsigned int idx)
virtual void PrintSelf (std::ostream &os, Indent indent) const
 VideoToVideoFilter ()
virtual ~VideoToVideoFilter ()
- Protected Member Functions inherited from itk::VideoSource< TOutputVideoStream >
virtual void AfterThreadedGenerateData ()
virtual void AllocateOutputs ()
virtual void BeforeThreadedGenerateData ()
virtual void GenerateOutputRequestedTemporalRegion (TemporalDataObject *output)
virtual int SplitRequestedSpatialRegion (int i, int num, OutputFrameSpatialRegionType &splitRegion)
virtual void TemporalStreamingGenerateData ()
virtual void ThreadedGenerateData (const OutputFrameSpatialRegionType &outputRegionForThread, int threadId)
 VideoSource ()
virtual ~VideoSource ()
- Protected Member Functions inherited from itk::TemporalProcessObject
virtual void AfterTemporalStreamingGenerateData ()
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 ()
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
virtual void AddOutput (DataObject *output)
bool AddRequiredInputName (const DataObjectIdentifierType &)
virtual void CacheInputReleaseDataFlags ()
virtual void GenerateOutputInformation ()
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
bool IsIndexedName (const DataObjectIdentifierType &) const
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType MakeNameFromIndex (DataObjectPointerArraySizeType) const
 ProcessObject ()
virtual void PropagateResetPipeline ()
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 ()
DataObjectGetInput (const DataObjectIdentifierType &key)
const DataObjectGetInput (const DataObjectIdentifierType &key) const
DataObjectGetInput (DataObjectPointerArraySizeType)
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryInput ()
const DataObjectGetPrimaryInput () const
DataObjectGetOutput (const DataObjectIdentifierType &key)
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryOutput ()
const DataObjectGetPrimaryOutput () const
virtual void PushBackInput (const DataObject *input)
virtual void PopBackInput ()
virtual void PushFrontInput (const DataObject *input)
virtual void PopFrontInput ()
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object ()
- 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 ()

Private Member Functions

void operator= (const Self &)
 VideoToVideoFilter (const Self &)

Additional Inherited Members

static const unsigned int OutputFrameDimension = OutputFrameType::ImageDimension
- Static Protected Member Functions inherited from itk::VideoSource< TOutputVideoStream >
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)

Detailed Description

template<class TInputVideoStream, class TOutputVideoStream>
class itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >

Base class for filters that use a VideoStream as input and output.

VideoToVideoFilter is the base class for all process objects that output VideoStream data and requre VideoStream data as input. This class defines the SetInput() method for setting the input to a filter.

An implementation of GenerateInputRequestedRegion() is provided here that uses the implementation from TemporalProcessObject to generate input temporal regions and then provides its own mechanism for generating input spatial regions. The default implementation simply takes the requested spatial region from the first frame of output and uses that as the requested region for each of the input frames.

Definition at line 44 of file itkVideoToVideoFilter.h.


Member Typedef Documentation

template<class TInputVideoStream, class TOutputVideoStream>
typedef SmartPointer< const Self > itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::ConstPointer
template<class TInputVideoStream, class TOutputVideoStream>
typedef WeakPointer< const Self > itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::ConstWeakPointer
template<class TInputVideoStream, class TOutputVideoStream>
typedef InputVideoStreamType::DirectionType itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputFrameDirectionType

Definition at line 72 of file itkVideoToVideoFilter.h.

template<class TInputVideoStream, class TOutputVideoStream>
typedef InputVideoStreamType::IndexType itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputFrameIndexType

Definition at line 67 of file itkVideoToVideoFilter.h.

template<class TInputVideoStream, class TOutputVideoStream>
typedef InputVideoStreamType::PixelType itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputFramePixelType

Definition at line 68 of file itkVideoToVideoFilter.h.

template<class TInputVideoStream, class TOutputVideoStream>
typedef InputVideoStreamType::PointType itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputFramePointType

Definition at line 69 of file itkVideoToVideoFilter.h.

template<class TInputVideoStream, class TOutputVideoStream>
typedef InputVideoStreamType::SizeType itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputFrameSizeType

Definition at line 71 of file itkVideoToVideoFilter.h.

template<class TInputVideoStream, class TOutputVideoStream>
typedef InputVideoStreamType::SpacingType itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputFrameSpacingType

Definition at line 70 of file itkVideoToVideoFilter.h.

template<class TInputVideoStream, class TOutputVideoStream>
typedef InputVideoStreamType::SpatialRegionType itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputFrameSpatialRegionType
template<class TInputVideoStream, class TOutputVideoStream>
typedef InputVideoStreamType::FrameType itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputFrameType
template<class TInputVideoStream, class TOutputVideoStream>
typedef TInputVideoStream itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputVideoStreamType
template<class TInputVideoStream, class TOutputVideoStream>
typedef Superclass::OutputFrameSpatialRegionType itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::OutputFrameSpatialRegionType
template<class TInputVideoStream, class TOutputVideoStream>
typedef Superclass::OutputFrameType itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::OutputFrameType
template<class TInputVideoStream, class TOutputVideoStream>
typedef TOutputVideoStream itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::OutputVideoStreamType
template<class TInputVideoStream, class TOutputVideoStream>
typedef SmartPointer< Self > itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::Pointer
template<class TInputVideoStream, class TOutputVideoStream>
typedef VideoToVideoFilter< InputVideoStreamType, OutputVideoStreamType > itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::Self
template<class TInputVideoStream, class TOutputVideoStream>
typedef VideoSource< OutputVideoStreamType > itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::Superclass

Constructor & Destructor Documentation

template<class TInputVideoStream, class TOutputVideoStream>
itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::VideoToVideoFilter ( )
protected
template<class TInputVideoStream, class TOutputVideoStream>
virtual itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::~VideoToVideoFilter ( )
protectedvirtual
template<class TInputVideoStream, class TOutputVideoStream>
itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::VideoToVideoFilter ( const Self )
private

Member Function Documentation

template<class TInputVideoStream, class TOutputVideoStream>
virtual void itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::BeforeTemporalStreamingGenerateData ( )
protectedvirtual

Method that gets called before individual temporal requests are dispatched by GenerateData. The default implementation makes sure that the input's buffer can hold enough frames for a single input request.

Reimplemented from itk::TemporalProcessObject.

template<class TInputVideoStream, class TOutputVideoStream>
virtual::itk::LightObject::Pointer itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::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::VideoSource< TOutputVideoStream >.

Reimplemented in itk::ImageFilterToVideoFilterWrapper< TImageToImageFilter >, itk::FrameDifferenceVideoFilter< TInputVideoStream, TOutputVideoStream >, itk::FrameAverageVideoFilter< TInputVideoStream, TOutputVideoStream >, and itk::DecimateFramesVideoFilter< TVideoStream >.

template<class TInputVideoStream, class TOutputVideoStream>
virtual void itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::GenerateInputRequestedRegion ( )
protectedvirtual

Extend the default implementation of GenerateInputRequestedRegion from TemporalProcessObject to propagate spatial regions as well as temporal regions. This default implementation takes the requested spatial region from the first requested output frame and applies it to all of the requested input frames.

Reimplemented from itk::TemporalProcessObject.

template<class TInputVideoStream, class TOutputVideoStream>
virtual void itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::GenerateOutputRequestedRegion ( DataObject output)
protectedvirtual

Override GenerateOutputRequestedRegion to handle the case where no requested spatial region has been set for the frames. By default, we set the requested spatial region of each frame to be its largest possible spatial region.

Reimplemented from itk::TemporalProcessObject.

template<class TInputVideoStream, class TOutputVideoStream>
const InputVideoStreamType* itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::GetInput ( ) const

Get the input VideoSream for this temporal process object

template<class TInputVideoStream, class TOutputVideoStream>
const InputVideoStreamType* itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::GetInput ( unsigned int  idx) const
template<class TInputVideoStream, class TOutputVideoStream>
InputVideoStreamType* itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::GetInput ( )
protected

Get a non-const version of the input for internal use when setting input's requested regions. This is the only time input should be modified

template<class TInputVideoStream, class TOutputVideoStream>
InputVideoStreamType* itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::GetInput ( unsigned int  idx)
protected
template<class TInputVideoStream, class TOutputVideoStream>
virtual const char* itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::GetNameOfClass ( ) const
virtual
template<class TInputVideoStream, class TOutputVideoStream>
static Pointer itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::New ( )
static
template<class TInputVideoStream, class TOutputVideoStream>
void itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::operator= ( const Self )
private
template<class TInputVideoStream, class TOutputVideoStream>
virtual void itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual
template<class TInputVideoStream, class TOutputVideoStream>
virtual void itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::SetInput ( const InputVideoStreamType videoStream)
virtual
template<class TInputVideoStream, class TOutputVideoStream>
virtual void itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::SetInput ( unsigned int  idx,
const InputVideoStreamType videoStream 
)
virtual
template<class TInputVideoStream, class TOutputVideoStream>
virtual void itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::UpdateOutputInformation ( )
virtual

Extend UpdateOutputInformation to propagate largest possible spatial region as well as temporal region. The default implementation here will use the largest spatial region from the first input frame to set the largest spatial region of each of the output frames. This will need to be overwritten for filters that need different behavior (eg: need edge pixels or different spatial regions for different frames)

Reimplemented from itk::TemporalProcessObject.


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