ITK  4.13.0
Insight Segmentation and Registration 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>

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

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

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef WeakPointer< const SelfConstWeakPointer
 
typedef FrameType::RegionType FrameSpatialRegionType
 
typedef TVideoStream::FrameType FrameType
 
typedef TVideoStream InputVideoStreamType
 
typedef TVideoStream OutputVideoStreamType
 
typedef FrameType::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef
DecimateFramesVideoFilter
< VideoStreamType
Self
 
typedef VideoToVideoFilter
< VideoStreamType,
VideoStreamType
Superclass
 
typedef TVideoStream VideoStreamType
 
- Public Types inherited from itk::VideoToVideoFilter< TVideoStream, TVideoStream >
typedef SmartPointer< const SelfConstPointer
 
typedef WeakPointer< const SelfConstWeakPointer
 
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< SelfPointer
 
typedef VideoToVideoFilter
< InputVideoStreamType,
OutputVideoStreamType
Self
 
typedef VideoSource
< OutputVideoStreamType
Superclass
 
- Public Types inherited from itk::VideoSource< TVideoStream >
typedef SmartPointer< const SelfConstPointer
 
typedef WeakPointer< const SelfConstWeakPointer
 
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< SelfPointer
 
typedef VideoSource Self
 
typedef TemporalProcessObject Superclass
 
- Public Types inherited from itk::TemporalProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef TemporalProcessObject Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef MultiThreader MultiThreaderType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () 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 () const
 
const InputVideoStreamTypeGetInput () const
 
const InputVideoStreamTypeGetInput (unsigned int idx) const
 
virtual void SetInput (const InputVideoStreamType *videoStream)
 
virtual void SetInput (unsigned int idx, const InputVideoStreamType *videoStream)
 
virtual void UpdateOutputInformation () override
 
- Public Member Functions inherited from itk::VideoSource< TVideoStream >
OutputVideoStreamTypeGetOutput ()
 
OutputVideoStreamTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, OutputVideoStreamType *output)
 
virtual void GraftOutput (OutputVideoStreamType *output)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
- Public Member Functions inherited from itk::TemporalProcessObject
virtual void EnlargeOutputRequestedRegion (DataObject *output) override
 
virtual void GenerateData () override
 
virtual SizeValueType GetUnitInputNumberOfFrames ()
 
virtual SizeValueType GetUnitOutputNumberOfFrames ()
 
virtual void UpdateOutputData (DataObject *output) 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 ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
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 Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
void UpdateProgress (float progress)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
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 SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- 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
 
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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () 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 ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 DecimateFramesVideoFilter ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void ThreadedGenerateData (const FrameSpatialRegionType &outputRegionForThread, int threadId) override
 
virtual ~DecimateFramesVideoFilter () override
 
- Protected Member Functions inherited from itk::VideoToVideoFilter< TVideoStream, TVideoStream >
virtual void BeforeTemporalStreamingGenerateData () override
 
virtual void GenerateInputRequestedRegion () override
 
virtual void GenerateOutputRequestedRegion (DataObject *output) override
 
InputVideoStreamTypeGetInput ()
 
InputVideoStreamTypeGetInput (unsigned int idx)
 
 VideoToVideoFilter ()
 
virtual ~VideoToVideoFilter () override
 
- Protected Member Functions inherited from itk::VideoSource< TVideoStream >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void GenerateOutputRequestedTemporalRegion (TemporalDataObject *output) override
 
virtual int SplitRequestedSpatialRegion (int i, int num, OutputFrameSpatialRegionType &splitRegion)
 
virtual void TemporalStreamingGenerateData () override
 
virtual void ThreadedGenerateData (const OutputFrameSpatialRegionType &outputRegionForThread, int threadId)
 
 VideoSource ()
 
virtual ~VideoSource () override
 
- 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 () override
 
- 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
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (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
 
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 num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () 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 () 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 const unsigned int OutputFrameDimension
 
- 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
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

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

Definition at line 48 of file itkDecimateFramesVideoFilter.h.

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

Definition at line 49 of file itkDecimateFramesVideoFilter.h.

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

Definition at line 53 of file itkDecimateFramesVideoFilter.h.

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

Definition at line 51 of file itkDecimateFramesVideoFilter.h.

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

Definition at line 42 of file itkDecimateFramesVideoFilter.h.

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

Definition at line 43 of file itkDecimateFramesVideoFilter.h.

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

Definition at line 52 of file itkDecimateFramesVideoFilter.h.

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

Definition at line 47 of file itkDecimateFramesVideoFilter.h.

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

Definition at line 44 of file itkDecimateFramesVideoFilter.h.

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

Definition at line 46 of file itkDecimateFramesVideoFilter.h.

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

Standard class typedefs

Definition at line 41 of file itkDecimateFramesVideoFilter.h.

Constructor & Destructor Documentation

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

Constructor and Destructor

template<typename TVideoStream >
virtual itk::DecimateFramesVideoFilter< TVideoStream >::~DecimateFramesVideoFilter ( )
inlineoverrideprotectedvirtual

Definition at line 68 of file itkDecimateFramesVideoFilter.h.

Member Function Documentation

template<typename TVideoStream >
virtual::itk::LightObject::Pointer itk::DecimateFramesVideoFilter< TVideoStream >::CreateAnother ( ) 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<typename TVideoStream >
virtual const char* itk::DecimateFramesVideoFilter< TVideoStream >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

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

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

Get/Set the spacing of the preserved frames

template<typename TVideoStream >
static Pointer itk::DecimateFramesVideoFilter< TVideoStream >::New ( )
static
template<typename TVideoStream >
virtual void itk::DecimateFramesVideoFilter< TVideoStream >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual
template<typename TVideoStream >
void itk::DecimateFramesVideoFilter< TVideoStream >::SetPreservedFrameSpacing ( SizeValueType  numFrames)

Get/Set the spacing of the preserved frames

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

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: