ITK  4.1.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 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

Protected Member Functions

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

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

Private Member Functions

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

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

virtual itk::VideoIOBase::~VideoIOBase ( ) [protected, virtual]
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.

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

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 succesful

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

Definition at line 125 of file itkVideoIOBase.h.

Definition at line 123 of file itkVideoIOBase.h.

Definition at line 124 of file itkVideoIOBase.h.

Definition at line 126 of file itkVideoIOBase.h.

Definition at line 127 of file itkVideoIOBase.h.

Definition at line 129 of file itkVideoIOBase.h.

Definition at line 128 of file itkVideoIOBase.h.

Definition at line 131 of file itkVideoIOBase.h.

Member Variables

Definition at line 122 of file itkVideoIOBase.h.

Definition at line 130 of file itkVideoIOBase.h.


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