#include <cams/control/image.h>
Inheritance diagram for firevision::CameraControlImage:
Public Member Functions | |
virtual | ~CameraControlImage () |
Empty virtual destructor. | |
virtual const char * | format () |
Get the image format the camera currently uses. | |
virtual void | set_format (const char *format) |
Set the image format the camera should use. | |
virtual unsigned int | width ()=0 |
Get the current width of the image. | |
virtual unsigned int | height ()=0 |
Get the current height of the image. | |
virtual void | size (unsigned int &width, unsigned int &height) |
Get the current image size. | |
virtual void | set_size (unsigned int width, unsigned int height)=0 |
Set the image size the camera should use. | |
virtual bool | horiz_mirror () |
Return whether the camera image is horizontally mirrored. | |
virtual bool | vert_mirror () |
Return whether the camera image is vertically mirrored. | |
virtual void | mirror (bool &horiz, bool &vert) |
Get information about current camera image mirroring. | |
virtual void | set_horiz_mirror (bool enabled) |
Set whether the camera should mirror images horizontally. | |
virtual void | set_vert_mirror (bool enabled) |
Set whether the camera should mirror images vertically. | |
virtual void | set_mirror (bool horiz, bool vert) |
Set whether the camera should mirror images. | |
virtual unsigned int | fps () |
Get the number of frames per second the camera tries to deliver. | |
virtual void | set_fps (unsigned int fps) |
Set the number of frames per second the camera tries to deliver. | |
virtual unsigned int | lens_x_corr () |
Get current lens x correction. | |
virtual unsigned int | lens_y_corr () |
Get current lens y correction. | |
virtual void | lens_corr (unsigned int &x_corr, unsigned int &y_corr) |
Get current lens correction. | |
virtual void | set_lens_x_corr (unsigned int x_corr) |
Set lens x correction. | |
virtual void | set_lens_y_corr (unsigned int y_corr) |
Set lens y correction. | |
virtual void | set_lens_corr (unsigned int x_corr, unsigned int y_corr) |
Set lens correction. |
Some cameras feature adjustable image controls like size, format or mirroring.
This interface shall be implemented by such cameras.
Tim Niemueller
Definition at line 35 of file image.h.
firevision::CameraControlImage::~CameraControlImage | ( | ) | [virtual] |
const char * firevision::CameraControlImage::format | ( | ) | [virtual] |
Get the image format the camera currently uses.
Check implementation documentation for details on the format.
NotImplementedException | Not implemented by this control |
Reimplemented in firevision::DummyCameraControl, and firevision::V4L2Camera.
unsigned int firevision::CameraControlImage::fps | ( | ) | [virtual] |
Get the number of frames per second the camera tries to deliver.
NotImplementedException | Not implemented by this control |
Reimplemented in firevision::DummyCameraControl, and firevision::V4L2Camera.
unsigned int firevision::CameraControlImage::height | ( | ) | [pure virtual] |
Get the current height of the image.
Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.
Referenced by size().
bool firevision::CameraControlImage::horiz_mirror | ( | ) | [virtual] |
Return whether the camera image is horizontally mirrored.
NotImplementedException | Not implemented by this control |
Reimplemented in firevision::DummyCameraControl, and firevision::V4L2Camera.
Definition at line 107 of file image.cpp.
Referenced by mirror().
void firevision::CameraControlImage::lens_corr | ( | unsigned int & | x_corr, | |
unsigned int & | y_corr | |||
) | [virtual] |
Get current lens correction.
[out] | x_corr | where the current lens x correction will be stored |
[out] | y_corr | where the current lens y correction will be stored |
NotImplementedException | Not implemented by this control |
Reimplemented in firevision::DummyCameraControl.
Definition at line 222 of file image.cpp.
References lens_x_corr(), and lens_y_corr().
unsigned int firevision::CameraControlImage::lens_x_corr | ( | ) | [virtual] |
Get current lens x correction.
NotImplementedException | Not implemented by this control |
Reimplemented in firevision::DummyCameraControl, and firevision::V4L2Camera.
Definition at line 199 of file image.cpp.
Referenced by lens_corr().
unsigned int firevision::CameraControlImage::lens_y_corr | ( | ) | [virtual] |
Get current lens y correction.
NotImplementedException | Not implemented by this control |
Reimplemented in firevision::DummyCameraControl, and firevision::V4L2Camera.
Definition at line 210 of file image.cpp.
Referenced by lens_corr().
void firevision::CameraControlImage::mirror | ( | bool & | horiz, | |
bool & | vert | |||
) | [virtual] |
Get information about current camera image mirroring.
[out] | horiz | upon return contains flag if horizontal mirroring is enabled |
[out] | vert | upon return contains flag if vertical mirroring is enabled |
NotImplementedException | Not implemented by this control |
Reimplemented in firevision::DummyCameraControl.
Definition at line 130 of file image.cpp.
References horiz_mirror(), and vert_mirror().
void firevision::CameraControlImage::set_format | ( | const char * | format | ) | [virtual] |
Set the image format the camera should use.
Check implementation documentation for details on the format.
format | the new image format |
NotImplementedException | Not implemented by this control |
Reimplemented in firevision::DummyCameraControl, and firevision::V4L2Camera.
void firevision::CameraControlImage::set_fps | ( | unsigned int | fps | ) | [virtual] |
Set the number of frames per second the camera tries to deliver.
fps | the new fps |
NotImplementedException | Not implemented by this control |
Reimplemented in firevision::DummyCameraControl, and firevision::V4L2Camera.
void firevision::CameraControlImage::set_horiz_mirror | ( | bool | enabled | ) | [virtual] |
Set whether the camera should mirror images horizontally.
enabled | if true, images should be mirrored horizontally |
NotImplementedException | Not implemented by this control |
Reimplemented in firevision::DummyCameraControl, and firevision::V4L2Camera.
Definition at line 142 of file image.cpp.
Referenced by set_mirror().
void firevision::CameraControlImage::set_lens_corr | ( | unsigned int | x_corr, | |
unsigned int | y_corr | |||
) | [virtual] |
Set lens correction.
x_corr | new lens x correction | |
y_corr | new lens y correction |
NotImplementedException | Not implemented by this control |
Reimplemented in firevision::DummyCameraControl.
Definition at line 257 of file image.cpp.
References set_lens_x_corr(), and set_lens_y_corr().
void firevision::CameraControlImage::set_lens_x_corr | ( | unsigned int | x_corr | ) | [virtual] |
Set lens x correction.
x_corr | new lens x correction |
NotImplementedException | Not implemented by this control |
Reimplemented in firevision::DummyCameraControl, and firevision::V4L2Camera.
Definition at line 234 of file image.cpp.
Referenced by set_lens_corr().
void firevision::CameraControlImage::set_lens_y_corr | ( | unsigned int | y_corr | ) | [virtual] |
Set lens y correction.
y_corr | new lens y correction |
NotImplementedException | Not implemented by this control |
Reimplemented in firevision::DummyCameraControl, and firevision::V4L2Camera.
Definition at line 245 of file image.cpp.
Referenced by set_lens_corr().
void firevision::CameraControlImage::set_mirror | ( | bool | horiz, | |
bool | vert | |||
) | [virtual] |
Set whether the camera should mirror images.
horiz | true to mirror images horizontally, false to disable mirroring | |
vert | true to mirror images vertically, false to disable mirroring |
NotImplementedException | Not implemented by this control |
Reimplemented in firevision::DummyCameraControl.
Definition at line 165 of file image.cpp.
References set_horiz_mirror(), and set_vert_mirror().
void firevision::CameraControlImage::set_size | ( | unsigned int | width, | |
unsigned int | height | |||
) | [pure virtual] |
Set the image size the camera should use.
width | new width of the image | |
height | new height of the image |
Exception | thrown for instance if size setting at run-time is not supported |
Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.
void firevision::CameraControlImage::set_vert_mirror | ( | bool | enabled | ) | [virtual] |
Set whether the camera should mirror images vertically.
enabled | if true, images should be mirrored vertically |
NotImplementedException | Not implemented by this control |
Reimplemented in firevision::DummyCameraControl, and firevision::V4L2Camera.
Definition at line 153 of file image.cpp.
Referenced by set_mirror().
void firevision::CameraControlImage::size | ( | unsigned int & | width, | |
unsigned int & | height | |||
) | [virtual] |
Get the current image size.
[out] | width | upon return contains the width of the image |
[out] | height | upon return contains the height of the image |
Reimplemented in firevision::DummyCameraControl.
Definition at line 96 of file image.cpp.
References height(), and width().
Referenced by firevision::V4L2Camera::buffer_size(), firevision::V4L2Camera::capture(), firevision::V4L2Camera::close(), and firevision::V4L2Camera::V4L2Camera().
bool firevision::CameraControlImage::vert_mirror | ( | ) | [virtual] |
Return whether the camera image is vertically mirrored.
NotImplementedException | Not implemented by this control |
Reimplemented in firevision::DummyCameraControl, and firevision::V4L2Camera.
Definition at line 118 of file image.cpp.
Referenced by mirror().
unsigned int firevision::CameraControlImage::width | ( | ) | [pure virtual] |
Get the current width of the image.
Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.
Referenced by size().