ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | List of all members
itk::VideoIOBase Class Referenceabstract

#include <itkVideoIOBase.h>

+ Inheritance diagram for itk::VideoIOBase:
+ Collaboration diagram for itk::VideoIOBase:

Public Types

using CameraIDType = SizeValueType
 
using FrameOffsetType = SizeValueType
 
using Pointer = SmartPointer< Self >
 
using ReadFromEnum = VideoIOBaseEnums::ReadFrom
 
using Self = VideoIOBase
 
using SizeValueType = ::itk::SizeValueType
 
using Superclass = ImageIOBase
 
using TemporalOffsetType = double
 
using TemporalRatioType = double
 
- Public Types inherited from itk::ImageIOBase
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = ImageIOBase
 
using Superclass = LightProcessObject
 
using IndexValueType = ::itk::IndexValueType
 
using SizeValueType = ::itk::SizeValueType
 
using IOComponentEnum = itk::IOComponentEnum
 
using IOFileEnum = itk::IOFileEnum
 
using IOByteOrderEnum = itk::IOByteOrderEnum
 
using SizeType = ::itk::intmax_t
 
using BufferSizeType = ::itk::OffsetValueType
 
using ArrayOfExtensionsType = std::vector< std::string >
 
- 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
 
ReadFromEnum GetReadFrom ()
 
virtual bool SetNextFrameToRead (FrameOffsetType frameNumber)=0
 
virtual void SetReadFromCamera ()=0
 
virtual void SetReadFromFile ()=0
 
- Public Member Functions inherited from itk::ImageIOBase
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
void SetNumberOfDimensions (unsigned int)
 
virtual unsigned int GetNumberOfDimensions () const
 
virtual void SetDimensions (unsigned int i, SizeValueType dim)
 
virtual SizeValueType GetDimensions (unsigned int i) const
 
virtual void SetOrigin (unsigned int i, double origin)
 
virtual double GetOrigin (unsigned int i) const
 
virtual void SetSpacing (unsigned int i, double spacing)
 
virtual double GetSpacing (unsigned int i) const
 
virtual void SetDirection (unsigned int i, const std::vector< double > &direction)
 
virtual void SetDirection (unsigned int i, const vnl_vector< double > &direction)
 
virtual std::vector< double > GetDirection (unsigned int i) const
 
virtual std::vector< double > GetDefaultDirection (unsigned int i) const
 
virtual void SetIORegion (ImageIORegion _arg)
 
virtual const ImageIORegionGetIORegion () const
 
virtual void SetPixelType (const ::itk::CommonEnums::IOPixel _arg)
 
virtual ::itk::CommonEnums::IOPixel GetPixelType () const
 
virtual void SetComponentType (const IOComponentEnum _arg)
 
virtual IOComponentEnum GetComponentType () const
 
virtual const std::type_info & GetComponentTypeInfo () 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 SetCompressionLevel (int _arg)
 
virtual int GetCompressionLevel () const
 
virtual void SetCompressor (std::string _c)
 
virtual const std::string & GetCompressor () const
 
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 SetWritePalette (bool _arg)
 
virtual bool GetWritePalette () const
 
virtual void WritePaletteOn ()
 
virtual void WritePaletteOff ()
 
virtual bool GetIsReadAsScalarPlusPalette () const
 
virtual void SetFileType (const IOFileEnum _arg)
 
virtual IOFileEnum GetFileType () const
 
void SetFileTypeToASCII ()
 
void SetFileTypeToBinary ()
 
virtual void SetByteOrder (const IOByteOrderEnum _arg)
 
virtual IOByteOrderEnum GetByteOrder () const
 
void SetByteOrderToBigEndian ()
 
void SetByteOrderToLittleEndian ()
 
std::string GetFileTypeAsString (IOFileEnum) const
 
std::string GetByteOrderAsString (IOByteOrderEnum) const
 
virtual SizeType GetPixelStride () const
 
SizeType GetImageSizeInPixels () const
 
SizeType GetImageSizeInBytes () const
 
SizeType GetImageSizeInComponents () const
 
virtual unsigned int GetComponentSize () const
 
virtual bool CanReadFile (const char *)=0
 
virtual bool CanStreamRead ()
 
virtual void ReadImageInformation ()=0
 
virtual void Read (void *buffer)=0
 
virtual bool CanWriteFile (const char *)=0
 
virtual bool CanStreamWrite ()
 
virtual void WriteImageInformation ()=0
 
virtual void Write (const void *buffer)=0
 
virtual bool SupportsDimension (unsigned long dim)
 
virtual ImageIORegion GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requested) const
 
virtual unsigned int GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
 
