itk::VideoFileWriter< TInputVideoStream > Class Template Reference

#include <itkVideoFileWriter.h>

Inheritance diagram for itk::VideoFileWriter< TInputVideoStream >:

Collaboration diagram for itk::VideoFileWriter< TInputVideoStream >:

List of all members.

Public Types
typedef VideoStreamType::FrameType	FrameType
typedef VideoIOBase::Pointer	IOBasePointer
typedef VideoIOBase	IOBaseType
typedef FrameType::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
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 Self >	ConstPointer
Public Types inherited from itk::ProcessObject
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
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
void	FinishWriting ()
virtual const char *	GetNameOfClass () const
void	SetVideoIO (IOBasePointer videoIO)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
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 VideoStreamType *	GetInput ()
Public Member Functions inherited from itk::TemporalProcessObject
virtual void	EnlargeOutputRequestedRegion (DataObject *output)
virtual void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual SizeValueType	GetUnitInputNumberOfFrames ()
virtual SizeValueType	GetUnitOutputNumberOfFrames ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
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 (DataObjectPointerArraySizeType idx)
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)
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 unsigned long	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 ()

Protected Member Functions
bool	InitializeOutputParameters ()
bool	InitializeVideoIO ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	TemporalStreamingGenerateData ()
	VideoFileWriter ()
virtual	~VideoFileWriter ()
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 ()
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 ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () 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 ()

Protected Attributes
std::string	m_FileName
TemporalRegion	m_OutputTemporalRegion
IOBasePointer	m_VideoIO
Protected Attributes inherited from itk::TemporalProcessObject
OffsetValueType	m_FrameSkipPerOutput
SizeValueType	m_InputStencilCurrentFrameIndex
SizeValueType	m_UnitInputNumberOfFrames
SizeValueType	m_UnitOutputNumberOfFrames
Protected Attributes inherited from itk::ProcessObject
bool	m_Updating
TimeStamp	m_OutputInformationMTime
TemporalRatioType	m_FramesPerSecond
std::string	m_FourCC
std::vector< SizeValueType >	m_Dimensions
SizeValueType	m_NumberOfComponents
ImageIOBase::IOComponentType	m_ComponentType
	VideoFileWriter (const Self &)
void	operator= (const Self &)

Additional Inherited Members

---

Detailed Description

template<class 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.

---

Member Typedef Documentation

template<class TInputVideoStream >

typedef VideoStreamType::FrameType itk::VideoFileWriter< TInputVideoStream >::FrameType

Definition at line 55 of file itkVideoFileWriter.h.

template<class TInputVideoStream >

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

Definition at line 49 of file itkVideoFileWriter.h.

template<class TInputVideoStream >

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

Definition at line 48 of file itkVideoFileWriter.h.

template<class TInputVideoStream >

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

Definition at line 56 of file itkVideoFileWriter.h.

template<class TInputVideoStream >

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

Reimplemented from itk::TemporalProcessObject.

Definition at line 46 of file itkVideoFileWriter.h.

template<class TInputVideoStream >

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

-TYPEDEFS—————————————————————

Reimplemented from itk::TemporalProcessObject.

Definition at line 44 of file itkVideoFileWriter.h.

template<class TInputVideoStream >

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

Definition at line 50 of file itkVideoFileWriter.h.

template<class TInputVideoStream >

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

Reimplemented from itk::TemporalProcessObject.

Definition at line 45 of file itkVideoFileWriter.h.

template<class TInputVideoStream >

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

Definition at line 51 of file itkVideoFileWriter.h.

template<class TInputVideoStream >

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

Definition at line 54 of file itkVideoFileWriter.h.

template<class TInputVideoStream >

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

Definition at line 53 of file itkVideoFileWriter.h.

---

Constructor & Destructor Documentation

template<class TInputVideoStream >

itk::VideoFileWriter< TInputVideoStream >::VideoFileWriter ( )

protected

-PROTECTED METHODS——————————————————

template<class TInputVideoStream >

virtual itk::VideoFileWriter< TInputVideoStream >::~VideoFileWriter ( )

protectedvirtual

template<class TInputVideoStream >

itk::VideoFileWriter< TInputVideoStream >::VideoFileWriter ( const Self &  )

private

Parameters for writing

---

Member Function Documentation

template<class TInputVideoStream >

virtual::itk::LightObject::Pointer itk::VideoFileWriter< TInputVideoStream >::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 TInputVideoStream >

