Fawkes API  Fawkes Development Version
firevision::PikeCamera Class Reference

Pike camera. More...

#include <>>

Inheritance diagram for firevision::PikeCamera:

Public Member Functions

 PikeCamera (const CameraArgumentParser *cap)
 Constructor. More...
 
virtual ~PikeCamera ()
 Destructor. More...
 
virtual void open ()
 Open the camera. More...
 
virtual void print_info ()
 Print out camera information. More...
 
virtual bool set_autofunction_aoi (unsigned int left, unsigned int top, unsigned int width, unsigned int height, bool show_work_area=false)
 Set the area of interest (AOI) for the auto functions. More...
 
virtual void parse_set_autofnc_aoi (const char *aoi)
 Parse the autofnc_aoi parameter in the camera argument string. More...
 
- Public Member Functions inherited from firevision::FirewireCamera
 FirewireCamera (dc1394framerate_t framerate=DC1394_FRAMERATE_30, dc1394video_mode_t mode=DC1394_VIDEO_MODE_640x480_YUV422, dc1394speed_t speed=DC1394_ISO_SPEED_400, int num_buffers=8)
 Constructor. More...
 
 FirewireCamera (const CameraArgumentParser *cap)
 Constructor. More...
 
virtual ~FirewireCamera ()
 Empty destructor. More...
 
virtual void open_device ()
 Open the desired device. 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 flush ()
 Flush image queue. More...
 
virtual void capture ()
 Capture an image. More...
 
virtual bool ready ()
 Camera is ready for taking pictures. 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...
 
bool iso_mode_enabled ()
 Check if ISO mode is enabled. More...
 
virtual bool auto_focus ()
 Check if auto focus is enabled. More...
 
virtual void set_auto_focus (bool enabled)
 Enable or disable auto focus. More...
 
virtual unsigned int focus ()
 Get current focus value. More...
 
virtual void set_focus (unsigned int focus)
 Set new focus value. More...
 
virtual unsigned int focus_min ()
 Get minimum focus value. More...
 
virtual unsigned int focus_max ()
 Get maximum focus value. More...
 
virtual bool auto_shutter ()
 Get status of auto shutter. More...
 
virtual void set_auto_shutter (bool enabled)
 Set status of auto shutter. More...
 
virtual unsigned int shutter ()
 Get shutter value. More...
 
virtual void set_shutter (unsigned int shutter)
 Set shutter value. More...
 
virtual bool auto_white_balance ()
 Get status of auto white balance. More...
 
virtual void set_auto_white_balance (bool enabled)
 Set status of auto white balance. More...
 
virtual void white_balance (unsigned int *ub, unsigned int *vr)
 Get white balance values. More...
 
virtual void set_white_balance (unsigned int ub, unsigned int vr)
 Set white balance values. More...
 
virtual void set_gain (unsigned int gain)
 Set the gain. More...
 
virtual void parse_set_focus (const char *focus)
 Parse focus and set value. More...
 
virtual void parse_set_white_balance (const char *white_balance)
 Parse white balance and set value. More...
 
virtual void parse_set_shutter (const char *shutter)
 Parse shutter and set value. More...
 
virtual uint64_t guid () const
 Get Firewire GUID of camera. More...
 
virtual const char * model () const
 Get camera model. More...
 
dc1394_t * cobj () const
 Get underlying libdc1394 C handle. More...
 
dc1394camera_t * camera_cobj () const
 Get underlying libdc1394 camera C handle. More...
 
- Public Member Functions inherited from firevision::Camera
virtual ~Camera ()
 Virtual empty destructor. More...
 
virtual fawkes::Timecapture_time ()
 Get the Time of the last successfully captured image. More...
 
- Public Member Functions inherited from firevision::CameraControlFocus
virtual ~CameraControlFocus ()
 Empty virtual destructor. More...
 
- Public Member Functions inherited from firevision::CameraControl
virtual ~CameraControl ()
 Virtual empty destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from firevision::FirewireCamera
static void print_available_fwcams ()
 Print list of cameras. More...
 
- Protected Attributes inherited from firevision::FirewireCamera
int _num_buffers
 Number of DMA buffers. More...
 
bool _device_opened
 true if device has been opened, false otherwise More...
 
bool _opened
 true if camera has been opened, false otherwise More...
 
bool _started
 true if camera has been started, false otherwise More...
 
bool _auto_focus
 true if auto focus is enabled, false if disabled More...
 