virtual ImageIORegion GetSplitRegionForWriting (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
 
const ArrayOfExtensionsTypeGetSupportedReadExtensions () const
 
const ArrayOfExtensionsTypeGetSupportedWriteExtensions () const
 
template<typename TPixel >
void SetTypeInfo (const TPixel *)
 
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 > *)
 
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 > *)
 
- 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 SetProgress (float _arg)
 
virtual const float & GetProgress () const
 
void UpdateProgress (float amount)
 
virtual void UpdateOutputData ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
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
 
ReadFromEnum m_ReadFrom { ReadFromEnum::ReadFromFile }
 
TemporalRatioType m_FramesPerSecond { 0.0 }
 
FrameOffsetType m_FrameTotal
 
FrameOffsetType m_CurrentFrame
 
FrameOffsetType m_IFrameInterval
 
FrameOffsetType m_LastIFrame
 
TemporalRatioType m_Ratio { 0.0 }
 
TemporalOffsetType m_PositionInMSec { 0.0 }
 
bool m_WriterOpen { false }
 
bool m_ReaderOpen { false }
 
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
 
virtual void SetWriterParameters (TemporalRatioType framesPerSecond, const std::vector< SizeValueType > &dim, const char *fourCC, unsigned int nChannels, IOComponentEnum componentType)=0
 
 VideoIOBase ()
 
 ~VideoIOBase () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::ImageIOBase
static std::string GetComponentTypeAsString (IOComponentEnum)
 
static IOComponentEnum GetComponentTypeFromString (const std::string &typeString)
 
static std::string GetPixelTypeAsString (IOPixelEnum)
 
static IOPixelEnum 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 ()
 
- Protected Member Functions inherited from itk::ImageIOBase
 ImageIOBase ()
 
 ~ImageIOBase () override
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
virtual bool HasSupportedReadExtension (const char *fileName, bool ignoreCase=true)
 
virtual bool HasSupportedWriteExtension (const char *fileName, bool ignoreCase=true)
 
virtual void SetMaximumCompressionLevel (int)
 
virtual int GetMaximumCompressionLevel () const
 
virtual void InternalSetCompressor (const std::string &COMPRESSOR)
 
virtual void Reset (const bool freeDynamic=true)
 
void Resize (const unsigned int numDimensions, const unsigned int *dimensions)
 
virtual unsigned int GetPixelSize () const
 
void ComputeStrides ()
 
SizeType GetComponentStride () const
 
SizeType GetRowStride () const
 
SizeType GetSliceStride () const
 
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 WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentEnum ctype, SizeType numberOfBytesToWrite)
 
virtual void ReadBufferAsASCII (std::istream &os, void *buffer, IOComponentEnum ctype, SizeType numberOfBytesToBeRead)
 
bool ReadBufferAsBinary (std::istream &os, void *buffer, SizeType numberOfBytesToBeRead)
 
void AddSupportedReadExtension (const char *extension)
 
void AddSupportedWriteExtension (const char *extension)
 
void SetSupportedReadExtensions (const ArrayOfExtensionsType &)
 
void SetSupportedWriteExtensions (const ArrayOfExtensionsType &)
 
virtual unsigned int GetActualNumberOfSplitsForWritingCanStreamWrite (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion) const
 
virtual ImageIORegion GetSplitRegionForWritingCanStreamWrite (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion) const
 
- Protected Member Functions inherited from itk::LightProcessObject
 LightProcessObject ()
 
 ~LightProcessObject () override
 
virtual void GenerateData ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 inherited from itk::ImageIOBase
IOPixelEnum m_PixelType { IOPixelEnum::SCALAR }
 
IOComponentEnum m_ComponentType { IOComponentEnum::UNKNOWNCOMPONENTTYPE }
 
IOByteOrderEnum m_ByteOrder { IOByteOrderEnum::OrderNotApplicable }
 
IOFileEnum m_FileType { IOFileEnum::TypeNotApplicable }
 
bool m_Initialized
 
std::string m_FileName
 
unsigned int m_NumberOfComponents
 
unsigned int m_NumberOfDimensions { 0 }
 
bool m_UseCompression { false }
 
int m_CompressionLevel { 30 }
 
int m_MaximumCompressionLevel { 100 }
 
std::string m_Compressor { "uninitialized" }
 
bool m_UseStreamedReading
 
bool m_UseStreamedWriting
 
bool m_ExpandRGBPalette
 
bool m_IsReadAsScalarPlusPalette
 
bool m_WritePalette
 
ImageIORegion m_IORegion
 
std::vector< SizeValueTypem_Dimensions
 
std::vector< double > m_Spacing
 
std::vector< double > m_Origin
 
std::vector< std::vector< double > > m_Direction
 
