ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
itk::VideoIOBase Class Reference

#include <itkVideoIOBase.h>

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

List of all members.

Public Types

typedef SizeValueType CameraIDType
typedef SizeValueType FrameOffsetType
typedef SmartPointer< SelfPointer
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 ::itk::intmax_t SizeType
- Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const SelfConstPointer
- Public Types inherited from itk::Object
- Public Types inherited from itk::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 unsigned int 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 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 ArrayOfExtensionsTypeGetSupportedReadExtensions () const
const ArrayOfExtensionsTypeGetSupportedWriteExtensions () 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, 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 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, unsigned int dim)
virtual void SetIORegion (ImageIORegion _arg)
virtual const ImageIORegionGetIORegion ()
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 ::itk::LightObject::Pointer CreateAnother (void) const
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
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long 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
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

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const
 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 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
 LightProcessObject ()
 ~LightProcessObject ()
virtual void GenerateData ()
- 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

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
- Protected Attributes inherited from itk::ImageIOBase
ByteOrder m_ByteOrder
IOComponentType m_ComponentType
std::vector< SizeValueTypem_Dimensions
std::vector< std::vector
< double > > 
m_Direction
std::string m_FileName
FileType m_FileType
bool m_Initialized
ImageIORegion m_IORegion
unsigned int m_NumberOfComponents
unsigned int m_NumberOfDimensions
std::vector< double > m_Origin
IOPixelType m_PixelType
std::vector< double > m_Spacing
std::vector< SizeTypem_Strides
bool m_UseCompression
bool m_UseStreamedReading
bool m_UseStreamedWriting

Private Member Functions

void operator= (const Self &)
 VideoIOBase (const Self &)

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 void SetGlobalWarningDisplay (bool flag)
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()

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


Member Typedef Documentation

Video-specific typedefs

Definition at line 64 of file itkVideoIOBase.h.

Definition at line 60 of file itkVideoIOBase.h.

Reimplemented from itk::ImageIOBase.

Reimplemented in itk::FileListVideoIO.

Definition at line 55 of file itkVideoIOBase.h.

Standard class typedefs.

Reimplemented from itk::ImageIOBase.

Reimplemented in itk::FileListVideoIO.

Definition at line 53 of file itkVideoIOBase.h.

Reimplemented from itk::ImageIOBase.

Definition at line 56 of file itkVideoIOBase.h.

Reimplemented from itk::ImageIOBase.

Reimplemented in itk::FileListVideoIO.

Definition at line 54 of file itkVideoIOBase.h.

Frame offset typedefs

Definition at line 59 of file itkVideoIOBase.h.

Definition at line 61 of file itkVideoIOBase.h.


Member Enumeration Documentation

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

Enumerator:
ReadFromFile 
ReadFromCamera 

Definition at line 75 of file itkVideoIOBase.h.


Constructor & Destructor Documentation

itk::VideoIOBase::VideoIOBase ( )
protected
virtual itk::VideoIOBase::~VideoIOBase ( )
protectedvirtual
itk::VideoIOBase::VideoIOBase ( const Self )
private

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.

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

Close the reader and writer and reset members

Implemented in itk::FileListVideoIO.

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

Virtual accessor functions to be implemented in each derived class

Implemented in itk::FileListVideoIO.

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

Virtual accessor functions to be implemented in each derived class

Implemented in itk::FileListVideoIO.

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

Virtual accessor functions to be implemented in each derived class

Implemented in itk::FileListVideoIO.

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

Virtual accessor functions to be implemented in each derived class

Implemented in itk::FileListVideoIO.

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

Run-time type information (and related methods).

Reimplemented from itk::ImageIOBase.

Reimplemented in itk::FileListVideoIO.

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

Virtual accessor functions to be implemented in each derived class

Implemented in itk::FileListVideoIO.

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

Virtual accessor functions to be implemented in each derived class

Implemented in itk::FileListVideoIO.

ReadType itk::VideoIOBase::GetReadType ( )
inline

Get the current read type

Definition at line 84 of file itkVideoIOBase.h.

void itk::VideoIOBase::operator= ( const Self )
private

This method causes the filter to generate its output.

Reimplemented from itk::ImageIOBase.

Reimplemented in itk::FileListVideoIO.

void itk::VideoIOBase::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::ImageIOBase.

Reimplemented in itk::FileListVideoIO.

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.

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

Set to reading from a camera

Implemented in itk::FileListVideoIO.

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

Set to reading from file

Implemented in itk::FileListVideoIO.

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.


Member Data Documentation

FrameOffsetType itk::VideoIOBase::m_CurrentFrame
protected

Definition at line 125 of file itkVideoIOBase.h.

TemporalRatioType itk::VideoIOBase::m_FramesPerSecond
protected

Definition at line 123 of file itkVideoIOBase.h.

FrameOffsetType itk::VideoIOBase::m_FrameTotal
protected

Definition at line 124 of file itkVideoIOBase.h.

FrameOffsetType itk::VideoIOBase::m_IFrameInterval
protected

Definition at line 126 of file itkVideoIOBase.h.

FrameOffsetType itk::VideoIOBase::m_LastIFrame
protected

Definition at line 127 of file itkVideoIOBase.h.

TemporalOffsetType itk::VideoIOBase::m_PositionInMSec
protected

Definition at line 129 of file itkVideoIOBase.h.

TemporalRatioType itk::VideoIOBase::m_Ratio
protected

Definition at line 128 of file itkVideoIOBase.h.

bool itk::VideoIOBase::m_ReaderOpen
protected

Definition at line 131 of file itkVideoIOBase.h.

ReadType itk::VideoIOBase::m_ReadType
protected

Member Variables

Definition at line 122 of file itkVideoIOBase.h.

bool itk::VideoIOBase::m_WriterOpen
protected

Definition at line 130 of file itkVideoIOBase.h.


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