ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream > Class Template Reference
Group Video » Module ITKVideoCore

#include <itkVideoToVideoFilter.h>

Detailed Description

template<typename TInputVideoStream, typename 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 require 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 45 of file itkVideoToVideoFilter.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ConstWeakPointer = WeakPointer< const Self >
 
using InputFrameDirectionType = typename InputVideoStreamType::DirectionType
 
using InputFrameIndexType = typename InputVideoStreamType::IndexType
 
using InputFramePixelType = typename InputVideoStreamType::PixelType
 
using InputFramePointType = typename InputVideoStreamType::PointType
 
using InputFrameSizeType = typename InputVideoStreamType::SizeType
 
using InputFrameSpacingType = typename InputVideoStreamType::SpacingType
 
using InputFrameSpatialRegionType = typename InputVideoStreamType::SpatialRegionType
 
using InputFrameType = typename InputVideoStreamType::FrameType
 
using InputVideoStreamType = TInputVideoStream
 
using OutputVideoStreamType = TOutputVideoStream
 
using Pointer = SmartPointer< Self >
 
using Self = VideoToVideoFilter< InputVideoStreamType, OutputVideoStreamType >
 
using Superclass = VideoSource< OutputVideoStreamType >
 
- Public Types inherited from itk::VideoSource< TOutputVideoStream >
using ConstPointer = SmartPointer< const Self >
 
using ConstWeakPointer = WeakPointer< const Self >
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 
using OutputFrameDirectionType = typename OutputVideoStreamType::DirectionType
 
using OutputFrameIndexType = typename OutputVideoStreamType::IndexType
 
using OutputFramePixelType = typename OutputVideoStreamType::PixelType
 
using OutputFramePointType = typename OutputVideoStreamType::PointType
 
using OutputFrameSizeType = typename OutputVideoStreamType::SizeType
 
using OutputFrameSpacingType = typename OutputVideoStreamType::SpacingType
 
using OutputFrameSpatialRegionType = typename OutputVideoStreamType::SpatialRegionType
 
using OutputFrameType = typename OutputVideoStreamType::FrameType
 
using OutputVideoStreamType = TOutputVideoStream
 
using Pointer = SmartPointer< Self >
 
using Self = VideoSource
 
using Superclass = TemporalProcessObject
 
- Public Types inherited from itk::TemporalProcessObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = TemporalProcessObject
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
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

const InputVideoStreamType * GetInput () const
 
const InputVideoStreamType * GetInput (unsigned int idx) const
 
const char * GetNameOfClass () const override
 
virtual void SetInput (const InputVideoStreamType *videoStream)
 
virtual void SetInput (unsigned int idx, const InputVideoStreamType *videoStream)
 
void UpdateOutputInformation () override
 
- Public Member Functions inherited from itk::VideoSource< TOutputVideoStream >
const char * GetNameOfClass () const override
 
OutputVideoStreamType * GetOutput ()
 
OutputVideoStreamType * GetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, OutputVideoStreamType *graft)
 
virtual void GraftOutput (OutputVideoStreamType *graft)
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
- Public Member Functions inherited from itk::TemporalProcessObject
void EnlargeOutputRequestedRegion (DataObject *output) override
 
void GenerateData () override
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputRequestedRegion (DataObject *output) override
 
const char * GetNameOfClass () const override
 
virtual SizeValueType GetUnitInputNumberOfFrames ()
 
virtual SizeValueType GetUnitOutputNumberOfFrames ()
 
virtual void TemporalStreamingGenerateData ()
 
void UpdateOutputData (DataObject *output) override
 
void UpdateOutputInformation () override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderType * GetMultiThreader () const
 
const char * GetNameOfClass () const override
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdType & GetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
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
 
const char * GetNameOfClass () const override
 
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) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
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
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::VideoSource< TOutputVideoStream >
static unsigned int GetOutputFrameDimension ()
 
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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void BeforeTemporalStreamingGenerateData () override
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputRequestedRegion (DataObject *output) override
 
InputVideoStreamType * GetInput ()
 
InputVideoStreamType * GetInput (unsigned int idx)
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 VideoToVideoFilter ()
 
 ~VideoToVideoFilter () override=default
 
- Protected Member Functions inherited from itk::VideoSource< TOutputVideoStream >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
void GenerateOutputRequestedTemporalRegion (TemporalDataObject *output) override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual int SplitRequestedSpatialRegion (int i, int num, OutputFrameSpatialRegionType &splitRegion)
 
void TemporalStreamingGenerateData () override
 
virtual void ThreadedGenerateData (const OutputFrameSpatialRegionType &outputRegionForThread, int threadId)
 
 VideoSource ()
 
 ~VideoSource () override=default
 
- 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 void GenerateOutputRequestedTemporalRegion (TemporalDataObject *output)
 
virtual SizeValueType GetInputStencilCurrentFrameIndex ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
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 ()
 
 ~TemporalProcessObject () override=default
 
- 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 GenerateData ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (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
 
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 ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 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 idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () const
 
virtual void VerifyPreconditions () const
 
 ~ProcessObject () override
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObject * GetOutput (const DataObjectIdentifierType &key)
 
const DataObject * GetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObject * GetOutput (DataObjectPointerArraySizeType i)
 
const DataObject * GetOutput (DataObjectPointerArraySizeType i) const
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~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 PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Additional Inherited Members

- Static Public Attributes inherited from itk::VideoSource< TOutputVideoStream >
static constexpr unsigned int OutputFrameDimension = OutputFrameType::ImageDimension
 
- Static Protected Member Functions inherited from itk::VideoSource< TOutputVideoStream >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::TemporalProcessObject
OffsetValueType m_FrameSkipPerOutput { 1 }
 
SizeValueType m_InputStencilCurrentFrameIndex { 0 }
 
SizeValueType m_UnitInputNumberOfFrames { 1 }
 
SizeValueType m_UnitOutputNumberOfFrames { 1 }
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TInputVideoStream , typename TOutputVideoStream >
using itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::ConstPointer = SmartPointer<const Self>

Definition at line 56 of file itkVideoToVideoFilter.h.

◆ ConstWeakPointer

template<typename TInputVideoStream , typename TOutputVideoStream >
using itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::ConstWeakPointer = WeakPointer<const Self>

Definition at line 57 of file itkVideoToVideoFilter.h.

◆ InputFrameDirectionType

template<typename TInputVideoStream , typename TOutputVideoStream >
using itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputFrameDirectionType = typename InputVideoStreamType::DirectionType

Definition at line 71 of file itkVideoToVideoFilter.h.

◆ InputFrameIndexType

template<typename TInputVideoStream , typename TOutputVideoStream >
using itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputFrameIndexType = typename InputVideoStreamType::IndexType

Definition at line 66 of file itkVideoToVideoFilter.h.

◆ InputFramePixelType

template<typename TInputVideoStream , typename TOutputVideoStream >
using itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputFramePixelType = typename InputVideoStreamType::PixelType

Definition at line 67 of file itkVideoToVideoFilter.h.

◆ InputFramePointType

template<typename TInputVideoStream , typename TOutputVideoStream >
using itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputFramePointType = typename InputVideoStreamType::PointType

Definition at line 68 of file itkVideoToVideoFilter.h.

◆ InputFrameSizeType

template<typename TInputVideoStream , typename TOutputVideoStream >
using itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputFrameSizeType = typename InputVideoStreamType::SizeType

Definition at line 70 of file itkVideoToVideoFilter.h.

◆ InputFrameSpacingType

template<typename TInputVideoStream , typename TOutputVideoStream >
using itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputFrameSpacingType = typename InputVideoStreamType::SpacingType

Definition at line 69 of file itkVideoToVideoFilter.h.

◆ InputFrameSpatialRegionType

template<typename TInputVideoStream , typename TOutputVideoStream >
using itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputFrameSpatialRegionType = typename InputVideoStreamType::SpatialRegionType

Definition at line 65 of file itkVideoToVideoFilter.h.

◆ InputFrameType

template<typename TInputVideoStream , typename TOutputVideoStream >
using itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputFrameType = typename InputVideoStreamType::FrameType

Input type alias

Definition at line 64 of file itkVideoToVideoFilter.h.

◆ InputVideoStreamType

template<typename TInputVideoStream , typename TOutputVideoStream >
using itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::InputVideoStreamType = TInputVideoStream

Standard class type aliases

Definition at line 51 of file itkVideoToVideoFilter.h.

◆ OutputVideoStreamType

template<typename TInputVideoStream , typename TOutputVideoStream >
using itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::OutputVideoStreamType = TOutputVideoStream

Definition at line 52 of file itkVideoToVideoFilter.h.

◆ Pointer

template<typename TInputVideoStream , typename TOutputVideoStream >
using itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::Pointer = SmartPointer<Self>

Definition at line 55 of file itkVideoToVideoFilter.h.

◆ Self

template<typename TInputVideoStream , typename TOutputVideoStream >
using itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::Self = VideoToVideoFilter<InputVideoStreamType, OutputVideoStreamType>

Definition at line 53 of file itkVideoToVideoFilter.h.

◆ Superclass

template<typename TInputVideoStream , typename TOutputVideoStream >
using itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::Superclass = VideoSource<OutputVideoStreamType>

Definition at line 54 of file itkVideoToVideoFilter.h.

Constructor & Destructor Documentation

◆ VideoToVideoFilter()

template<typename TInputVideoStream , typename TOutputVideoStream >
itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::VideoToVideoFilter ( )
protected

◆ ~VideoToVideoFilter()

template<typename TInputVideoStream , typename TOutputVideoStream >
itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::~VideoToVideoFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ BeforeTemporalStreamingGenerateData()

template<typename TInputVideoStream , typename TOutputVideoStream >
void itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::BeforeTemporalStreamingGenerateData ( )
overrideprotectedvirtual

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.

◆ GenerateInputRequestedRegion()

template<typename TInputVideoStream , typename TOutputVideoStream >
void itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::GenerateInputRequestedRegion ( )
overrideprotectedvirtual

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.

◆ GenerateOutputRequestedRegion()

template<typename TInputVideoStream , typename TOutputVideoStream >
void itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::GenerateOutputRequestedRegion ( DataObject *  output)
overrideprotectedvirtual

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.

◆ GetInput() [1/4]

template<typename TInputVideoStream , typename 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

◆ GetInput() [2/4]

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

Get the input VideoStream for this temporal process object

◆ GetInput() [3/4]

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

◆ GetInput() [4/4]

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

◆ GetNameOfClass()

template<typename TInputVideoStream , typename TOutputVideoStream >
const char * itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::VideoSource< TOutputVideoStream >.

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

◆ New()

template<typename TInputVideoStream , typename TOutputVideoStream >
static Pointer itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::New ( )
static

◆ PrintSelf()

template<typename TInputVideoStream , typename TOutputVideoStream >
void itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

ITK print mechanism

Reimplemented from itk::VideoSource< TOutputVideoStream >.

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

◆ SetInput() [1/2]

template<typename TInputVideoStream , typename TOutputVideoStream >
virtual void itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::SetInput ( const InputVideoStreamType *  videoStream)
virtual

◆ SetInput() [2/2]

template<typename TInputVideoStream , typename TOutputVideoStream >
virtual void itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::SetInput ( unsigned int  idx,
const InputVideoStreamType *  videoStream 
)
virtual

◆ UpdateOutputInformation()

template<typename TInputVideoStream , typename TOutputVideoStream >
void itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >::UpdateOutputInformation ( )
overridevirtual

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:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3