libcvd
Public Member Functions | Friends | List of all members
CVD::DiskBuffer2Frame< T > Class Template Reference

A frame from a DiskBuffer2. More...

#include <diskbuffer2_frame.h>

Inheritance diagram for CVD::DiskBuffer2Frame< T >:
Inheritance graph
[legend]
Collaboration diagram for CVD::DiskBuffer2Frame< T >:
Collaboration graph
[legend]

Public Member Functions

const std::string & name ()
 What is the filename for this image?
 
void timestamp (double time)
 set the time stamp, required for TimedDiskBuffer2
 
- Public Member Functions inherited from CVD::LocalVideoFrame< T >
 LocalVideoFrame (double time, CVD::Image< T > &&local)
 Construct a video frame from an Image and a timestamp. More...
 
Image< T > & image ()
 Returns the image. More...
 
const Image< T > & image () const
 
double & timestamp ()
 
- Public Member Functions inherited from CVD::VideoFrame< T >
 VideoFrame (double t, T *data, const ImageRef &size, VideoFrameFlags::FieldType f=VideoFrameFlags::Unknown)
 (Used internally) Construct a VideoFrame around a block of memory. More...
 
 VideoFrame (double t, const BasicImage< T > &im, VideoFrameFlags::FieldType f=VideoFrameFlags::Unknown)
 (Used internally) Construct a VideoFrame from a BasicImage More...
 
double timestamp () const
 What is the time (since boot) of this frame?
 
VideoFrameFlags::FieldType field () const
 
- Public Member Functions inherited from CVD::BasicImage< T >
virtual ~BasicImage ()
 The image data is not destroyed when a BasicImage is destroyed.
 
ConstPointerType data () const
 Returns the raw image data.
 
PointerType data ()
 Returns the raw image data.
 
void copy_from (const BasicImage< T > &other)
 
ImageRef size () const
 What is the size of this image?
 
void zero ()
 Set image data to all zero bytes. More...
 
void fill (const T d)
 Set all the pixels in the image to a value. More...
 
 BasicImage (const BasicImage &copyof)=default
 Copy constructor. More...
 
BasicImageoperator= (const BasicImage &copyof)=default
 Assignment operator. More...
 
- Public Member Functions inherited from CVD::Internal::ImageData< T >
 ImageData (const ImageData &)=default
 
 ImageData (void *data, size_t len, ImageRef sz)
 
 ImageData (void *data, ImageRef sz)
 
ImageDataoperator= (const ImageData &)=default
 
size_t datalength () const
 What is the row stride of the image?
 

Friends

class CVD::DiskBuffer2< T >
 Allow DiskBuffer2 to create a DiskBuffer2Frame.
 

Additional Inherited Members

- Protected Types inherited from CVD::Internal::ImageData< T >
using PointerType = void *
 
using ConstPointerType = const void *
 
- Protected Member Functions inherited from CVD::VideoFrame< T >
virtual ~VideoFrame ()
 We don't usually delete video frames. Some special destruction is usually needed.
 
- Protected Attributes inherited from CVD::VideoFrame< T >
VideoFrameFlags::FieldType my_field
 
double my_timestamp
 Type of field in this frame. More...
 
- Protected Attributes inherited from CVD::Internal::ImageData< T >
void * my_data
 
ImageRef my_size
 
size_t data_length
 

Detailed Description

template<typename T>
class CVD::DiskBuffer2Frame< T >

A frame from a DiskBuffer2.

The frames in a DiskBuffer2 are image files loaded from disk.

Parameters
TThe pixel type of the frames to provide (usually CVD::Rgb<CVD::byte> or CVD::byte. If the image files are of a different type, they will be automatically converted (see Image loading and saving, and format conversion).

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