#include <itkFrameAverageVideoFilter.h>

Detailed Description

template<typename TInputVideoStream, typename TOutputVideoStream>
class itk::FrameAverageVideoFilter< TInputVideoStream, TOutputVideoStream >

Average frames over a designated range in a video.

This filter computes the average of X frames at once from an input video. It processes one frame forward at a time.

Definition at line 36 of file itkFrameAverageVideoFilter.h.

Inheritance diagram for itk::FrameAverageVideoFilter< TInputVideoStream, TOutputVideoStream >:

Collaboration diagram for itk::FrameAverageVideoFilter< TInputVideoStream, TOutputVideoStream >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	ConstWeakPointer = WeakPointer< const Self >

using	InputFrameSpatialRegionType = typename InputFrameType::RegionType

using	InputFrameType = typename TInputVideoStream::FrameType

using	InputPixelType = typename InputFrameType::PixelType

using	InputVideoStreamType = TInputVideoStream

using	OutputFrameSpatialRegionType = typename OutputFrameType::RegionType

using	OutputFrameType = typename TOutputVideoStream::FrameType

using	OutputPixelType = typename OutputFrameType::PixelType

using	OutputVideoStreamType = TOutputVideoStream

using	Pointer = SmartPointer< Self >

using	Self = FrameAverageVideoFilter< InputVideoStreamType, OutputVideoStreamType >

using	Superclass = VideoToVideoFilter< InputVideoStreamType, OutputVideoStreamType >

Public Types inherited from itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >
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 char *	GetNameOfClass () const override


void	SetNumberOfFrames (SizeValueType numFrames)

SizeValueType	GetNumberOfFrames ()

Public Member Functions inherited from itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >
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::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >
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	PrintSelf (std::ostream &os, Indent indent) const override

void	ThreadedGenerateData (const OutputFrameSpatialRegionType &outputRegionForThread, int threadId) override


	FrameAverageVideoFilter ()

	~FrameAverageVideoFilter () override=default

Protected Member Functions inherited from itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >
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 {}