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

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

#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 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 (unsigned int idx, const InputVideoStreamType *videoStream)
virtual void SetInput (const InputVideoStreamType *videoStream)
virtual void UpdateOutputInformation ()

Static Public Member Functions

static Pointer New ()

Protected Member Functions

virtual void BeforeTemporalStreamingGenerateData ()
virtual void GenerateInputRequestedRegion ()
virtual void GenerateOutputRequestedRegion (DataObject *output)
InputVideoStreamTypeGetInput (unsigned int idx)
InputVideoStreamTypeGetInput ()
virtual void PrintSelf (std::ostream &os, Indent indent) const
 VideoToVideoFilter ()
virtual ~VideoToVideoFilter ()

Private Member Functions

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

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

Reimplemented from itk::VideoSource< TOutputVideoStream >.

Definition at line 57 of file itkVideoToVideoFilter.h.

template<class TInputVideoStream , class TOutputVideoStream >
typedef WeakPointer< const Self > itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::ConstWeakPointer

Reimplemented from itk::VideoSource< TOutputVideoStream >.

Definition at line 58 of file itkVideoToVideoFilter.h.

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

Definition at line 66 of file itkVideoToVideoFilter.h.

template<class TInputVideoStream , class TOutputVideoStream >
typedef InputVideoStreamType::FrameType itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputFrameType

Input typedefs

Definition at line 65 of file itkVideoToVideoFilter.h.

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

Standard class typedefs

Definition at line 51 of file itkVideoToVideoFilter.h.

template<class TInputVideoStream , class TOutputVideoStream >
typedef Superclass::OutputFrameSpatialRegionType itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::OutputFrameSpatialRegionType

Reimplemented from itk::VideoSource< TOutputVideoStream >.

Definition at line 62 of file itkVideoToVideoFilter.h.

template<class TInputVideoStream , class TOutputVideoStream >
typedef Superclass::OutputFrameType itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::OutputFrameType

Superclass typedefs

Reimplemented from itk::VideoSource< TOutputVideoStream >.

Definition at line 61 of file itkVideoToVideoFilter.h.

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

Reimplemented from itk::VideoSource< TOutputVideoStream >.

Definition at line 52 of file itkVideoToVideoFilter.h.

template<class TInputVideoStream , class TOutputVideoStream >
typedef SmartPointer< Self > itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::Pointer

Reimplemented from itk::VideoSource< TOutputVideoStream >.

Definition at line 56 of file itkVideoToVideoFilter.h.

template<class TInputVideoStream , class TOutputVideoStream >
typedef VideoToVideoFilter< InputVideoStreamType, OutputVideoStreamType > itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::Self

Standard class typedefs

Reimplemented from itk::VideoSource< TOutputVideoStream >.

Definition at line 54 of file itkVideoToVideoFilter.h.

template<class TInputVideoStream , class TOutputVideoStream >
typedef VideoSource< OutputVideoStreamType > itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::Superclass

Reimplemented from itk::VideoSource< TOutputVideoStream >.

Definition at line 55 of file itkVideoToVideoFilter.h.


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

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

template<class TInputVideoStream , class TOutputVideoStream >
virtual void itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::GenerateInputRequestedRegion ( ) [protected, virtual]

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

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 >
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 >
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 >
virtual const char* itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::VideoSource< TOutputVideoStream >.

template<class TInputVideoStream , class TOutputVideoStream >
static Pointer itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::VideoSource< TOutputVideoStream >.

template<class TInputVideoStream , class TOutputVideoStream >
void itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::operator= ( const Self ) [private]

Time when GenerateOutputInformation was last called.

Reimplemented from itk::VideoSource< TOutputVideoStream >.

template<class TInputVideoStream , class TOutputVideoStream >
virtual void itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

ITK print mechanism

Reimplemented from itk::VideoSource< TOutputVideoStream >.

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 >::SetInput ( 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: