#include <itkVideoIOBase.h>

Inheritance diagram for itk::VideoIOBase:

Collaboration diagram for itk::VideoIOBase:

Detailed Description

Abstract superclass defines video IO interface.

VideoIOBase is a class that reads and/or writes video data using a particular external technique or external library (OpenCV, vxl). The VideoIOBase encapsulates both the reading and writing of data. The VideoIOBase is used by the VideoFileReader class (to read data) and the VideoFileWriter (to write data). Normally the user does not directly manipulate this class directly.

A Pluggable factory pattern is used. This allows different kinds of readers to be registered (even at run time) without having to modify the code in this class.

See Also: VideoFileWriter; VideoFileReader

Definition at line 49 of file itkVideoIOBase.h.

Public Types
using	CameraIDType = SizeValueType

using	FrameOffsetType = SizeValueType

using	Pointer = SmartPointer< Self >

enum	ReadType { ReadFromFile, ReadFromCamera }

using	Self = VideoIOBase

using	SizeValueType = ::itk::SizeValueType

using	Superclass = ImageIOBase

using	TemporalOffsetType = double

using	TemporalRatioType = double

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

using	BufferSizeType = ::itk::OffsetValueType

enum	ByteOrder { BigEndian, LittleEndian, OrderNotApplicable }

using	ConstPointer = SmartPointer< const Self >

enum	FileType { ASCII, Binary, TypeNotApplicable }

using	IndexValueType = ::itk::IndexValueType

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

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

using	Pointer = SmartPointer< Self >

using	Self = ImageIOBase

using	SizeType = ::itk::intmax_t

using	SizeValueType = ::itk::SizeValueType

using	Superclass = LightProcessObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightProcessObject

using	Superclass = Object

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
virtual bool	CanReadCamera (CameraIDType cameraID) const =0

virtual void	FinishReadingOrWriting ()=0

virtual const char *	GetNameOfClass () const

ReadType	GetReadType ()

virtual bool	SetNextFrameToRead (FrameOffsetType frameNumber)=0

virtual void	SetReadFromCamera ()=0

virtual void	SetReadFromFile ()=0

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


virtual TemporalOffsetType	GetPositionInMSec () const =0

virtual TemporalRatioType	GetRatio () const =0

virtual FrameOffsetType	GetFrameTotal () const =0

virtual TemporalRatioType	GetFramesPerSecond () const =0

virtual FrameOffsetType	GetCurrentFrame () const =0

virtual FrameOffsetType	GetLastIFrame () const =0

Public Member Functions inherited from itk::ImageIOBase
virtual bool	CanReadFile (const char *)=0

virtual bool	CanStreamRead ()

virtual bool	CanStreamWrite ()

virtual bool	CanWriteFile (const char *)=0

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 SizeValueType	GetDimensions (unsigned int i) const

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

std::string	GetFileTypeAsString (FileType) const

SizeType	GetImageSizeInBytes () const

SizeType	GetImageSizeInComponents () const

SizeType	GetImageSizeInPixels () const

virtual bool	GetIsReadAsScalarPlusPalette () const

virtual unsigned int	GetNumberOfDimensions () const

virtual double	GetOrigin (unsigned int i) const

virtual SizeType	GetPixelStride () const

virtual double	GetSpacing (unsigned int i) const

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

const ArrayOfExtensionsType &	GetSupportedReadExtensions () const

const ArrayOfExtensionsType &	GetSupportedWriteExtensions () const

virtual void	Read (void *buffer)=0

virtual void	ReadImageInformation ()=0

void	SetByteOrderToLittleEndian ()

virtual void	SetComponentType (const IOComponentType _arg)

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

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

void	SetFileTypeToBinary ()

void	SetNumberOfDimensions (unsigned int)

virtual void	SetOrigin (unsigned int i, double origin)

template<typename 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	Write (const void *buffer)=0

virtual void	WriteImageInformation ()=0

virtual void	SetFileName (const char *_arg)

virtual const char *	GetFileName () const

virtual void	SetDimensions (unsigned int i, SizeValueType dim)

virtual void	SetIORegion (ImageIORegion _arg)

virtual const ImageIORegion &	GetIORegion () const

virtual void	SetPixelType (const IOPixelType _arg)

virtual IOPixelType	GetPixelType () const

virtual void	SetNumberOfComponents (unsigned int _arg)

virtual const unsigned int &	GetNumberOfComponents () const

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	SetExpandRGBPalette (bool _arg)

