ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
itk::DecimateFramesVideoFilter< TVideoStream > Class Template Reference

#include <itkDecimateFramesVideoFilter.h>

Detailed Description

template<typename TVideoStream>
class itk::DecimateFramesVideoFilter< TVideoStream >

Reduce a video's frame-rate by keeping every Nth frame.

This filter simply takes an input video and passes every Nth frame through to the output.

Definition at line 36 of file itkDecimateFramesVideoFilter.h.

+ Inheritance diagram for itk::DecimateFramesVideoFilter< TVideoStream >:
+ Collaboration diagram for itk::DecimateFramesVideoFilter< TVideoStream >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ConstWeakPointer = WeakPointer< const Self >
 
using FrameSpatialRegionType = typename FrameType::RegionType
 
using FrameType = typename TVideoStream::FrameType
 
using InputVideoStreamType = TVideoStream
 
using OutputVideoStreamType = TVideoStream
 
using PixelType = typename FrameType::PixelType
 
using Pointer = SmartPointer< Self >
 
using Self = DecimateFramesVideoFilter< VideoStreamType >
 
using Superclass = VideoToVideoFilter< VideoStreamType, VideoStreamType >
 
using VideoStreamType = TVideoStream
 
- Public Types inherited from itk::VideoToVideoFilter< TVideoStream, TVideoStream >
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 = TVideoStream
 
using OutputVideoStreamType = TVideoStream
 
using Pointer = SmartPointer< Self >
 
using Self = VideoToVideoFilter< InputVideoStreamType, OutputVideoStreamType >
 
using Superclass = VideoSource< OutputVideoStreamType >
 
- Public Types inherited from itk::VideoSource< TVideoStream >
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 = TVideoStream
 
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 SetPreservedFrameSpacing (SizeValueType numFrames)
 
SizeValueType GetPreservedFrameSpacing ()
 
- Public Member Functions inherited from itk::VideoToVideoFilter< TVideoStream, TVideoStream >
const InputVideoStreamTypeGetInput () const
 
const InputVideoStreamTypeGetInput (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< TVideoStream >
OutputVideoStreamTypeGetOutput ()
 
OutputVideoStreamTypeGetOutput (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
 
virtual SizeValueType GetUnitInputNumberOfFrames ()
 
virtual SizeValueType GetUnitOutputNumberOfFrames ()
 
void UpdateOutputData (DataObject *output) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
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 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 ()
 
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 ThreadIdTypeGetNumberOfWorkUnits () const
 
- 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType 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
 
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
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::VideoToVideoFilter< TVideoStream, TVideoStream >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::VideoSource< TVideoStream >
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 FrameSpatialRegionType &outputRegionForThread, int threadId) override
 
 DecimateFramesVideoFilter ()
 
 ~DecimateFramesVideoFilter () override=default
 
- Protected Member Functions inherited from itk::VideoToVideoFilter< TVideoStream, TVideoStream >
void BeforeTemporalStreamingGenerateData () override
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputRequestedRegion (DataObject *output) override
 
InputVideoStreamTypeGetInput ()
 
InputVideoStreamTypeGetInput (unsigned int idx)
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 VideoToVideoFilter ()
 
 ~VideoToVideoFilter () override=default
 
- Protected Member Functions inherited from itk::VideoSource< TVideoStream >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
void GenerateOutputRequestedTemporalRegion (TemporalDataObject *output) 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 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< TemporalRegionSplitRequestedTemporalRegion ()
 
 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 GenerateOutputInformation ()
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () 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 ()
 
 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 () ITKv5_CONST
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () 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
 
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 PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Additional Inherited Members

- Static Public Attributes inherited from itk::VideoSource< TVideoStream >
static constexpr unsigned int OutputFrameDimension
 
- Static Protected Member Functions inherited from itk::VideoSource< TVideoStream >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
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 TVideoStream >
using itk::DecimateFramesVideoFilter< TVideoStream >::ConstPointer = SmartPointer<const Self>

Definition at line 48 of file itkDecimateFramesVideoFilter.h.

◆ ConstWeakPointer

template<typename TVideoStream >
using itk::DecimateFramesVideoFilter< TVideoStream >::ConstWeakPointer = WeakPointer<const Self>

Definition at line 49 of file itkDecimateFramesVideoFilter.h.

◆ FrameSpatialRegionType

template<typename TVideoStream >
using itk::DecimateFramesVideoFilter< TVideoStream >::FrameSpatialRegionType = typename FrameType::RegionType

Definition at line 53 of file itkDecimateFramesVideoFilter.h.

◆ FrameType

template<typename TVideoStream >
using itk::DecimateFramesVideoFilter< TVideoStream >::FrameType = typename TVideoStream::FrameType

Definition at line 51 of file itkDecimateFramesVideoFilter.h.

◆ InputVideoStreamType

template<typename TVideoStream >
using itk::DecimateFramesVideoFilter< TVideoStream >::InputVideoStreamType = TVideoStream

Definition at line 43 of file itkDecimateFramesVideoFilter.h.

◆ OutputVideoStreamType

template<typename TVideoStream >
using itk::DecimateFramesVideoFilter< TVideoStream >::OutputVideoStreamType = TVideoStream

Definition at line 44 of file itkDecimateFramesVideoFilter.h.

◆ PixelType

template<typename TVideoStream >
using itk::DecimateFramesVideoFilter< TVideoStream >::PixelType = typename FrameType::PixelType

Definition at line 52 of file itkDecimateFramesVideoFilter.h.

◆ Pointer

template<typename TVideoStream >
using itk::DecimateFramesVideoFilter< TVideoStream >::Pointer = SmartPointer<Self>

Definition at line 47 of file itkDecimateFramesVideoFilter.h.

◆ Self

template<typename TVideoStream >
using itk::DecimateFramesVideoFilter< TVideoStream >::Self = DecimateFramesVideoFilter<VideoStreamType>

Definition at line 45 of file itkDecimateFramesVideoFilter.h.

◆ Superclass

template<typename TVideoStream >
using itk::DecimateFramesVideoFilter< TVideoStream >::Superclass = VideoToVideoFilter<VideoStreamType, VideoStreamType>

Definition at line 46 of file itkDecimateFramesVideoFilter.h.

◆ VideoStreamType

template<typename TVideoStream >
using itk::DecimateFramesVideoFilter< TVideoStream >::VideoStreamType = TVideoStream

Standard class type aliases

Definition at line 42 of file itkDecimateFramesVideoFilter.h.

Constructor & Destructor Documentation

◆ DecimateFramesVideoFilter()

template<typename TVideoStream >
itk::DecimateFramesVideoFilter< TVideoStream >::DecimateFramesVideoFilter ( )
protected

Constructor and Destructor

◆ ~DecimateFramesVideoFilter()

template<typename TVideoStream >
itk::DecimateFramesVideoFilter< TVideoStream >::~DecimateFramesVideoFilter ( )
overrideprotecteddefault

Constructor and Destructor

Member Function Documentation

◆ GetNameOfClass()

template<typename TVideoStream >
const char* itk::DecimateFramesVideoFilter< TVideoStream >::GetNameOfClass ( ) const
overridevirtual

◆ GetPreservedFrameSpacing()

template<typename TVideoStream >
SizeValueType itk::DecimateFramesVideoFilter< TVideoStream >::GetPreservedFrameSpacing ( )

Get/Set the spacing of the preserved frames

◆ New()

template<typename TVideoStream >
static Pointer itk::DecimateFramesVideoFilter< TVideoStream >::New ( )
static

◆ PrintSelf()

template<typename TVideoStream >
void itk::DecimateFramesVideoFilter< TVideoStream >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

PrintSelf

Reimplemented from itk::TemporalProcessObject.

◆ SetPreservedFrameSpacing()

template<typename TVideoStream >
void itk::DecimateFramesVideoFilter< TVideoStream >::SetPreservedFrameSpacing ( SizeValueType  numFrames)

Get/Set the spacing of the preserved frames

◆ ThreadedGenerateData()

template<typename TVideoStream >
void itk::DecimateFramesVideoFilter< TVideoStream >::ThreadedGenerateData ( const FrameSpatialRegionType outputRegionForThread,
int  threadId 
)
overrideprotected

DecimateFramesVideoFilter is implemented as a temporal streaming and spatially multithreaded filter, so we override ThreadedGenerateData


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