void itk::VideoFileWriter< TInputVideoStream >::FinishWriting

(

)

Finish writing the video and close the file

template<class TInputVideoStream >

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

virtual

-PUBLIC METHODS——————————————————— Specify the file to read. This is forwarded to the IO instance.

template<class 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<class TInputVideoStream >

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

virtual

Specify the output FpS

template<class TInputVideoStream >

const VideoStreamType* itk::VideoFileWriter< TInputVideoStream >::GetInput

(

)

template<class TInputVideoStream >

virtual const char* itk::VideoFileWriter< TInputVideoStream >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::TemporalProcessObject.

template<class TInputVideoStream >

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

virtual

Get/Set the OutputTemporalRegion

template<class TInputVideoStream >

bool itk::VideoFileWriter< TInputVideoStream >::InitializeOutputParameters ( )

protected

Initialize output parameters

template<class 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<class TInputVideoStream >

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

static

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputVideoStream >

void itk::VideoFileWriter< TInputVideoStream >::operator= ( const Self &  )

private

Parameters for writing

Reimplemented from itk::TemporalProcessObject.

template<class TInputVideoStream >

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

protectedvirtual

ITK print mechanism

Reimplemented from itk::TemporalProcessObject.

template<class TInputVideoStream >

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

virtual

-PUBLIC METHODS——————————————————— Specify the file to read. This is forwarded to the IO instance.

template<class 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<class TInputVideoStream >

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

virtual

Specify the output FpS

template<class TInputVideoStream >

void itk::VideoFileWriter< TInputVideoStream >::SetInput

(

const VideoStreamType *

input

)

template<class TInputVideoStream >

virtual void itk::VideoFileWriter< TInputVideoStream >::SetOutputTemporalRegion ( TemporalRegion  _arg )

virtual

Get/Set the OutputTemporalRegion

template<class TInputVideoStream >

void itk::VideoFileWriter< TInputVideoStream >::SetVideoIO

(

IOBasePointer

videoIO

)

Manually set the VideoIO to use

template<class TInputVideoStream >

virtual void itk::VideoFileWriter< TInputVideoStream >::TemporalStreamingGenerateData ( )

protectedvirtual

Override TemporalStreamingGenerateData to do the actual writing.

Reimplemented from itk::TemporalProcessObject.

template<class TInputVideoStream >

virtual void itk::VideoFileWriter< TInputVideoStream >::Update ( )

virtual

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

Reimplemented from itk::ProcessObject.

template<class TInputVideoStream >

virtual void itk::VideoFileWriter< TInputVideoStream >::UpdateLargestPossibleRegion ( )

virtual

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<class 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<class TInputVideoStream >

ImageIOBase::IOComponentType itk::VideoFileWriter< TInputVideoStream >::m_ComponentType

protected

Parameters for writing

Definition at line 149 of file itkVideoFileWriter.h.

template<class TInputVideoStream >

std::vector<SizeValueType> itk::VideoFileWriter< TInputVideoStream >::m_Dimensions

protected

Parameters for writing

Definition at line 147 of file itkVideoFileWriter.h.

template<class TInputVideoStream >

std::string itk::VideoFileWriter< TInputVideoStream >::m_FileName

protected

-PROTECTED MEMBERS—————————————————— The file to read

Definition at line 136 of file itkVideoFileWriter.h.

template<class TInputVideoStream >

std::string itk::VideoFileWriter< TInputVideoStream >::m_FourCC

protected

Parameters for writing

Definition at line 146 of file itkVideoFileWriter.h.

template<class TInputVideoStream >

TemporalRatioType itk::VideoFileWriter< TInputVideoStream >::m_FramesPerSecond

protected

Parameters for writing

Definition at line 145 of file itkVideoFileWriter.h.

template<class TInputVideoStream >

SizeValueType itk::VideoFileWriter< TInputVideoStream >::m_NumberOfComponents

protected

Parameters for writing

Definition at line 148 of file itkVideoFileWriter.h.

template<class TInputVideoStream >

TemporalRegion itk::VideoFileWriter< TInputVideoStream >::m_OutputTemporalRegion

protected

TemporalRegion to write out

Definition at line 142 of file itkVideoFileWriter.h.

template<class TInputVideoStream >

IOBasePointer itk::VideoFileWriter< TInputVideoStream >::m_VideoIO

protected

The VideoIO used for writing

Definition at line 139 of file itkVideoFileWriter.h.

---

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

• itkVideoFileWriter.h