virtual bool	GetExpandRGBPalette () const

virtual void	ExpandRGBPaletteOn ()

virtual void	ExpandRGBPaletteOff ()

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 ::itk::LightObject::Pointer	CreateAnother () const

virtual const bool &	GetAbortGenerateData () const

virtual void	SetAbortGenerateData (bool _arg)

virtual void	UpdateOutputData ()

void	UpdateProgress (float amount)

virtual void	SetProgress (float _arg)

virtual const float &	GetProgress () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () 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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexceptoverride

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

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

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const override

	VideoIOBase ()

	~VideoIOBase () override

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 () 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	OpenFileForReading (std::ifstream &inputStream, const std::string &filename, bool ascii=false)

virtual void	OpenFileForWriting (std::ofstream &outputStream, const std::string &filename, bool truncate=true, bool ascii=false)

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 () override

virtual bool	HasSupportedReadExtension (const char *fileName, bool ignoreCase=true)

virtual bool	HasSupportedWriteExtension (const char *fileName, bool ignoreCase=true)

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

	LightProcessObject ()

	~LightProcessObject () override

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

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

	~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 ()

Protected Attributes
FrameOffsetType	m_CurrentFrame

TemporalRatioType	m_FramesPerSecond {0.0}

FrameOffsetType	m_FrameTotal

FrameOffsetType	m_IFrameInterval

FrameOffsetType	m_LastIFrame

TemporalOffsetType	m_PositionInMSec {0.0}

TemporalRatioType	m_Ratio {0.0}

bool	m_ReaderOpen {false}

ReadType	m_ReadType {ReadFromFile}

bool	m_WriterOpen {false}

Protected Attributes inherited from itk::ImageIOBase
ByteOrder	m_ByteOrder {OrderNotApplicable}

IOComponentType	m_ComponentType {UNKNOWNCOMPONENTTYPE}

std::vector< SizeValueType >	m_Dimensions

std::vector< std::vector < double > >	m_Direction

bool	m_ExpandRGBPalette

std::string	m_FileName

FileType	m_FileType {TypeNotApplicable}

bool	m_Initialized

ImageIORegion	m_IORegion

bool	m_IsReadAsScalarPlusPalette

unsigned int	m_NumberOfComponents

unsigned int	m_NumberOfDimensions {0}

std::vector< double >	m_Origin

IOPixelType	m_PixelType {SCALAR}

std::vector< double >	m_Spacing

std::vector< SizeType >	m_Strides

bool	m_UseCompression

bool	m_UseStreamedReading

bool	m_UseStreamedWriting

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Additional Inherited Members
Static Public Member Functions inherited from itk::ImageIOBase
static std::string	GetComponentTypeAsString (IOComponentType)

static IOComponentType	GetComponentTypeFromString (const std::string &typeString)

static std::string	GetPixelTypeAsString (IOPixelType)

static IOPixelType	GetPixelTypeFromString (const std::string &pixelString)

Static Public Member Functions inherited from itk::LightProcessObject
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 ()

Member Typedef Documentation

using itk::VideoIOBase::CameraIDType = SizeValueType

Video-specific type alias

Definition at line 66 of file itkVideoIOBase.h.

using itk::VideoIOBase::FrameOffsetType = SizeValueType

Definition at line 62 of file itkVideoIOBase.h.

using itk::VideoIOBase::Pointer = SmartPointer< Self >

Definition at line 57 of file itkVideoIOBase.h.

using itk::VideoIOBase::Self = VideoIOBase

Standard class type aliases.

Definition at line 55 of file itkVideoIOBase.h.

using itk::VideoIOBase::SizeValueType = ::itk::SizeValueType

Definition at line 58 of file itkVideoIOBase.h.

using itk::VideoIOBase::Superclass = ImageIOBase

Definition at line 56 of file itkVideoIOBase.h.

using itk::VideoIOBase::TemporalOffsetType = double

Frame offset type alias

Definition at line 61 of file itkVideoIOBase.h.

using itk::VideoIOBase::TemporalRatioType = double

Definition at line 63 of file itkVideoIOBase.h.

Member Enumeration Documentation

enum itk::VideoIOBase::ReadType

Enum used to define weather to read from a file or a camera

Enumerator
ReadFromFile
ReadFromCamera

Definition at line 77 of file itkVideoIOBase.h.

Constructor & Destructor Documentation

itk::VideoIOBase::VideoIOBase ( )

protected

itk::VideoIOBase::~VideoIOBase ( )

overrideprotected

Member Function Documentation

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

pure virtual

Return whether or not the VideoIO can read from a camera. The cameraID can be a camera number for OpenCV or a guid for VXL

Implemented in itk::FileListVideoIO, itk::OpenCVVideoIO, and itk::VXLVideoIO.

virtual void itk::VideoIOBase::FinishReadingOrWriting ( )

pure virtual

Close the reader and writer and reset members

Implemented in itk::FileListVideoIO, itk::OpenCVVideoIO, and itk::VXLVideoIO.

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

pure virtual

Virtual accessor functions to be implemented in each derived class

Implemented in itk::FileListVideoIO, itk::OpenCVVideoIO, and itk::VXLVideoIO.

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

pure virtual

Virtual accessor functions to be implemented in each derived class

Implemented in itk::FileListVideoIO, itk::OpenCVVideoIO, and itk::VXLVideoIO.

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

pure virtual

Virtual accessor functions to be implemented in each derived class

Implemented in itk::FileListVideoIO, itk::OpenCVVideoIO, and itk::VXLVideoIO.

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

pure virtual

Virtual accessor functions to be implemented in each derived class

Implemented in itk::FileListVideoIO, itk::OpenCVVideoIO, and itk::VXLVideoIO.

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageIOBase.

Reimplemented in itk::OpenCVVideoIO, itk::VXLVideoIO, and itk::FileListVideoIO.

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

pure virtual

Virtual accessor functions to be implemented in each derived class

Implemented in itk::FileListVideoIO, itk::OpenCVVideoIO, and itk::VXLVideoIO.

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

pure virtual

Virtual accessor functions to be implemented in each derived class

Implemented in itk::FileListVideoIO, itk::OpenCVVideoIO, and itk::VXLVideoIO.

ReadType itk::VideoIOBase::GetReadType ( )

inline

Get the current read type

Definition at line 86 of file itkVideoIOBase.h.

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

overrideprotectedvirtual

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::ImageIOBase.

Reimplemented in itk::OpenCVVideoIO, and itk::VXLVideoIO.

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

pure virtual

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

Implemented in itk::FileListVideoIO, itk::OpenCVVideoIO, and itk::VXLVideoIO.

virtual void itk::VideoIOBase::SetReadFromCamera ( )

pure virtual

Set to reading from a camera

Implemented in itk::FileListVideoIO, itk::OpenCVVideoIO, and itk::VXLVideoIO.

virtual void itk::VideoIOBase::SetReadFromFile ( )

pure virtual

Set to reading from file

Implemented in itk::FileListVideoIO, itk::OpenCVVideoIO, and itk::VXLVideoIO.

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

pure virtual

Set Writer Parameters

Implemented in itk::FileListVideoIO, itk::OpenCVVideoIO, and itk::VXLVideoIO.

Member Data Documentation

FrameOffsetType itk::VideoIOBase::m_CurrentFrame

protected

Definition at line 127 of file itkVideoIOBase.h.

TemporalRatioType itk::VideoIOBase::m_FramesPerSecond {0.0}

protected

Definition at line 125 of file itkVideoIOBase.h.

FrameOffsetType itk::VideoIOBase::m_FrameTotal

protected

Definition at line 126 of file itkVideoIOBase.h.

FrameOffsetType itk::VideoIOBase::m_IFrameInterval

protected

Definition at line 128 of file itkVideoIOBase.h.

FrameOffsetType itk::VideoIOBase::m_LastIFrame

protected

Definition at line 129 of file itkVideoIOBase.h.

TemporalOffsetType itk::VideoIOBase::m_PositionInMSec {0.0}

protected

Definition at line 131 of file itkVideoIOBase.h.

TemporalRatioType itk::VideoIOBase::m_Ratio {0.0}

protected

Definition at line 130 of file itkVideoIOBase.h.

bool itk::VideoIOBase::m_ReaderOpen {false}

protected

Definition at line 133 of file itkVideoIOBase.h.

ReadType itk::VideoIOBase::m_ReadType {ReadFromFile}

protected

Member Variables

Definition at line 124 of file itkVideoIOBase.h.

bool itk::VideoIOBase::m_WriterOpen {false}

protected

Definition at line 132 of file itkVideoIOBase.h.

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

itkVideoIOBase.h

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation