ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::VideoFileWriter< TInputVideoStream > Class Template Reference

#include <itkVideoFileWriter.h>

+ Inheritance diagram for itk::VideoFileWriter< TInputVideoStream >:
+ Collaboration diagram for itk::VideoFileWriter< TInputVideoStream >:

Detailed Description

template<typename TInputVideoStream>
class itk::VideoFileWriter< TInputVideoStream >

Writer that takes in a VideoStream and writes the frames to a file.

This class is a subclass of TemporalProcessObject which specifically takes a single VideoStream as input and writes the frames out to a file in sequence. A call to Update() will write the entire requested temporal region to the file. If no temporal region is requested, the largest possible will be used.

Definition at line 39 of file itkVideoFileWriter.h.

Public Types

typedef VideoStreamType::FrameType FrameType
 
typedef VideoIOBase::Pointer IOBasePointer
 
typedef VideoIOBase IOBaseType
 
typedef FrameType::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef VideoFileWriter
< TInputVideoStream > 
Self
 
typedef IOBaseType::SizeValueType SizeValueType
 
typedef TemporalProcessObject Superclass
 
typedef
IOBaseType::TemporalRatioType 
TemporalRatioType
 
typedef VideoStreamType::Pointer VideoStreamPointer
 
typedef TInputVideoStream VideoStreamType
 
- 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
 
void FinishWriting ()
 
virtual const char * GetNameOfClass () const
 
void SetVideoIO (IOBasePointer videoIO)
 
virtual void Update () override
 
virtual void UpdateLargestPossibleRegion () override
 
void Write ()
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
virtual void SetFramesPerSecond (TemporalRatioType _arg)
 
virtual TemporalRatioType GetFramesPerSecond ()
 
virtual void SetFourCC (const char *_arg)
 
virtual const char * GetFourCC () const
 
virtual void SetOutputTemporalRegion (TemporalRegion _arg)
 
virtual TemporalRegion GetOutputTemporalRegion ()
 
void SetInput (const VideoStreamType *input)
 
const VideoStreamTypeGetInput ()
 
- Public Member Functions inherited from itk::TemporalProcessObject
virtual void EnlargeOutputRequestedRegion (DataObject *output) override
 
virtual void GenerateData () override
 
virtual void GenerateInputRequestedRegion () override
 
virtual void GenerateOutputRequestedRegion (DataObject *output) override
 
virtual SizeValueType GetUnitInputNumberOfFrames ()
 
virtual SizeValueType GetUnitOutputNumberOfFrames ()
 
virtual void UpdateOutputData (DataObject *output) override
 
virtual void UpdateOutputInformation () 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 (DataObjectPointerArraySizeType idx)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
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::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

bool InitializeOutputParameters ()
 
bool InitializeVideoIO ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void TemporalStreamingGenerateData () override
 
 VideoFileWriter ()
 
virtual ~VideoFileWriter () override
 
- 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 ()
 
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 ()
 

Private Attributes

ImageIOBase::IOComponentType m_ComponentType
 
std::vector< SizeValueTypem_Dimensions
 
std::string m_FileName
 
std::string m_FourCC
 
TemporalRatioType m_FramesPerSecond
 
SizeValueType m_NumberOfComponents
 
TemporalRegion m_OutputTemporalRegion
 
IOBasePointer m_VideoIO
 

Additional Inherited Members

- 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 TInputVideoStream >
typedef VideoStreamType::FrameType itk::VideoFileWriter< TInputVideoStream >::FrameType

Definition at line 55 of file itkVideoFileWriter.h.

template<typename TInputVideoStream >
typedef VideoIOBase::Pointer itk::VideoFileWriter< TInputVideoStream >::IOBasePointer

Definition at line 49 of file itkVideoFileWriter.h.

template<typename TInputVideoStream >
typedef VideoIOBase itk::VideoFileWriter< TInputVideoStream >::IOBaseType

Definition at line 48 of file itkVideoFileWriter.h.

template<typename TInputVideoStream >
typedef FrameType::PixelType itk::VideoFileWriter< TInputVideoStream >::PixelType

