Fawkes API Fawkes Development Version
|
Simple buffer with a Camera interface. More...
#include <>>
Public Member Functions | |
BufferCamera (colorspace_t cspace, unsigned int width, unsigned int height) | |
Constructor. More... | |
~BufferCamera () | |
Destructor. More... | |
virtual void | open () |
Open the camera. More... | |
virtual void | start () |
Start image transfer from the camera. More... | |
virtual void | stop () |
Stop image transfer from the camera. More... | |
virtual void | close () |
Close camera. More... | |
virtual void | capture () |
Capture an image. More... | |
virtual void | flush () |
Flush image queue. More... | |
virtual bool | ready () |
Camera is ready for taking pictures. More... | |
virtual void | print_info () |
Print out camera information. More... | |
virtual unsigned char * | buffer () |
Get access to current image buffer. More... | |
virtual unsigned int | buffer_size () |
Size of buffer. More... | |
virtual void | dispose_buffer () |
Dispose current buffer. More... | |
virtual unsigned int | pixel_width () |
Width of image in pixels. More... | |
virtual unsigned int | pixel_height () |
Height of image in pixels. More... | |
virtual colorspace_t | colorspace () |
Colorspace of returned image. More... | |
virtual void | set_image_number (unsigned int n) |
Set image number to retrieve. More... | |
![]() | |
virtual | ~Camera () |
Virtual empty destructor. More... | |
virtual void | open ()=0 |
Open the camera. More... | |
virtual void | start ()=0 |
Start image transfer from the camera. More... | |
virtual void | stop ()=0 |
Stop image transfer from the camera. More... | |
virtual void | close ()=0 |
Close camera. More... | |
virtual void | capture ()=0 |
Capture an image. More... | |
virtual void | flush ()=0 |
Flush image queue. More... | |
virtual bool | ready ()=0 |
Camera is ready for taking pictures. More... | |
virtual void | print_info ()=0 |
Print out camera information. More... | |
virtual unsigned char * | buffer ()=0 |
Get access to current image buffer. More... | |
virtual unsigned int | buffer_size ()=0 |
Size of buffer. More... | |
virtual void | dispose_buffer ()=0 |
Dispose current buffer. More... | |
virtual unsigned int | pixel_width ()=0 |
Width of image in pixels. More... | |
virtual unsigned int | pixel_height ()=0 |
Height of image in pixels. More... | |
virtual colorspace_t | colorspace ()=0 |
Colorspace of returned image. More... | |
virtual fawkes::Time * | capture_time () |
Get the Time of the last successfully captured image. More... | |
virtual void | set_image_number (unsigned int n)=0 |
Set image number to retrieve. More... | |
Simple buffer with a Camera interface.
This camera implementation provides a simple image buffer that can be modified externally and is wrapped using the standard Camera interface.
firevision::BufferCamera::BufferCamera | ( | colorspace_t | cspace, |
unsigned int | width, | ||
unsigned int | height | ||
) |
Constructor.
cspace | color space of image |
width | width of image |
height | height of image |
Definition at line 44 of file buffer.cpp.
firevision::BufferCamera::~BufferCamera | ( | ) |
Destructor.
Definition at line 54 of file buffer.cpp.
|
virtual |
Get access to current image buffer.
This will return a pointer to the current buffer. The buffer contains an image of the given colorspace, width and height.
Implements firevision::Camera.
Definition at line 85 of file buffer.cpp.
|
virtual |
Size of buffer.
Gets the size in bytes of the buffer returned by buffer().
Implements firevision::Camera.
Definition at line 91 of file buffer.cpp.
|
virtual |
Capture an image.
Although cameras shall operate with a continuous image flow where possible sometimes capturing an image means copying a buffer or advancing a buffer list pointer. This shall be done in this method. For a camera-using application it is mandatory to call capture() just before accessing the image buffer.
Implements firevision::Camera.
Definition at line 80 of file buffer.cpp.
|
virtual |
Close camera.
This closes the camera device. The camera must have been stopped before calling close().
Implements firevision::Camera.
Definition at line 97 of file buffer.cpp.
|
virtual |
Colorspace of returned image.
Implements firevision::Camera.
Definition at line 135 of file buffer.cpp.
|
virtual |
Dispose current buffer.
Some cameras need disposal of the current buffer (for example to free space in a queue to retrieve the next image). This is done with this method. It has to be called after all work has been done on the image as desired. After dispose_buffer() has been called no further access may happen to the image buffer or undesired behavior may happen.
Implements firevision::Camera.
Definition at line 102 of file buffer.cpp.
|
virtual |
Flush image queue.
Some cameras may have an image buffer queue. With this it can happen that if the processing of an image took longer than desired it is needed to flush this buffer queue.
Implements firevision::Camera.
Definition at line 107 of file buffer.cpp.
|
virtual |
Open the camera.
The camera is opened, but image transfer not yet started. This can be used to detect general problems with the camera while delaying the real transfer startup until it is needed.
Implements firevision::Camera.
Definition at line 60 of file buffer.cpp.
|
virtual |
Height of image in pixels.
Implements firevision::Camera.
Definition at line 129 of file buffer.cpp.
|
virtual |
Width of image in pixels.
Implements firevision::Camera.
Definition at line 123 of file buffer.cpp.
|
virtual |
Print out camera information.
Shall print out camera information and current setup information on stdout.
Implements firevision::Camera.
Definition at line 75 of file buffer.cpp.
|
virtual |
Camera is ready for taking pictures.
The camera has been opened and started correctly and may now provide images.
Implements firevision::Camera.
Definition at line 112 of file buffer.cpp.
|
virtual |
Set image number to retrieve.
If a camera is able to retrieve several images this method can be used to select the image to be retrieved with the next call to capture().
n | image number to set |
Implements firevision::Camera.
Definition at line 118 of file buffer.cpp.
|
virtual |
Start image transfer from the camera.
For many cameras opening the camera and starting transmission of images are two tasks. This method will simply initiate the transfer after the camera as been opened. And exception shall be thrown if the camera has not been opened.
Implements firevision::Camera.
Definition at line 65 of file buffer.cpp.
|
virtual |
Stop image transfer from the camera.
This will stop the image transfer initiated with start(). This can be used to start and stop the image transfer at will without opening and closing operations inbetween.
Implements firevision::Camera.
Definition at line 70 of file buffer.cpp.