CameraControlImage Class Reference

Camera image control interface. More...

#include <cams/control/image.h>

Inheritance diagram for CameraControlImage:

Inheritance graph
[legend]

List of all members.


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.

Detailed Description

Camera image control interface.

Some cameras feature adjustable image controls like size, format or mirroring.

This interface shall be implemented by such cameras.

Author:
Tobias Kellner

Tim Niemueller

Definition at line 30 of file image.h.

Constructor & Destructor Documentation

CameraControlImage::~CameraControlImage (  )  [virtual]

Empty virtual destructor.

Definition at line 57 of file image.cpp.

Member Function Documentation

const char * CameraControlImage::format (  )  [virtual]

Get the image format the camera currently uses.

Check implementation documentation for details on the format.

Returns:
a string describing the image format
Exceptions:
NotImplementedException Not implemented by this control

Reimplemented in DummyCameraControl, and V4L2Camera.

Definition at line 68 of file image.cpp.

unsigned int CameraControlImage::fps (  )  [virtual]

Get the number of frames per second the camera tries to deliver.

Returns:
the current fps
Exceptions:
NotImplementedException Not implemented by this control

Reimplemented in DummyCameraControl, and V4L2Camera.

Definition at line 172 of file image.cpp.

unsigned int CameraControlImage::height (  )  [pure virtual]

Get the current height of the image.

Returns:
height in pixels

Implemented in DummyCameraControl, and V4L2Camera.

Referenced by size().

bool CameraControlImage::horiz_mirror (  )  [virtual]

Return whether the camera image is horizontally mirrored.

Returns:
true if the image is horizontally mirrored
Exceptions:
NotImplementedException Not implemented by this control

Reimplemented in DummyCameraControl, and V4L2Camera.

Definition at line 102 of file image.cpp.

Referenced by mirror().

void CameraControlImage::lens_corr ( unsigned int &  x_corr,
unsigned int &  y_corr 
) [virtual]

Get current lens correction.

Parameters:
[out] x_corr where the current lens x correction will be stored
[out] y_corr where the current lens y correction will be stored
Exceptions:
NotImplementedException Not implemented by this control

Reimplemented in DummyCameraControl.

Definition at line 217 of file image.cpp.

References lens_x_corr(), and lens_y_corr().

unsigned int CameraControlImage::lens_x_corr (  )  [virtual]

Get current lens x correction.

Returns:
current lens x correction
Exceptions:
NotImplementedException Not implemented by this control

Reimplemented in DummyCameraControl, and V4L2Camera.

Definition at line 194 of file image.cpp.

Referenced by lens_corr().

unsigned int CameraControlImage::lens_y_corr (  )  [virtual]

Get current lens y correction.

Returns:
current lens y correction
Exceptions:
NotImplementedException Not implemented by this control

Reimplemented in DummyCameraControl, and V4L2Camera.

Definition at line 205 of file image.cpp.

Referenced by lens_corr().

void CameraControlImage::mirror ( bool &  horiz,
bool &  vert 
) [virtual]

Get information about current camera image mirroring.

Parameters:
[out] horiz upon return contains flag if horizontal mirroring is enabled
[out] vert upon return contains flag if vertical mirroring is enabled
Exceptions:
NotImplementedException Not implemented by this control

Reimplemented in DummyCameraControl.

Definition at line 125 of file image.cpp.

References horiz_mirror(), and vert_mirror().

void CameraControlImage::set_format ( const char *  format  )  [virtual]

Set the image format the camera should use.

Check implementation documentation for details on the format.

Parameters:
format the new image format
Exceptions:
NotImplementedException Not implemented by this control

Reimplemented in DummyCameraControl, and V4L2Camera.

Definition at line 80 of file image.cpp.

void CameraControlImage::set_fps ( unsigned int  fps  )  [virtual]

Set the number of frames per second the camera tries to deliver.

Parameters:
fps the new fps
Exceptions:
NotImplementedException Not implemented by this control

Reimplemented in DummyCameraControl, and V4L2Camera.

Definition at line 183 of file image.cpp.

void CameraControlImage::set_horiz_mirror ( bool  enabled  )  [virtual]

Set whether the camera should mirror images horizontally.

Parameters:
enabled if true, images should be mirrored horizontally
Exceptions:
NotImplementedException Not implemented by this control

Reimplemented in DummyCameraControl, and V4L2Camera.

Definition at line 137 of file image.cpp.

Referenced by set_mirror().

void CameraControlImage::set_lens_corr ( unsigned int  x_corr,
unsigned int  y_corr 
) [virtual]

Set lens correction.

Parameters:
x_corr new lens x correction
y_corr new lens y correction
Exceptions:
NotImplementedException Not implemented by this control

Reimplemented in DummyCameraControl.

Definition at line 252 of file image.cpp.

References set_lens_x_corr(), and set_lens_y_corr().

void CameraControlImage::set_lens_x_corr ( unsigned int  x_corr  )  [virtual]

Set lens x correction.

Parameters:
x_corr new lens x correction
Exceptions:
NotImplementedException Not implemented by this control

Reimplemented in DummyCameraControl, and V4L2Camera.

Definition at line 229 of file image.cpp.

Referenced by set_lens_corr().

void CameraControlImage::set_lens_y_corr ( unsigned int  y_corr  )  [virtual]

Set lens y correction.

Parameters:
y_corr new lens y correction
Exceptions:
NotImplementedException Not implemented by this control

Reimplemented in DummyCameraControl, and V4L2Camera.

Definition at line 240 of file image.cpp.

Referenced by set_lens_corr().

void CameraControlImage::set_mirror ( bool  horiz,
bool  vert 
) [virtual]

Set whether the camera should mirror images.

Parameters:
horiz true to mirror images horizontally, false to disable mirroring
vert true to mirror images vertically, false to disable mirroring
Exceptions:
NotImplementedException Not implemented by this control

Reimplemented in DummyCameraControl.

Definition at line 160 of file image.cpp.

References set_horiz_mirror(), and set_vert_mirror().

void CameraControlImage::set_size ( unsigned int  width,
unsigned int  height 
) [pure virtual]

Set the image size the camera should use.

Parameters:
width new width of the image
height new height of the image
Exceptions:
Exception thrown for instance if size setting at run-time is not supported

Implemented in DummyCameraControl, and V4L2Camera.

void CameraControlImage::set_vert_mirror ( bool  enabled  )  [virtual]

Set whether the camera should mirror images vertically.

Parameters:
enabled if true, images should be mirrored vertically
Exceptions:
NotImplementedException Not implemented by this control

Reimplemented in DummyCameraControl, and V4L2Camera.

Definition at line 148 of file image.cpp.

Referenced by set_mirror().

void CameraControlImage::size ( unsigned int &  width,
unsigned int &  height 
) [virtual]

Get the current image size.

Parameters:
[out] width upon return contains the width of the image
[out] height upon return contains the height of the image

Reimplemented in DummyCameraControl.

Definition at line 91 of file image.cpp.

References height(), and width().

Referenced by V4L2Camera::buffer_size(), V4L2Camera::capture(), V4L2Camera::close(), and V4L2Camera::V4L2Camera().

bool CameraControlImage::vert_mirror (  )  [virtual]

Return whether the camera image is vertically mirrored.

Returns:
true if the image is vertically mirrored
Exceptions:
NotImplementedException Not implemented by this control

Reimplemented in DummyCameraControl, and V4L2Camera.

Definition at line 113 of file image.cpp.

Referenced by mirror().

unsigned int CameraControlImage::width (  )  [pure virtual]

Get the current width of the image.

Returns:
width in pixels

Implemented in DummyCameraControl, and V4L2Camera.

Referenced by size().

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