#include <itkOpenCVVideoIO.h>

Inheritance diagram for itk::OpenCVVideoIO:

Collaboration diagram for itk::OpenCVVideoIO:

Detailed Description

VideoIO object for reading and writing videos using OpenCV.

Definition at line 34 of file itkOpenCVVideoIO.h.

Public Types
typedef Superclass::CameraIDType	CameraIDType

typedef Superclass::FrameOffsetType	FrameOffsetType

typedef SmartPointer< Self >	Pointer

typedef OpenCVVideoIO	Self

typedef VideoIOBase	Superclass

typedef Superclass::TemporalOffsetType	TemporalOffsetType

typedef Superclass::TemporalRatioType	TemporalRatioType

Public Types inherited from itk::VideoIOBase
typedef SizeValueType	CameraIDType

typedef SizeValueType	FrameOffsetType

typedef SmartPointer< Self >	Pointer

enum	ReadType { ReadFromFile, ReadFromCamera }

typedef VideoIOBase	Self

typedef ::itk::SizeValueType	SizeValueType

typedef ImageIOBase	Superclass

typedef double	TemporalOffsetType

typedef double	TemporalRatioType

Public Types inherited from itk::ImageIOBase
typedef std::vector< std::string >	ArrayOfExtensionsType

typedef ::itk::OffsetValueType	BufferSizeType

enum	ByteOrder { BigEndian, LittleEndian, OrderNotApplicable }

enum	FileType { ASCII, Binary, TypeNotApplicable }

typedef ::itk::IndexValueType	IndexValueType

enum	IOComponentType { UNKNOWNCOMPONENTTYPE, UCHAR, CHAR, USHORT, SHORT, UINT, INT, ULONG, LONG, FLOAT, DOUBLE }

enum	IOPixelType { UNKNOWNPIXELTYPE, SCALAR, RGB, RGBA, OFFSET, VECTOR, POINT, COVARIANTVECTOR, SYMMETRICSECONDRANKTENSOR, DIFFUSIONTENSOR3D, COMPLEX, FIXEDARRAY, MATRIX }

typedef SmartPointer< Self >	Pointer

typedef ImageIOBase	Self

typedef ::itk::intmax_t	SizeType

typedef ::itk::SizeValueType	SizeValueType

typedef LightProcessObject	Superclass

Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual bool	CanReadCamera (CameraIDType cameraID) const

virtual bool	CanReadFile (const char *)

virtual bool	CanWriteFile (const char *)

virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual void	FinishReadingOrWriting ()

virtual const char *	GetNameOfClass () const

virtual void	Read (void *buffer)

virtual void	ReadImageInformation ()

virtual bool	SetNextFrameToRead (FrameOffsetType frameNumber)

virtual void	SetReadFromCamera ()

virtual void	SetReadFromFile ()

virtual void	SetWriterParameters (TemporalRatioType fps, const std::vector< SizeValueType > &dim, const char *fourCC, unsigned int nChannels, IOComponentType componentType)

virtual void	Write (const void *buffer)

virtual void	WriteImageInformation ()


virtual TemporalOffsetType	GetPositionInMSec () const

virtual TemporalRatioType	GetRatio () const

virtual FrameOffsetType	GetFrameTotal () const

virtual TemporalRatioType	GetFramesPerSecond () const

virtual FrameOffsetType	GetCurrentFrame () const

virtual FrameOffsetType	GetIFrameInterval () const

virtual FrameOffsetType	GetLastIFrame () const


virtual void	SetCameraIndex (CameraIDType idx)

virtual CameraIDType	GetCameraIndex () const


virtual double	GetSpacing (unsigned int) const

virtual double	GetOrigin (unsigned int) const

virtual std::vector< double >	GetDirection (unsigned int i) const

Public Member Functions inherited from itk::VideoIOBase
ReadType	GetReadType ()

Public Member Functions inherited from itk::ImageIOBase
virtual bool	CanStreamRead ()

virtual bool	CanStreamWrite ()

virtual ImageIORegion	GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requested) const

virtual unsigned int	GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)

std::string	GetByteOrderAsString (ByteOrder) const

virtual unsigned int	GetComponentSize () const

virtual IOComponentType	GetComponentType () const

virtual const std::type_info &	GetComponentTypeInfo () const

virtual std::vector< double >	GetDefaultDirection (unsigned int i) const

virtual itk::SizeValueType	GetDimensions (unsigned int i) const

std::string	GetFileTypeAsString (FileType) const

SizeType	GetImageSizeInBytes () const

SizeType	GetImageSizeInComponents () const

SizeType	GetImageSizeInPixels () const

virtual unsigned int	GetNumberOfDimensions () const