Definition at line 56 of file itkVideoFileWriter.h.

template<typename TInputVideoStream >
typedef SmartPointer<Self> itk::VideoFileWriter< TInputVideoStream >::Pointer

Definition at line 46 of file itkVideoFileWriter.h.

template<typename TInputVideoStream >
typedef VideoFileWriter< TInputVideoStream> itk::VideoFileWriter< TInputVideoStream >::Self

Standard class typedefs.

Definition at line 44 of file itkVideoFileWriter.h.

template<typename TInputVideoStream >
typedef IOBaseType::SizeValueType itk::VideoFileWriter< TInputVideoStream >::SizeValueType

Definition at line 50 of file itkVideoFileWriter.h.

template<typename TInputVideoStream >
typedef TemporalProcessObject itk::VideoFileWriter< TInputVideoStream >::Superclass

Definition at line 45 of file itkVideoFileWriter.h.

template<typename TInputVideoStream >
typedef IOBaseType::TemporalRatioType itk::VideoFileWriter< TInputVideoStream >::TemporalRatioType

Definition at line 51 of file itkVideoFileWriter.h.

template<typename TInputVideoStream >
typedef VideoStreamType::Pointer itk::VideoFileWriter< TInputVideoStream >::VideoStreamPointer

Definition at line 54 of file itkVideoFileWriter.h.

template<typename TInputVideoStream >
typedef TInputVideoStream itk::VideoFileWriter< TInputVideoStream >::VideoStreamType

Definition at line 53 of file itkVideoFileWriter.h.

Constructor & Destructor Documentation

template<typename TInputVideoStream >
itk::VideoFileWriter< TInputVideoStream >::VideoFileWriter ( )
protected
template<typename TInputVideoStream >
virtual itk::VideoFileWriter< TInputVideoStream >::~VideoFileWriter ( )
overrideprotectedvirtual

Member Function Documentation

template<typename TInputVideoStream >
virtual::itk::LightObject::Pointer itk::VideoFileWriter< TInputVideoStream >::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 TInputVideoStream >
void itk::VideoFileWriter< TInputVideoStream >::FinishWriting ( )

Finish writing the video and close the file

template<typename TInputVideoStream >
virtual const char* itk::VideoFileWriter< TInputVideoStream >::GetFileName ( ) const
virtual

Specify the file to read. This is forwarded to the IO instance.

template<typename TInputVideoStream >
virtual const char* itk::VideoFileWriter< TInputVideoStream >::GetFourCC ( ) const
virtual

Specify the FourCC to use for video encoding. FourCC, or four character code, is commonly used to denote the codec to be used to encode video by many libraries. See http://en.wikipedia.org/wiki/FourCC for more information.

template<typename TInputVideoStream >
virtual TemporalRatioType itk::VideoFileWriter< TInputVideoStream >::GetFramesPerSecond ( )
virtual

Specify the output FpS.

template<typename TInputVideoStream >
const VideoStreamType* itk::VideoFileWriter< TInputVideoStream >::GetInput ( )
template<typename TInputVideoStream >
virtual const char* itk::VideoFileWriter< TInputVideoStream >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::TemporalProcessObject.

template<typename TInputVideoStream >
virtual TemporalRegion itk::VideoFileWriter< TInputVideoStream >::GetOutputTemporalRegion ( )
virtual

Get/Set the OutputTemporalRegion

template<typename TInputVideoStream >
bool itk::VideoFileWriter< TInputVideoStream >::InitializeOutputParameters ( )
protected

Initialize output parameters.

template<typename TInputVideoStream >
bool itk::VideoFileWriter< TInputVideoStream >::InitializeVideoIO ( )
protected

Set up the VideoIO using VideoIOFactory. Returns true if successful, false otherwise. Warning: this will overwrite any currently set VideoIO

template<typename TInputVideoStream >
static Pointer itk::VideoFileWriter< TInputVideoStream >::New ( )
static

Method for creation through the object factory.

template<typename TInputVideoStream >
virtual void itk::VideoFileWriter< TInputVideoStream >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

ITK print mechanism

