ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::TemporalProcessObject Class Reference
Group Video » Module ITKVideoCore

#include <itkTemporalProcessObject.h>

+ Inheritance diagram for itk::TemporalProcessObject:
+ Collaboration diagram for itk::TemporalProcessObject:

Public Types

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

void EnlargeOutputRequestedRegion (DataObject *output) override
 
void GenerateData () override
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputRequestedRegion (DataObject *output) override
 
virtual const char * GetNameOfClass () const
 
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 AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
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 PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
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 ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdType & GetNumberOfWorkUnits () const
 
MultiThreaderType * GetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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
 
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 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 void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

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
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (const DataObjectIdentifierType &key) const
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *object)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
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
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *object)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void GenerateOutputInformation ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
- 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

OffsetValueType m_FrameSkipPerOutput { 1 }
 
SizeValueType m_InputStencilCurrentFrameIndex { 0 }
 
SizeValueType m_UnitInputNumberOfFrames { 1 }
 
SizeValueType m_UnitOutputNumberOfFrames { 1 }
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Additional Inherited Members

- 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 ()
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 

Detailed Description

TemporalProcessObject implements a ProcessObject for the itk pipeline with the notion of a temporal region.

TemporalProcessObject acts as a pass-through in the inheritance tree in order to require that subclasses properly implement handling of temporal regions. The key parameters of a temporal process object are:

m_UnitInputNumberOfFrames m_UnitOutputNumberOfFrames m_FrameSkipPerOutput m_InputStencilCurrentFrameIndex

These parameters are protected by default so that the filter writer can choose which to expose and which to keep constant. For a full explanation of each parameter, see the individual comments with their declarations. Subclasses of TemporalProcessObject must implement one of the following:

GenerateData() TemporalStreamingGenerateData()

By default, GenerateData will split the requested temporal region of the input and output temporal data objects into sub-requests of unit input and unit output size. For example, if the output requests 3 frames and the filter has unit input size of 2 and unit output size of 1, GenerateData will produce 3 sub-requests that each require the input to provide 2 frames. Using this default behavior, TemporalStreamingGenerateData must be implemented and can assume that the RequestedTemporalRegion on the input and output are unit size. If the temporal streaming behavior is not desired, GenerateData can be implemented to directly handle the full output requested temporal region in a single pass.

Definition at line 66 of file itkTemporalProcessObject.h.

Member Typedef Documentation

◆ ConstPointer

using itk::TemporalProcessObject::ConstPointer = SmartPointer<const Self>

Definition at line 77 of file itkTemporalProcessObject.h.

◆ Pointer

using itk::TemporalProcessObject::Pointer = SmartPointer<Self>

Definition at line 76 of file itkTemporalProcessObject.h.

◆ Self

using itk::TemporalProcessObject::Self = TemporalProcessObject

Standard class type aliases

Definition at line 74 of file itkTemporalProcessObject.h.

◆ Superclass

using itk::TemporalProcessObject::Superclass = ProcessObject

Definition at line 75 of file itkTemporalProcessObject.h.

Constructor & Destructor Documentation

◆ TemporalProcessObject()

itk::TemporalProcessObject::TemporalProcessObject ( )
protected

Constructor that initializes members

◆ ~TemporalProcessObject()

itk::TemporalProcessObject::~TemporalProcessObject ( )
overrideprotecteddefault

Empty Destructor

Member Function Documentation

◆ AfterTemporalStreamingGenerateData()

virtual void itk::TemporalProcessObject::AfterTemporalStreamingGenerateData ( )
inlineprotectedvirtual

Method that gets called by GenerateData after TemporalStreamingGenerateData. Subclasses can override this method to provide post-processing for the data after producing the requested output temporal region.

Definition at line 217 of file itkTemporalProcessObject.h.

◆ BeforeTemporalStreamingGenerateData()

virtual void itk::TemporalProcessObject::BeforeTemporalStreamingGenerateData ( )
inlineprotectedvirtual

Method that gets called by GenerateData before TemporalStreamingGenerateData. Subclasses can override this method to provide pre-processing for the data before splitting up the requested output temporal region.

Reimplemented in itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >, itk::VideoToVideoFilter< itk::VideoStream< TImageToImageFilter::InputImageType >, itk::VideoStream< TImageToImageFilter::OutputImageType > >, and itk::VideoToVideoFilter< TVideoStream, TVideoStream >.

Definition at line 209 of file itkTemporalProcessObject.h.

◆ EnlargeOutputRequestedRegion()

void itk::TemporalProcessObject::EnlargeOutputRequestedRegion ( DataObject *  output)
overridevirtual

Override EnlargeOutputRequestedRegion, GenerateOutputRequestedRegion, and GenerateInputRequestedRegion to handle temporal regions

Reimplemented from itk::ProcessObject.

◆ EnlargeOutputRequestedTemporalRegion()

virtual void itk::TemporalProcessObject::EnlargeOutputRequestedTemporalRegion ( TemporalDataObject *  output)
protectedvirtual

Explicitly handle temporal regions in EnlargeRequestedRegion. The default implementation makes sure that the output requested temporal region is contained in the buffered temporal region or has a duration that is a multiple of the unit output number of frames

◆ GenerateData()

void itk::TemporalProcessObject::GenerateData ( )
overridevirtual

Override GenerateData to do temporal region streaming. This is analogous to the ThreadedGenerateData system implemented in ImageSource, but it functions slightly differently. Since most temporal processes are going to to need more input frames than they produce output frames for a single operation, we cannot use the same model as spatial streaming which assumes that the input requested region is fully populated before producing any output. Instead, once we have split the requested output region, we reset the requested temporal region of the input to each input requested temporal sub-region (in sequence) and re-propagate the temporal region request up the pipeline.

Reimplemented from itk::ProcessObject.

◆ GenerateDefaultLargestPossibleTemporalRegion()

virtual TemporalRegion itk::TemporalProcessObject::GenerateDefaultLargestPossibleTemporalRegion ( )
protectedvirtual

Generate a default LargestPossibleRegion. This is used by temporal process objects that have no input. The default implementation starts at frame 0 and has infinite duration.

◆ GenerateInputRequestedRegion()

void itk::TemporalProcessObject::GenerateInputRequestedRegion ( )
overridevirtual

What is the input requested region that is required to produce the output requested region? By default, the largest possible region is always required but this is overridden in many subclasses. For instance, for an image processing filter where an output pixel is a simple function of an input pixel, the input requested region will be set to the output requested region. For an image processing filter where an output pixel is a function of the pixels in a neighborhood of an input pixel, then the input requested region will need to be larger than the output requested region (to avoid introducing artificial boundary conditions). This function should never request an input region that is outside the the input largest possible region (i.e. implementations of this method should crop the input requested region at the boundaries of the input largest possible region).

Reimplemented from itk::ProcessObject.

Reimplemented in itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >, itk::VideoToVideoFilter< itk::VideoStream< TImageToImageFilter::InputImageType >, itk::VideoStream< TImageToImageFilter::OutputImageType > >, and itk::VideoToVideoFilter< TVideoStream, TVideoStream >.

◆ GenerateInputRequestedTemporalRegion()

virtual void itk::TemporalProcessObject::GenerateInputRequestedTemporalRegion ( )
protectedvirtual

Explicitly handle temporal regions in GenerateInputRequestedRegion. The default implementation sets the requested temporal region on the input to start at m_FrameSkipPerOutput times the start frame of the requested output temporal region with the duration needed to produce the entire requested output.

NOTE: This default propagation will be overwritten during the UpdateOutputData phase by the temporal streaming mechanism if a subclass implements TemporalStreamingGenerateData, but this propagation is provided so that subclasses which directly implement GenerateData will work correctly.

◆ GenerateOutputRequestedRegion()

void itk::TemporalProcessObject::GenerateOutputRequestedRegion ( DataObject *  output)
overridevirtual

Given one output whose requested region has been set, how should the requested regions for the remaining outputs of the process object be set? By default, all the outputs are set to the same requested region. If a filter needs to produce different requested regions for each output, for instance an image processing filter producing several outputs at different resolutions, then that filter may override this method and set the requested regions appropriately.

Note that a filter producing multiple outputs of different types is required to override this method. The default implementation can only correctly handle multiple outputs of the same type.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >, itk::VideoToVideoFilter< itk::VideoStream< TImageToImageFilter::InputImageType >, itk::VideoStream< TImageToImageFilter::OutputImageType > >, and itk::VideoToVideoFilter< TVideoStream, TVideoStream >.

