CVD::VideoFrame< T > Class Template Reference
[Video frames]

#include <videoframe.h>

Inheritance diagram for CVD::VideoFrame< T >:

CVD::BasicImage< T > CVD::SubImage< T > CVD::DeinterlaceFrame< T > CVD::DVFrame CVD::LocalVideoFrame< T > CVD::O2VideoFrame CVD::V4L1Frame< T > CVD::V4L2FrameT< T > CVD::ColourspaceFrame< T > CVD::DiskBuffer2Frame< T > CVD::ServerPushJpegFrame< T > CVD::VideoFileFrame< T >

List of all members.


Detailed Description

template<class T>
class CVD::VideoFrame< T >

A frame from a VideoBuffer.

Parameters:
T The pixel type of the video frames

Definition at line 53 of file videoframe.h.


Public Member Functions

 VideoFrame (double t, T *data, const ImageRef &size, VideoFrameFlags::FieldType f=VideoFrameFlags::Unknown)
 VideoFrame (double t, const BasicImage< T > &im, VideoFrameFlags::FieldType f=VideoFrameFlags::Unknown)
double timestamp () const
VideoFrameFlags::FieldType field () const

Protected Member Functions

virtual ~VideoFrame ()

Protected Attributes

VideoFrameFlags::FieldType my_field
double my_timestamp

Constructor & Destructor Documentation

template<class T>
CVD::VideoFrame< T >::VideoFrame ( double  t,
T *  data,
const ImageRef size,
VideoFrameFlags::FieldType  f = VideoFrameFlags::Unknown 
) [inline]

(Used internally) Construct a VideoFrame around a block of memory.

The memory is not managed by the VideoFrame so must me managed seperately

Parameters:
t The time (in seconds) of this frame
data The image data for this frame
size The size of this video frame

Definition at line 61 of file videoframe.h.

template<class T>
CVD::VideoFrame< T >::VideoFrame ( double  t,
const BasicImage< T > &  im,
VideoFrameFlags::FieldType  f = VideoFrameFlags::Unknown 
) [inline]

(Used internally) Construct a VideoFrame from a BasicImage

Parameters:
t The time (in seconds) of this frame
im The image data for this frame. BasicImages do not manage their own memory, so this must be managed externally

Definition at line 70 of file videoframe.h.

template<class T>
virtual CVD::VideoFrame< T >::~VideoFrame (  )  [inline, protected, virtual]

We don't usually delete video frames. Some special destruction is usually needed.

Definition at line 88 of file videoframe.h.


Member Function Documentation

template<class T>
double CVD::VideoFrame< T >::timestamp (  )  const [inline]

What is the time (since boot) of this frame?

Definition at line 76 of file videoframe.h.


Member Data Documentation

template<class T>
double CVD::VideoFrame< T >::my_timestamp [protected]

Type of field in this frame.

No of seconds since boot of this frame

Definition at line 93 of file videoframe.h.

Referenced by CVD::VideoFrame< CVD::Rgb8 >::timestamp(), CVD::LocalVideoFrame< T >::timestamp(), and CVD::DiskBuffer2Frame< T >::timestamp().


The documentation for this class was generated from the following file:
Generated on Wed Feb 18 10:23:09 2009 for CVD by  doxygen 1.5.3