Reimplemented from itk::TemporalProcessObject.

template<typename TInputVideoStream >
virtual void itk::VideoFileWriter< TInputVideoStream >::SetFileName ( const char *  _arg)
virtual

Specify the file to read. This is forwarded to the IO instance.

template<typename TInputVideoStream >
virtual void itk::VideoFileWriter< TInputVideoStream >::SetFourCC ( const char *  _arg)
virtual

Specify the FourCC to use for video encoding. FourCC, or four character code, is commonly used to denote the codec to be used to encode video by many libraries. See http://en.wikipedia.org/wiki/FourCC for more information.

template<typename TInputVideoStream >
virtual void itk::VideoFileWriter< TInputVideoStream >::SetFramesPerSecond ( TemporalRatioType  _arg)
virtual

Specify the output FpS.

template<typename TInputVideoStream >
void itk::VideoFileWriter< TInputVideoStream >::SetInput ( const VideoStreamType input)
template<typename TInputVideoStream >
virtual void itk::VideoFileWriter< TInputVideoStream >::SetOutputTemporalRegion ( TemporalRegion  _arg)
virtual

Get/Set the OutputTemporalRegion

template<typename TInputVideoStream >
void itk::VideoFileWriter< TInputVideoStream >::SetVideoIO ( IOBasePointer  videoIO)

Manually set the VideoIO to use

template<typename TInputVideoStream >
virtual void itk::VideoFileWriter< TInputVideoStream >::TemporalStreamingGenerateData ( )
overrideprotectedvirtual

Override TemporalStreamingGenerateData to do the actual writing.

Reimplemented from itk::TemporalProcessObject.

template<typename TInputVideoStream >
virtual void itk::VideoFileWriter< TInputVideoStream >::Update ( )
overridevirtual

Aliased to the Write() method to be consistent with the rest of the pipeline.

Reimplemented from itk::ProcessObject.

template<typename TInputVideoStream >
virtual void itk::VideoFileWriter< TInputVideoStream >::UpdateLargestPossibleRegion ( )
overridevirtual

Write the entire video to a file, if possible. This is the same as calling write or update without setting an output temporal region.

Reimplemented from itk::ProcessObject.

template<typename TInputVideoStream >
void itk::VideoFileWriter< TInputVideoStream >::Write ( )

Write the requested temporal region to a file. If no OutputTemporalRegion has been set, the largest possible temporal region of the input will be used.

Member Data Documentation

template<typename TInputVideoStream >
ImageIOBase::IOComponentType itk::VideoFileWriter< TInputVideoStream >::m_ComponentType
private

Definition at line 147 of file itkVideoFileWriter.h.

template<typename TInputVideoStream >
std::vector<SizeValueType> itk::VideoFileWriter< TInputVideoStream >::m_Dimensions
private

Definition at line 145 of file itkVideoFileWriter.h.

template<typename TInputVideoStream >
std::string itk::VideoFileWriter< TInputVideoStream >::m_FileName
private

The file to write.

Definition at line 131 of file itkVideoFileWriter.h.

template<typename TInputVideoStream >
std::string itk::VideoFileWriter< TInputVideoStream >::m_FourCC
private

Definition at line 144 of file itkVideoFileWriter.h.

template<typename TInputVideoStream >
TemporalRatioType itk::VideoFileWriter< TInputVideoStream >::m_FramesPerSecond
private

Parameters for writing.

Definition at line 143 of file itkVideoFileWriter.h.

template<typename TInputVideoStream >
SizeValueType itk::VideoFileWriter< TInputVideoStream >::m_NumberOfComponents
private

Definition at line 146 of file itkVideoFileWriter.h.

template<typename TInputVideoStream >
TemporalRegion itk::VideoFileWriter< TInputVideoStream >::m_OutputTemporalRegion
private

TemporalRegion to write out.

Definition at line 140 of file itkVideoFileWriter.h.

template<typename TInputVideoStream >
IOBasePointer itk::VideoFileWriter< TInputVideoStream >::m_VideoIO
private

The VideoIO used for writing.

Definition at line 137 of file itkVideoFileWriter.h.


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