std::vector< SizeTypem_Strides
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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 70 of file itkVideoIOBase.h.

Member Typedef Documentation

◆ CameraIDType

Video-specific type alias

Definition at line 87 of file itkVideoIOBase.h.

◆ FrameOffsetType

Definition at line 83 of file itkVideoIOBase.h.

◆ Pointer

Definition at line 78 of file itkVideoIOBase.h.

◆ ReadFromEnum

Definition at line 98 of file itkVideoIOBase.h.

◆ Self

Standard class type aliases.

Definition at line 76 of file itkVideoIOBase.h.

◆ SizeValueType

Definition at line 79 of file itkVideoIOBase.h.

◆ Superclass

Definition at line 77 of file itkVideoIOBase.h.

◆ TemporalOffsetType

Frame offset type alias

Definition at line 82 of file itkVideoIOBase.h.

◆ TemporalRatioType

Definition at line 84 of file itkVideoIOBase.h.

Constructor & Destructor Documentation

◆ VideoIOBase()

itk::VideoIOBase::VideoIOBase ( )
protected

Member Variables

◆ ~VideoIOBase()

itk::VideoIOBase::~VideoIOBase ( )
overrideprotected

Member Variables

Member Function Documentation

◆ CanReadCamera()

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::VXLVideoIO, and itk::OpenCVVideoIO.

◆ FinishReadingOrWriting()

virtual void itk::VideoIOBase::FinishReadingOrWriting ( )
pure virtual

Close the reader and writer and reset members

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

◆ GetCurrentFrame()

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

Member Variables

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

◆ GetFramesPerSecond()

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

Member Variables

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

◆ GetFrameTotal()

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

Member Variables

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

◆ GetLastIFrame()

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

Member Variables

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

◆ GetNameOfClass()

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.

◆ GetPositionInMSec()

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

Virtual accessor functions to be implemented in each derived class

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

◆ GetRatio()

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

Member Variables

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

◆ GetReadFrom()

ReadFromEnum itk::VideoIOBase::GetReadFrom ( )
inline

Get the current read type

Definition at line 116 of file itkVideoIOBase.h.

◆ PrintSelf()

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

Member Variables

Reimplemented from itk::ImageIOBase.

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

◆ SetNextFrameToRead()

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::VXLVideoIO, and itk::OpenCVVideoIO.

◆ SetReadFromCamera()

virtual void itk::VideoIOBase::SetReadFromCamera ( )
pure virtual

Set to reading from a camera

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

◆ SetReadFromFile()

virtual void itk::VideoIOBase::SetReadFromFile ( )
pure virtual

Set to reading from file

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

◆ SetWriterParameters()

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

Set Writer Parameters

Implemented in itk::FileListVideoIO.

Member Data Documentation

◆ m_CurrentFrame

FrameOffsetType itk::VideoIOBase::m_CurrentFrame
protected

Member Variables

Definition at line 167 of file itkVideoIOBase.h.

◆ m_FramesPerSecond

TemporalRatioType itk::VideoIOBase::m_FramesPerSecond { 0.0 }
protected

Member Variables

Definition at line 165 of file itkVideoIOBase.h.

◆ m_FrameTotal

FrameOffsetType itk::VideoIOBase::m_FrameTotal
protected

Member Variables

Definition at line 166 of file itkVideoIOBase.h.

◆ m_IFrameInterval

FrameOffsetType itk::VideoIOBase::m_IFrameInterval
protected

Member Variables

Definition at line 168 of file itkVideoIOBase.h.

◆ m_LastIFrame

FrameOffsetType itk::VideoIOBase::m_LastIFrame
protected

Member Variables

Definition at line 169 of file itkVideoIOBase.h.

◆ m_PositionInMSec

TemporalOffsetType itk::VideoIOBase::m_PositionInMSec { 0.0 }
protected

Member Variables

Definition at line 171 of file itkVideoIOBase.h.

◆ m_Ratio

TemporalRatioType itk::VideoIOBase::m_Ratio { 0.0 }
protected

Member Variables

Definition at line 170 of file itkVideoIOBase.h.

◆ m_ReaderOpen

bool itk::VideoIOBase::m_ReaderOpen { false }
protected

Member Variables

Definition at line 173 of file itkVideoIOBase.h.

◆ m_ReadFrom

ReadFromEnum itk::VideoIOBase::m_ReadFrom { ReadFromEnum::ReadFromFile }
protected

Member Variables

Definition at line 164 of file itkVideoIOBase.h.

◆ m_WriterOpen

bool itk::VideoIOBase::m_WriterOpen { false }
protected

Member Variables

Definition at line 172 of file itkVideoIOBase.h.


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