itk::DecimateFramesVideoFilter< TVideoStream > Class Template Reference

#include <itkDecimateFramesVideoFilter.h>

Inheritance diagram for itk::DecimateFramesVideoFilter< TVideoStream >:

Collaboration diagram for itk::DecimateFramesVideoFilter< TVideoStream >:

Detailed Description

template<class 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 35 of file itkDecimateFramesVideoFilter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef WeakPointer< const Self >	ConstWeakPointer
typedef FrameType::RegionType	FrameSpatialRegionType
typedef TVideoStream::FrameType	FrameType
typedef TVideoStream	InputVideoStreamType
typedef TVideoStream	OutputVideoStreamType
typedef FrameType::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef DecimateFramesVideoFilter < VideoStreamType >	Self
typedef VideoToVideoFilter < VideoStreamType, VideoStreamType >	Superclass
typedef TVideoStream	VideoStreamType
Public Types inherited from itk::VideoToVideoFilter< TVideoStream, TVideoStream >
typedef SmartPointer< const Self >	ConstPointer
typedef WeakPointer< const Self >	ConstWeakPointer
typedef InputVideoStreamType::DirectionType	InputFrameDirectionType
typedef InputVideoStreamType::IndexType	InputFrameIndexType
typedef InputVideoStreamType::PixelType	InputFramePixelType
typedef InputVideoStreamType::PointType	InputFramePointType
typedef InputVideoStreamType::SizeType	InputFrameSizeType
typedef InputVideoStreamType::SpacingType	InputFrameSpacingType
typedef InputVideoStreamType::SpatialRegionType	InputFrameSpatialRegionType
typedef InputVideoStreamType::FrameType	InputFrameType
typedef TVideoStream	InputVideoStreamType
typedef Superclass::OutputFrameSpatialRegionType	OutputFrameSpatialRegionType
typedef Superclass::OutputFrameType	OutputFrameType
typedef TVideoStream	OutputVideoStreamType
typedef SmartPointer< Self >	Pointer
typedef VideoToVideoFilter < InputVideoStreamType, OutputVideoStreamType >	Self
typedef VideoSource < OutputVideoStreamType >	Superclass
Public Types inherited from itk::VideoSource< TVideoStream >
typedef SmartPointer< const Self >	ConstPointer
typedef WeakPointer< const Self >	ConstWeakPointer
typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputVideoStreamType::DirectionType	OutputFrameDirectionType
typedef OutputVideoStreamType::IndexType	OutputFrameIndexType
typedef OutputVideoStreamType::PixelType	OutputFramePixelType
typedef OutputVideoStreamType::PointType	OutputFramePointType
typedef OutputVideoStreamType::SizeType	OutputFrameSizeType
typedef OutputVideoStreamType::SpacingType	OutputFrameSpacingType
typedef OutputVideoStreamType::SpatialRegionType	OutputFrameSpatialRegionType
typedef OutputVideoStreamType::FrameType	OutputFrameType
typedef TVideoStream	OutputVideoStreamType
typedef SmartPointer< Self >	Pointer
typedef VideoSource	Self
typedef TemporalProcessObject	Superclass
Public Types inherited from itk::TemporalProcessObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef TemporalProcessObject	Self
typedef ProcessObject	Superclass
Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef std::vector < DataObjectIdentifierType >	NameArray
typedef SmartPointer< Self >	Pointer
typedef ProcessObject	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
void	SetPreservedFrameSpacing (SizeValueType numFrames)
SizeValueType	GetPreservedFrameSpacing ()
Public Member Functions inherited from itk::VideoToVideoFilter< TVideoStream, TVideoStream >
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
const InputVideoStreamType *	GetInput () const
const InputVideoStreamType *	GetInput (unsigned int idx) const
virtual void	SetInput (const InputVideoStreamType *videoStream)
virtual void	SetInput (unsigned int idx, const InputVideoStreamType *videoStream)
virtual void	UpdateOutputInformation ()
Public Member Functions inherited from itk::VideoSource< TVideoStream >
OutputVideoStreamType *	GetOutput ()
OutputVideoStreamType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, OutputVideoStreamType *output)
virtual void	GraftOutput (OutputVideoStreamType *output)
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)
Public Member Functions inherited from itk::TemporalProcessObject
virtual void	EnlargeOutputRequestedRegion (DataObject *output)
virtual void	GenerateData ()
virtual SizeValueType	GetUnitInputNumberOfFrames ()
virtual SizeValueType	GetUnitOutputNumberOfFrames ()
virtual void	UpdateOutputData (DataObject *output)
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) 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
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
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 Pointer	New ()
static unsigned int	GetOutputFrameDimension ()

Protected Member Functions
	DecimateFramesVideoFilter ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	ThreadedGenerateData (const FrameSpatialRegionType &outputRegionForThread, int threadId)
virtual	~DecimateFramesVideoFilter ()
Protected Member Functions inherited from itk::VideoToVideoFilter< TVideoStream, TVideoStream >
virtual void	BeforeTemporalStreamingGenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
InputVideoStreamType *	GetInput ()
InputVideoStreamType *	GetInput (unsigned int idx)
	VideoToVideoFilter ()
virtual	~VideoToVideoFilter ()
Protected Member Functions inherited from itk::VideoSource< TVideoStream >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
virtual void	GenerateOutputRequestedTemporalRegion (TemporalDataObject *output)
virtual int	SplitRequestedSpatialRegion (int i, int num, OutputFrameSpatialRegionType &splitRegion)
virtual void	TemporalStreamingGenerateData ()
virtual void	ThreadedGenerateData (const OutputFrameSpatialRegionType &outputRegionForThread, int threadId)
	VideoSource ()
virtual	~VideoSource ()
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 < TemporalRegion >	SplitRequestedTemporalRegion ()
	TemporalProcessObject ()
virtual	~TemporalProcessObject ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputInformation ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedInputName (const DataObjectIdentifierType &) const
bool	IsIndexedOutputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const
DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
virtual void	VerifyInputInformation ()
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType idx)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName (void) const
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
bool	AddRequiredInputName (const DataObjectIdentifierType &)
bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
void	SetRequiredInputNames (const NameArray &)
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName (void) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
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 ()

Private Member Functions
	DecimateFramesVideoFilter (const Self &)
void	operator= (const Self &)

Additional Inherited Members
Static Public Attributes inherited from itk::VideoSource< TVideoStream >
static const unsigned int	OutputFrameDimension
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType
Static Protected Member Functions inherited from itk::VideoSource< TVideoStream >
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
Protected Attributes inherited from itk::TemporalProcessObject
OffsetValueType	m_FrameSkipPerOutput
SizeValueType	m_InputStencilCurrentFrameIndex
SizeValueType	m_UnitInputNumberOfFrames
SizeValueType	m_UnitOutputNumberOfFrames

Member Typedef Documentation

template<class TVideoStream >

typedef SmartPointer< const Self > itk::DecimateFramesVideoFilter< TVideoStream >::ConstPointer

Definition at line 48 of file itkDecimateFramesVideoFilter.h.

template<class TVideoStream >

typedef WeakPointer< const Self > itk::DecimateFramesVideoFilter< TVideoStream >::ConstWeakPointer

Definition at line 49 of file itkDecimateFramesVideoFilter.h.

template<class TVideoStream >

typedef FrameType::RegionType itk::DecimateFramesVideoFilter< TVideoStream >::FrameSpatialRegionType

Definition at line 53 of file itkDecimateFramesVideoFilter.h.

template<class TVideoStream >

typedef TVideoStream::FrameType itk::DecimateFramesVideoFilter< TVideoStream >::FrameType

Definition at line 51 of file itkDecimateFramesVideoFilter.h.

template<class TVideoStream >

typedef TVideoStream itk::DecimateFramesVideoFilter< TVideoStream >::InputVideoStreamType

Definition at line 42 of file itkDecimateFramesVideoFilter.h.

template<class TVideoStream >

typedef TVideoStream itk::DecimateFramesVideoFilter< TVideoStream >::OutputVideoStreamType

Definition at line 43 of file itkDecimateFramesVideoFilter.h.

template<class TVideoStream >

typedef FrameType::PixelType itk::DecimateFramesVideoFilter< TVideoStream >::PixelType

Definition at line 52 of file itkDecimateFramesVideoFilter.h.

template<class TVideoStream >

typedef SmartPointer< Self > itk::DecimateFramesVideoFilter< TVideoStream >::Pointer

Definition at line 47 of file itkDecimateFramesVideoFilter.h.

template<class TVideoStream >

typedef DecimateFramesVideoFilter< VideoStreamType > itk::DecimateFramesVideoFilter< TVideoStream >::Self

Definition at line 44 of file itkDecimateFramesVideoFilter.h.

template<class TVideoStream >

typedef VideoToVideoFilter< VideoStreamType, VideoStreamType > itk::DecimateFramesVideoFilter< TVideoStream >::Superclass

Definition at line 46 of file itkDecimateFramesVideoFilter.h.

template<class TVideoStream >

typedef TVideoStream itk::DecimateFramesVideoFilter< TVideoStream >::VideoStreamType

Standard class typedefs

Definition at line 41 of file itkDecimateFramesVideoFilter.h.

Constructor & Destructor Documentation

template<class TVideoStream >

itk::DecimateFramesVideoFilter< TVideoStream >::DecimateFramesVideoFilter ( )

protected

Constructor and Destructor

template<class TVideoStream >

virtual itk::DecimateFramesVideoFilter< TVideoStream >::~DecimateFramesVideoFilter ( )

inlineprotectedvirtual

Definition at line 68 of file itkDecimateFramesVideoFilter.h.

template<class TVideoStream >

itk::DecimateFramesVideoFilter< TVideoStream >::DecimateFramesVideoFilter ( const Self &  )

private

Member Function Documentation

template<class TVideoStream >

virtual::itk::LightObject::Pointer itk::DecimateFramesVideoFilter< TVideoStream >::CreateAnother ( void  ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<class TVideoStream >

virtual const char* itk::DecimateFramesVideoFilter< TVideoStream >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::VideoToVideoFilter< TVideoStream, TVideoStream >.

template<class TVideoStream >

SizeValueType itk::DecimateFramesVideoFilter< TVideoStream >::GetPreservedFrameSpacing

(

)

Get/Set the spacing of the preserved frames

template<class TVideoStream >

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

static

template<class TVideoStream >

void itk::DecimateFramesVideoFilter< TVideoStream >::operator= ( const Self &  )

private

template<class TVideoStream >

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

protectedvirtual

PrintSelf

Reimplemented from itk::VideoToVideoFilter< TVideoStream, TVideoStream >.

template<class TVideoStream >

void itk::DecimateFramesVideoFilter< TVideoStream >::SetPreservedFrameSpacing

(

SizeValueType

numFrames

)

Get/Set the spacing of the preserved frames

template<class TVideoStream >

virtual void itk::DecimateFramesVideoFilter< TVideoStream >::ThreadedGenerateData ( const FrameSpatialRegionType &  outputRegionForThread, int  threadId  )

protectedvirtual

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:

• itkDecimateFramesVideoFilter.h