◆ GenerateOutputRequestedTemporalRegion()

virtual void itk::TemporalProcessObject::GenerateOutputRequestedTemporalRegion ( TemporalDataObject *  output)
protectedvirtual

Explicitly handle temporal regions in GeneratOutputRegion. The default implementation checks to see if a request is currently set and if not, it sets the requested temporal region to match the largest possible temporal region

Note: If the largest possible temporal duration has infinite duration, the requested temporal region will be set to have duration 1.

Reimplemented in itk::VideoSource< TOutputVideoStream >, itk::VideoSource< TVideoStream >, and itk::VideoSource< itk::VideoStream< TImageToImageFilter::OutputImageType > >.

◆ GetInputStencilCurrentFrameIndex()

virtual SizeValueType itk::TemporalProcessObject::GetInputStencilCurrentFrameIndex ( )
protectedvirtual

◆ GetNameOfClass()

virtual const char* itk::TemporalProcessObject::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

Reimplemented in itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >, itk::VideoFileReader< TOutputVideoStream >, itk::VideoToVideoFilter< itk::VideoStream< TImageToImageFilter::InputImageType >, itk::VideoStream< TImageToImageFilter::OutputImageType > >, itk::VideoToVideoFilter< TVideoStream, TVideoStream >, itk::VideoSource< TOutputVideoStream >, itk::VideoSource< TVideoStream >, itk::VideoSource< itk::VideoStream< TImageToImageFilter::OutputImageType > >, itk::VideoFileWriter< TInputVideoStream >, itk::ImageFilterToVideoFilterWrapper< TImageToImageFilter >, itk::FrameDifferenceVideoFilter< TInputVideoStream, TOutputVideoStream >, itk::FrameAverageVideoFilter< TInputVideoStream, TOutputVideoStream >, and itk::DecimateFramesVideoFilter< TVideoStream >.

◆ GetUnitInputNumberOfFrames()

virtual SizeValueType itk::TemporalProcessObject::GetUnitInputNumberOfFrames ( )
virtual

Get the number of frames of input required to produce output. We don't provide a Set method because we want some filters to be able to hold this as a constant.

◆ GetUnitOutputNumberOfFrames()

virtual SizeValueType itk::TemporalProcessObject::GetUnitOutputNumberOfFrames ( )
virtual

Get the number of frames of output produced for a single set of input frames. We don't provide a Set method because we want some filters to be able to hold this as a constant.

◆ PrintSelf()

void itk::TemporalProcessObject::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

ITK print mechanism

Reimplemented from itk::ProcessObject.

Reimplemented in itk::VideoSource< TOutputVideoStream >, itk::VideoSource< TVideoStream >, itk::VideoSource< itk::VideoStream< TImageToImageFilter::OutputImageType > >, itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >, itk::VideoToVideoFilter< itk::VideoStream< TImageToImageFilter::InputImageType >, itk::VideoStream< TImageToImageFilter::OutputImageType > >, itk::VideoToVideoFilter< TVideoStream, TVideoStream >, itk::VideoFileWriter< TInputVideoStream >, itk::VideoFileReader< TOutputVideoStream >, itk::FrameDifferenceVideoFilter< TInputVideoStream, TOutputVideoStream >, itk::ImageFilterToVideoFilterWrapper< TImageToImageFilter >, itk::FrameAverageVideoFilter< TInputVideoStream, TOutputVideoStream >, and itk::DecimateFramesVideoFilter< TVideoStream >.

◆ SetFrameSkipPerOutput()

virtual void itk::TemporalProcessObject::SetFrameSkipPerOutput ( OffsetValueType  _arg)
protectedvirtual

◆ SetInputStencilCurrentFrameIndex()

virtual void itk::TemporalProcessObject::SetInputStencilCurrentFrameIndex ( SizeValueType  _arg)
protectedvirtual

◆ SetUnitInputNumberOfFrames()

virtual void itk::TemporalProcessObject::SetUnitInputNumberOfFrames ( SizeValueType  _arg)
protectedvirtual

◆ SetUnitOutputNumberOfFrames()

virtual void itk::TemporalProcessObject::SetUnitOutputNumberOfFrames ( SizeValueType  _arg)
protectedvirtual

◆ SplitRequestedTemporalRegion()

virtual std::vector<TemporalRegion> itk::TemporalProcessObject::SplitRequestedTemporalRegion ( )
protectedvirtual

Split the output's RequestedTemporalRegion into the proper number of sub-regions. By default it is assumed that each sub-region processed should be generated using the set of input frames starting one frame forward in time from the previous sub-region. To change this, set FrameSkipPerOutput to something other than 1. Positive indicates forward in time while negative indicates backward in time. The set of returned TemporalRegion objects is the set of temporal regions that are needed as input to generate the entire output requested region

◆ TemporalStreamingGenerateData()

virtual void itk::TemporalProcessObject::TemporalStreamingGenerateData ( )
virtual

TemporalStreamingGenerateData is in charge of producing output for a single portion of the output requested temporal region. This is where the body of the process will take place. Subclasses that handle spatial data (such as video frames) may instead use this function to split the requested spatial region and process the spatial sub-regions using the mechanism implemented in ImageBase for multithreading.

Reimplemented in itk::VideoFileWriter< TInputVideoStream >, itk::VideoSource< TOutputVideoStream >, itk::VideoSource< TVideoStream >, itk::VideoSource< itk::VideoStream< TImageToImageFilter::OutputImageType > >, itk::VideoFileReader< TOutputVideoStream >, and itk::ImageFilterToVideoFilterWrapper< TImageToImageFilter >.

◆ UpdateOutputData()

void itk::TemporalProcessObject::UpdateOutputData ( DataObject *  output)
overridevirtual

Override ProcessObject's implementation of UpdateOutputData. This is necessary because by default ProcessObject propagates the call to its inputs before calling GenerateData. This doesn't work here because we need to adjust the requested temporal region of our inputs before calling their UpdateOutputData methods

NOTE: Subclasses that don't use the temporal streaming process must override this function to call the version implemented in ProcessObject

Code: this->ProcessObject::UpdateOutputData( output )

Reimplemented from itk::ProcessObject.

◆ UpdateOutputInformation()

void itk::TemporalProcessObject::UpdateOutputInformation ( )
overridevirtual

The default implementation of UpdateOutputInformation to handle temporal regions will compute the proper size of the output largest possible temporal region based on the largest possible temporal region of the input, the unit input/output sizes for the process, and the number of frames skipped per output

Reimplemented from itk::ProcessObject.

Reimplemented in itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >, itk::VideoToVideoFilter< itk::VideoStream< TImageToImageFilter::InputImageType >, itk::VideoStream< TImageToImageFilter::OutputImageType > >, itk::VideoToVideoFilter< TVideoStream, TVideoStream >, and itk::VideoFileReader< TOutputVideoStream >.

Member Data Documentation

◆ m_FrameSkipPerOutput

OffsetValueType itk::TemporalProcessObject::m_FrameSkipPerOutput { 1 }
protected

Number of frames to move in order to produce each set of output frames. There is no public API for this member, but subclasses can set it internally (or provide access to it) if they wish.

Definition at line 242 of file itkTemporalProcessObject.h.

◆ m_InputStencilCurrentFrameIndex

SizeValueType itk::TemporalProcessObject::m_InputStencilCurrentFrameIndex { 0 }
protected

Member to indicate the location of the "current frame" in the minimum set of input frames. For example, if the unit number of input frames is 6 and m_InputStencilCurrentFrameIndex = 4, this indicates that for output frame n, frames n-4 through n+1 are required, whereas if m_InputStencilCurrentFrameIndex = 0, frames n through n+5 are required.

Definition at line 249 of file itkTemporalProcessObject.h.

◆ m_UnitInputNumberOfFrames

SizeValueType itk::TemporalProcessObject::m_UnitInputNumberOfFrames { 1 }
protected

Members to indicate the number of input frames and output frames required to perform a single pass through the processing.

Definition at line 236 of file itkTemporalProcessObject.h.

◆ m_UnitOutputNumberOfFrames

SizeValueType itk::TemporalProcessObject::m_UnitOutputNumberOfFrames { 1 }
protected

Definition at line 237 of file itkTemporalProcessObject.h.

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.
Generated on Thu Apr 1 2021 02:34:06 for ITK by   doxygen 1.8.16