bool _auto_shutter
 true if auto shutter is enabled, false if disabled More...
 
bool _auto_white_balance
 true if auto white balance is enabled, false if disabled More...
 
bool _valid_frame_received
 true, if a valid frame has been received, false otherwise More...
 
bool _do_set_shutter
 true if the shutter should actually be set, false otherwise More...
 
bool _do_set_white_balance
 true if the white balance should actually be set, false otherwise More...
 
bool _do_set_focus
 true if the focus should actually be set, false otherwise More...
 
dc1394_t * _dc1394
 DC1394 main context. More...
 
dc1394video_mode_t _mode
 DC1394 video mode. More...
 
bool _format7_mode_enabled
 Indicator of Format7 status. More...
 
dc1394speed_t _speed
 DC1394 speed. More...
 
dc1394framerate_t _framerate
 DC1394 framerate. More...
 
dc1394camera_t * _camera
 DC1394 camera handle. More...
 
dc1394video_frame_t * _frame
 Last captured DC1394 video frame. More...
 
dc1394color_coding_t _format7_coding
 Format7 color coding. More...
 
int _format7_bpp
 Format7 bytes per packet. More...
 
int _format7_width
 Format7 width. More...
 
int _format7_height
 Format7 height. More...
 
int _format7_startx
 Format7 ROI Start X coordinate. More...
 
int _format7_starty
 Format7 ROI Start Y coordinate. More...
 
unsigned int _white_balance_ub
 White balance U/B value. More...
 
unsigned int _white_balance_vr
 White balance V/R value. More...
 
unsigned int _shutter
 Shutter value. More...
 
unsigned int _focus
 Focus value. More...
 
unsigned int _gain
 Gain value. More...
 
bool _auto_gain
 True, if gain is set automatically. More...
 
char * _model
 Camera model, used in open to identify the camera, if empty first found camera is used. More...
 

Detailed Description

Pike camera.

Allows to access some special features of the Pike camera made by Allied Vision Technologies.

Definition at line 34 of file pike.h.

Constructor & Destructor Documentation

◆ PikeCamera()

firevision::PikeCamera::PikeCamera ( const CameraArgumentParser cap)

Constructor.

Parameters
capCamera argument parser.

Definition at line 112 of file pike.cpp.

References firevision::CameraArgumentParser::get(), firevision::CameraArgumentParser::has(), and parse_set_autofnc_aoi().

◆ ~PikeCamera()

firevision::PikeCamera::~PikeCamera ( )
virtual

Destructor.

Definition at line 131 of file pike.cpp.

Member Function Documentation

◆ open()

void firevision::PikeCamera::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.

Reimplemented from firevision::FirewireCamera.

Definition at line 136 of file pike.cpp.

References firevision::FirewireCamera::_opened, firevision::FirewireCamera::open(), and set_autofunction_aoi().

◆ parse_set_autofnc_aoi()

void firevision::PikeCamera::parse_set_autofnc_aoi ( const char *  aoi)
virtual

Parse the autofnc_aoi parameter in the camera argument string.

The format ist <left>x<top>+<width>x<height>-<show>. "-\<show\>" is optional.

Parameters
aoithe parameter string of the autofnc_aoi parameter

Definition at line 275 of file pike.cpp.

Referenced by PikeCamera().

◆ print_info()

void firevision::PikeCamera::print_info ( )
virtual

Print out camera information.

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

Reimplemented from firevision::FirewireCamera.

Definition at line 155 of file pike.cpp.

References firevision::FirewireCamera::_camera, and firevision::FirewireCamera::print_info().

◆ set_autofunction_aoi()

bool firevision::PikeCamera::set_autofunction_aoi ( unsigned int  left,
unsigned int  top,
unsigned int  width,
unsigned int  height,
bool  show_work_area = false 
)
virtual

Set the area of interest (AOI) for the auto functions.

Parameters
leftoffset form the left image border
topoffset form the top image border
widthwidth of the AOI
heightheight of the AOI
show_work_areahighlight the work area in the image
Returns
true on success, false otherwise

Definition at line 197 of file pike.cpp.

References firevision::FirewireCamera::_camera, firevision::FirewireCamera::_opened, firevision::avt_af_area_size_t::height, firevision::avt_af_area_position_t::left, firevision::avt_autofnc_aoi_t::on_off, firevision::avt_autofnc_aoi_t::show_work_area, firevision::avt_af_area_position_t::top, and firevision::avt_af_area_size_t::width.

Referenced by open().


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