LeutronCamera Class Reference

Cameras accessed through Leutron framegrabber. More...

#include <cams/leutron.h>

Inheritance diagram for LeutronCamera:

Inheritance graph
[legend]

List of all members.


Public Member Functions

 LeutronCamera ()
 Constructor.
virtual ~LeutronCamera ()
 Destructor.
virtual void open ()
 Open the camera.
virtual void start ()
 Start image transfer from the camera.
virtual void stop ()
 Stop image transfer from the camera.
virtual void close ()
 Close camera.
virtual void flush ()
 Flush image queue.
virtual void capture ()
 Capture an image.
virtual void print_info ()
 Print out camera information.
virtual bool ready ()
 Camera is ready for taking pictures.
virtual unsigned char * buffer ()
 Get access to current image buffer.
virtual unsigned int buffer_size ()
 Size of buffer.
virtual void dispose_buffer ()
 Dispose current buffer.
virtual unsigned int pixel_width ()
 Width of image in pixels.
virtual unsigned int pixel_height ()
 Height of image in pixels.
virtual colorspace_t colorspace ()
 Colorspace of returned image.
virtual void set_image_number (unsigned int n)
 Set image number to retrieve.

Detailed Description

Cameras accessed through Leutron framegrabber.

Definition at line 32 of file leutron.h.

Constructor & Destructor Documentation

LeutronCamera::LeutronCamera (  ) 

Constructor.

Definition at line 41 of file leutron.cpp.

LeutronCamera::~LeutronCamera (  )  [virtual]

Destructor.

Definition at line 53 of file leutron.cpp.

Member Function Documentation

unsigned char * LeutronCamera::buffer (  )  [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.

Returns:
pointer to image buffer

Implements Camera.

Definition at line 226 of file leutron.cpp.

unsigned int LeutronCamera::buffer_size (  )  [virtual]

Size of buffer.

Gets the size in bytes of the buffer returned by buffer().

Returns:
size of buffer in bytes

Implements Camera.

Definition at line 248 of file leutron.cpp.

void LeutronCamera::capture (  )  [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 Camera.

Definition at line 216 of file leutron.cpp.

void LeutronCamera::close (  )  [virtual]

Close camera.

This closes the camera device. The camera must have been stopped before calling close().

Implements Camera.

Definition at line 254 of file leutron.cpp.

colorspace_t LeutronCamera::colorspace (  )  [virtual]

Colorspace of returned image.

Returns:
colorspace of image returned by buffer()

Implements Camera.

Definition at line 293 of file leutron.cpp.

void LeutronCamera::dispose_buffer (  )  [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 Camera.

Definition at line 267 of file leutron.cpp.

void LeutronCamera::flush (  )  [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 Camera.

Definition at line 221 of file leutron.cpp.

void LeutronCamera::open (  )  [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 Camera.

Definition at line 59 of file leutron.cpp.

unsigned int LeutronCamera::pixel_height (  )  [virtual]

Height of image in pixels.

Returns:
height of image in pixels

Implements Camera.

Definition at line 282 of file leutron.cpp.

unsigned int LeutronCamera::pixel_width (  )  [virtual]

Width of image in pixels.

Returns:
width of image in pixels

Implements Camera.

Definition at line 272 of file leutron.cpp.

void LeutronCamera::print_info (  )  [virtual]

Print out camera information.

Shall print out camera information and current setup information on stdout.

Implements Camera.

Definition at line 211 of file leutron.cpp.

bool LeutronCamera::ready (  )  [virtual]

Camera is ready for taking pictures.

The camera has been opened and started correctly and may now provide images.

Returns:
true, if the camera is ready, false otherwise

Implements Camera.

Definition at line 300 of file leutron.cpp.

void LeutronCamera::set_image_number ( unsigned int  n  )  [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().

Parameters:
n image number to set

Implements Camera.

Definition at line 307 of file leutron.cpp.

void LeutronCamera::start (  )  [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 Camera.

Definition at line 193 of file leutron.cpp.

void LeutronCamera::stop (  )  [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 Camera.

Definition at line 205 of file leutron.cpp.

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