ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions
itk::DecimateFramesVideoFilter< TVideoStream > Class Template Reference

#include <itkDecimateFramesVideoFilter.h>

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

List of all members.

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
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
Superclass::OutputFrameSpatialRegionType 
OutputFrameSpatialRegionType
typedef Superclass::OutputFrameType OutputFrameType
- Public Types inherited from itk::VideoSource< TVideoStream >
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
- Public Types inherited from itk::TemporalProcessObject
- Public Types inherited from itk::ProcessObject
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
typedef DataObject::Pointer DataObjectPointer
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
typedef std::vector
< DataObjectIdentifierType
NameArray
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

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 >
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 ()
- 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)
- 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 ThreadIdTypeGetNumberOfThreads ()
- 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 (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long 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
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 ()

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)
InputVideoStreamTypeGetInput ()
InputVideoStreamTypeGetInput (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)
bool AddRequiredInputName (const DataObjectIdentifierType &)
virtual void CacheInputReleaseDataFlags ()
virtual void GenerateOutputInformation ()
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
bool IsIndexedName (const DataObjectIdentifierType &) const
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType MakeNameFromIndex (DataObjectPointerArraySizeType) 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)
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 ()
DataObjectGetInput (const DataObjectIdentifierType &key)
const DataObjectGetInput (const DataObjectIdentifierType &key) const
DataObjectGetInput (DataObjectPointerArraySizeType)
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryInput ()
const DataObjectGetPrimaryInput () const
DataObjectGetOutput (const DataObjectIdentifierType &key)
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryOutput ()
const DataObjectGetPrimaryOutput () const
virtual void PushBackInput (const DataObject *input)
virtual void PopBackInput ()
virtual void PushFrontInput (const DataObject *input)
virtual void PopFrontInput ()
- 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 &)

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.


Member Typedef Documentation

template<class TVideoStream >
typedef SmartPointer< const Self > itk::DecimateFramesVideoFilter< TVideoStream >::ConstPointer
template<class TVideoStream >
typedef WeakPointer< const Self > itk::DecimateFramesVideoFilter< TVideoStream >::ConstWeakPointer
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

Standard class typedefs

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

Definition at line 42 of file itkDecimateFramesVideoFilter.h.

template<class TVideoStream >
typedef TVideoStream itk::DecimateFramesVideoFilter< TVideoStream >::OutputVideoStreamType
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
template<class TVideoStream >
typedef DecimateFramesVideoFilter< VideoStreamType > itk::DecimateFramesVideoFilter< TVideoStream >::Self

Standard class typedefs

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

Definition at line 44 of file itkDecimateFramesVideoFilter.h.

template<class TVideoStream >
typedef VideoToVideoFilter< VideoStreamType, VideoStreamType > itk::DecimateFramesVideoFilter< TVideoStream >::Superclass
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::VideoToVideoFilter< TVideoStream, TVideoStream >.

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

Method for creation through the object factory.

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

template<class TVideoStream >
void itk::DecimateFramesVideoFilter< TVideoStream >::operator= ( const Self )
private

Time when GenerateOutputInformation was last called.

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

template<class TVideoStream >
virtual void itk::DecimateFramesVideoFilter< TVideoStream >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual
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: