itk::VideoFileWriter< TInputVideoStream > Class Template Reference

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

#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 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 ()
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 Attributes
std::string	m_FileName
TemporalRegion	m_OutputTemporalRegion
IOBasePointer	m_VideoIO
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 &)

---

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

(

)

[protected, virtual]

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 sucessful, 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 [protected, virtual]

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

(

)

[protected, virtual]

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