virtual SizeType	GetPixelStride () const

virtual ImageIORegion	GetSplitRegionForWriting (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)

const ArrayOfExtensionsType &	GetSupportedReadExtensions () const

const ArrayOfExtensionsType &	GetSupportedWriteExtensions () const

void	SetByteOrderToLittleEndian ()

virtual void	SetComponentType (const IOComponentType _arg)

virtual void	SetDirection (unsigned int i, std::vector< double > &direction)

virtual void	SetDirection (unsigned int i, vnl_vector< double > &direction)

void	SetFileTypeToBinary ()

void	SetNumberOfDimensions (unsigned int)

virtual void	SetOrigin (unsigned int i, double origin)

template<class TPixel , unsigned VLength>
void	SetPixelTypeInfo (const SymmetricSecondRankTensor< TPixel, VLength > *)

template<typename TPixel >
void	SetPixelTypeInfo (const DiffusionTensor3D< TPixel > *)

template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const Matrix< TPixel, VLength, VLength > *)

template<typename TPixel >
void	SetPixelTypeInfo (const std::complex< TPixel > *)

template<unsigned VLength>
void	SetPixelTypeInfo (const Offset< VLength > *)

virtual void	SetSpacing (unsigned int i, double spacing)

template<typename TPixel >
void	SetTypeInfo (const TPixel *)

virtual bool	SupportsDimension (unsigned long dim)

virtual void	SetFileName (const char *_arg)

virtual const char *	GetFileName () const

virtual void	SetDimensions (unsigned int i, unsigned int dim)

virtual void	SetIORegion (ImageIORegion _arg)

virtual const ImageIORegion &	GetIORegion ()

virtual void	SetPixelType (const IOPixelType _arg)

virtual IOPixelType	GetPixelType () const

virtual void	SetNumberOfComponents (unsigned int _arg)

virtual const unsigned int &	GetNumberOfComponents ()

virtual void	SetUseCompression (bool _arg)

virtual bool	GetUseCompression () const

virtual void	UseCompressionOn ()

virtual void	UseCompressionOff ()

virtual void	SetUseStreamedReading (bool _arg)

virtual bool	GetUseStreamedReading () const

virtual void	UseStreamedReadingOn ()

virtual void	UseStreamedReadingOff ()

virtual void	SetUseStreamedWriting (bool _arg)

virtual bool	GetUseStreamedWriting () const

virtual void	UseStreamedWritingOn ()

virtual void	UseStreamedWritingOff ()

virtual void	SetFileType (const FileType _arg)

virtual FileType	GetFileType () const

void	SetFileTypeToASCII ()

virtual void	SetByteOrder (const ByteOrder _arg)

virtual ByteOrder	GetByteOrder () const

void	SetByteOrderToBigEndian ()

template<typename TPixel >
void	SetPixelTypeInfo (const TPixel *)

template<typename TPixel >
void	SetPixelTypeInfo (const RGBPixel< TPixel > *)

template<typename TPixel >
void	SetPixelTypeInfo (const RGBAPixel< TPixel > *)

template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const Vector< TPixel, VLength > *)

template<typename TPixel >
void	SetPixelTypeInfo (const VariableLengthVector< TPixel > *)

template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const CovariantVector< TPixel, VLength > *)

template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const FixedArray< TPixel, VLength > *)

Public Member Functions inherited from itk::LightProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual const bool &	GetAbortGenerateData ()

virtual void	SetAbortGenerateData (bool _arg)

virtual void	UpdateOutputData ()

void	UpdateProgress (float amount)

virtual void	SetProgress (float _arg)

virtual const float &	GetProgress ()

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 ModifiedTimeType	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
	OpenCVVideoIO ()

void	OpenReader ()

void	OpenWriter ()

void	PrintSelf (std::ostream &os, Indent indent) const

void	ResetMembers ()

void	UpdateReaderProperties ()

	~OpenCVVideoIO ()

Protected Member Functions inherited from itk::VideoIOBase
	VideoIOBase ()

virtual	~VideoIOBase ()

Protected Member Functions inherited from itk::ImageIOBase
void	AddSupportedReadExtension (const char *extension)

void	AddSupportedWriteExtension (const char *extension)

void	ComputeStrides ()

virtual unsigned int	GetActualNumberOfSplitsForWritingCanStreamWrite (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion) const

SizeType	GetComponentStride () const

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter (void) const

virtual unsigned int	GetPixelSize () const

SizeType	GetRowStride () const

SizeType	GetSliceStride () const

virtual ImageIORegion	GetSplitRegionForWritingCanStreamWrite (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion) const

	ImageIOBase ()

virtual void	ReadBufferAsASCII (std::istream &os, void *buffer, IOComponentType ctype, SizeType numberOfBytesToBeRead)

bool	ReadBufferAsBinary (std::istream &os, void *buffer, SizeType numberOfBytesToBeRead)

virtual void	Reset (const bool freeDynamic=true)

void	Resize (const unsigned int numDimensions, const unsigned int *dimensions)

virtual void	WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentType ctype, SizeType numberOfBytesToWrite)

	~ImageIOBase ()

Protected Member Functions inherited from itk::LightProcessObject
virtual void	GenerateData ()

	LightProcessObject ()

	~LightProcessObject ()

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
	OpenCVVideoIO (const Self &)

void	operator= (const Self &)

Private Attributes
int	m_CameraIndex

CvCapture *	m_Capture

IplImage *	m_CVImage

int	m_FourCC

IplImage *	m_TempImage

CvVideoWriter *	m_Writer

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Protected Attributes inherited from itk::VideoIOBase
FrameOffsetType	m_CurrentFrame

TemporalRatioType	m_FramesPerSecond

FrameOffsetType	m_FrameTotal

FrameOffsetType	m_IFrameInterval

FrameOffsetType	m_LastIFrame

TemporalOffsetType	m_PositionInMSec

TemporalRatioType	m_Ratio

bool	m_ReaderOpen

ReadType	m_ReadType

bool	m_WriterOpen

Member Typedef Documentation

typedef Superclass::CameraIDType itk::OpenCVVideoIO::CameraIDType

Definition at line 45 of file itkOpenCVVideoIO.h.

typedef Superclass::FrameOffsetType itk::OpenCVVideoIO::FrameOffsetType

Definition at line 43 of file itkOpenCVVideoIO.h.

typedef SmartPointer< Self > itk::OpenCVVideoIO::Pointer

Definition at line 40 of file itkOpenCVVideoIO.h.

typedef OpenCVVideoIO itk::OpenCVVideoIO::Self

Standard class typedefs.

Definition at line 38 of file itkOpenCVVideoIO.h.

typedef VideoIOBase itk::OpenCVVideoIO::Superclass

Definition at line 39 of file itkOpenCVVideoIO.h.

typedef Superclass::TemporalOffsetType itk::OpenCVVideoIO::TemporalOffsetType

Definition at line 42 of file itkOpenCVVideoIO.h.

typedef Superclass::TemporalRatioType itk::OpenCVVideoIO::TemporalRatioType

Definition at line 44 of file itkOpenCVVideoIO.h.

Constructor & Destructor Documentation

itk::OpenCVVideoIO::OpenCVVideoIO ( )

protected

itk::OpenCVVideoIO::~OpenCVVideoIO ( )

protected

itk::OpenCVVideoIO::OpenCVVideoIO ( const Self & )

private

Member Function Documentation

virtual bool itk::OpenCVVideoIO::CanReadCamera ( CameraIDType cameraID ) const

virtual

Return whether or not the VideoIO can read from a camera

Implements itk::VideoIOBase.

virtual bool itk::OpenCVVideoIO::CanReadFile ( const char * )

virtual

Determine the file type. Returns true if this ImageIO can read the file specified.

Implements itk::ImageIOBase.

virtual bool itk::OpenCVVideoIO::CanWriteFile ( const char * )

virtual

Determine the file type. Returns true if this ImageIO can write the file specified.

Implements itk::ImageIOBase.

virtual::itk::LightObject::Pointer itk::OpenCVVideoIO::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::LightProcessObject.

virtual void itk::OpenCVVideoIO::FinishReadingOrWriting ( )

virtual

Close the reader and writer and reset members

Implements itk::VideoIOBase.

virtual CameraIDType itk::OpenCVVideoIO::GetCameraIndex ( ) const

virtual

Get/Set the camera index

virtual FrameOffsetType itk::OpenCVVideoIO::GetCurrentFrame ( ) const

virtual

Virtual accessor functions to be implemented in each derived class

Implements itk::VideoIOBase.

virtual std::vector< double > itk::OpenCVVideoIO::GetDirection ( unsigned int i ) const

inlinevirtual

Override Accessors to pass default values since OpenCV doesn't handle this type of meta data.

Reimplemented from itk::ImageIOBase.

Definition at line 104 of file itkOpenCVVideoIO.h.

virtual TemporalRatioType itk::OpenCVVideoIO::GetFramesPerSecond ( ) const

virtual

Virtual accessor functions to be implemented in each derived class

Implements itk::VideoIOBase.

virtual FrameOffsetType itk::OpenCVVideoIO::GetFrameTotal ( ) const

virtual

Virtual accessor functions to be implemented in each derived class

Implements itk::VideoIOBase.

virtual FrameOffsetType itk::OpenCVVideoIO::GetIFrameInterval ( ) const

virtual

Virtual accessor functions to be implemented in each derived class

virtual FrameOffsetType itk::OpenCVVideoIO::GetLastIFrame ( ) const

virtual

Virtual accessor functions to be implemented in each derived class

Implements itk::VideoIOBase.

virtual const char* itk::OpenCVVideoIO::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::VideoIOBase.

virtual double itk::OpenCVVideoIO::GetOrigin ( unsigned int ) const

inlinevirtual

Override Accessors to pass default values since OpenCV doesn't handle this type of meta data.

Reimplemented from itk::ImageIOBase.

Definition at line 102 of file itkOpenCVVideoIO.h.

virtual TemporalOffsetType itk::OpenCVVideoIO::GetPositionInMSec ( ) const

virtual

Virtual accessor functions to be implemented in each derived class

Implements itk::VideoIOBase.

virtual TemporalRatioType itk::OpenCVVideoIO::GetRatio ( ) const

virtual

Virtual accessor functions to be implemented in each derived class

Implements itk::VideoIOBase.

virtual double itk::OpenCVVideoIO::GetSpacing ( unsigned int ) const

inlinevirtual

Override Accessors to pass default values since OpenCV doesn't handle this type of meta data.

Reimplemented from itk::ImageIOBase.

Definition at line 100 of file itkOpenCVVideoIO.h.

static Pointer itk::OpenCVVideoIO::New ( )

static

Method for creation through the object factory.

void itk::OpenCVVideoIO::OpenReader ( )

protected

Open the reader iff the writer is not open

void itk::OpenCVVideoIO::OpenWriter ( )

protected

Open the writer iff the reader is not open

void itk::OpenCVVideoIO::operator= ( const Self & )

private

void itk::OpenCVVideoIO::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::VideoIOBase.

virtual void itk::OpenCVVideoIO::Read ( void * buffer )

virtual

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

virtual void itk::OpenCVVideoIO::ReadImageInformation ( )

virtual

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.

void itk::OpenCVVideoIO::ResetMembers ( )

protected

Reset member variables to empty state closed

virtual void itk::OpenCVVideoIO::SetCameraIndex ( CameraIDType idx )

virtual

Get/Set the camera index

virtual bool itk::OpenCVVideoIO::SetNextFrameToRead ( FrameOffsetType frameNumber )

virtual

Set the next frame that should be read. Return true if you operation successful

Implements itk::VideoIOBase.

virtual void itk::OpenCVVideoIO::SetReadFromCamera ( )

virtual

Set to reading from a camera

Implements itk::VideoIOBase.

virtual void itk::OpenCVVideoIO::SetReadFromFile ( )

virtual

Set to reading from file

Implements itk::VideoIOBase.

virtual void itk::OpenCVVideoIO::SetWriterParameters	(	TemporalRatioType	fps,
		const std::vector< SizeValueType > &	dim,
		const char *	fourCC,
		unsigned int	nChannels,
		IOComponentType	componentType
	)

virtual

Set Writer Parameters

Implements itk::VideoIOBase.

void itk::OpenCVVideoIO::UpdateReaderProperties ( )

protected

Update the local members from the internal capture

virtual void itk::OpenCVVideoIO::Write ( const void * buffer )

virtual

Writes the data to disk from the memory buffer provided. Make sure that the IORegion has been set properly.

Implements itk::ImageIOBase.

virtual void itk::OpenCVVideoIO::WriteImageInformation ( )

virtual

Writes the spacing and dimensions of the image. Assumes SetFileName has been called with a valid file name.

Implements itk::ImageIOBase.

Member Data Documentation

int itk::OpenCVVideoIO::m_CameraIndex

private

device index for reading from a camera (may move to base class)

Definition at line 157 of file itkOpenCVVideoIO.h.

CvCapture* itk::OpenCVVideoIO::m_Capture

private

Definition at line 152 of file itkOpenCVVideoIO.h.

IplImage* itk::OpenCVVideoIO::m_CVImage

private

Member Variables

Definition at line 150 of file itkOpenCVVideoIO.h.

int itk::OpenCVVideoIO::m_FourCC

private

Definition at line 154 of file itkOpenCVVideoIO.h.

IplImage* itk::OpenCVVideoIO::m_TempImage

private

Definition at line 151 of file itkOpenCVVideoIO.h.

CvVideoWriter* itk::OpenCVVideoIO::m_Writer

private

Definition at line 153 of file itkOpenCVVideoIO.h.

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

itkOpenCVVideoIO.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation