WURDECamera Class Reference

Inheritance diagram for WURDECamera:

WURDE1394Camera WURDEPlaybackCamera List of all members.

Detailed Description

This class wraps up the libdc1394 camera library to give DMA frame capturing from firewire (1394 video compliant) cameras.

While getting and setting of most 1394 features can be done, capturing is only supported in the modes our cameras can handle. Note that our cameras do not have many of the features listed with get/set functions!

Todo:
Finish up the colorspace conversion functions
Todo:
Determine if m_speed and m_captureSpeed are really the same things

Definition at line 113 of file WURDECam.H.

Public Member Functions

 WURDECamera (std::string name, std::map< std::string, std::string > options)
virtual ~WURDECamera ()
virtual bool init ()=0
virtual bool startCapture ()=0
virtual void stopCapture ()=0
std::string getName ()
void setName (std::string value)
bool haveCam ()
virtual WURDE::WURDEImage captureYUV24 ()
 Return the timestamp of the current frame.
virtual WURDE::WURDEImage captureYUV422 ()
virtual WURDE::WURDEImage captureGray ()
virtual WURDE::WURDEImage captureRGB ()
virtual void resetFrame ()=0
 Releases the DMA buffer for the current frame, and resets all the boolean values indicating that we have a current frame.
virtual void setFramerate (const WURDEVisionFramerate &value)
virtual void setMode (const WURDEVisionMode &value)
virtual void setSpeed (WURDEVisionSpeed value)
 setSpeed can only be used before the capture is started.
virtual float getFramerate () const
virtual WURDEVisionMode getMode () const
virtual WURDEVisionSpeed getSpeed () const
virtual unsigned int getBrightness () const
 Set defaults of "unsupported" for each of these functions.
virtual unsigned int getExposure () const
virtual unsigned int getSharpness () const
virtual unsigned int getHue () const
virtual unsigned int getSaturation () const
virtual unsigned int getGamma () const
virtual unsigned int getShutter () const
virtual unsigned int getGain () const
virtual unsigned int getIris () const
virtual unsigned int getFocus () const
virtual unsigned int getZoom () const
virtual unsigned int getTriggerDelay () const
virtual unsigned int getPan () const
virtual unsigned int getTilt () const
virtual unsigned int getOpticalFilter () const
virtual bool setBrightness (const unsigned int &value)
virtual bool setExposure (const unsigned int &value)
virtual bool setSharpness (const unsigned int &value)
virtual bool setHue (const unsigned int &value)
virtual bool setSaturation (const unsigned int &value)
virtual bool setGamma (const unsigned int &value)
virtual bool setShutter (const unsigned int &value)
virtual bool setGain (const unsigned int &value)
virtual bool setIris (const unsigned int &value)
virtual bool setAutoIris (const bool &value)
virtual bool setFocus (const unsigned int &value)
virtual bool setTriggerMode (const unsigned int &value)
virtual bool setZoom (const unsigned int &value)
virtual bool setTriggerDelay (const unsigned int &value)
virtual bool setPan (const unsigned int &value)
virtual bool setTilt (const unsigned int &value)
virtual bool setOpticalFilter (const unsigned int &value)
virtual void setCalibration (Calibration val)
virtual Calibration getCalibration () const

Protected Attributes

std::string m_name
std::map< std::string, std::string > m_options
WURDEVisionFramerate m_framerate
WURDEVisionMode m_mode
WURDEVisionSpeed m_speed
bool m_haveCam
bool m_haveFrame
bool m_init
Calibration m_calib


Constructor & Destructor Documentation

WURDECamera ( std::string  name,
std::map< std::string, std::string >  options 
) [inline]

Definition at line 115 of file WURDECam.H.

References WURDECamera::m_name, and WURDECamera::m_options.

virtual ~WURDECamera (  )  [inline, virtual]

Definition at line 116 of file WURDECam.H.


Member Function Documentation

virtual bool init (  )  [pure virtual]

Implemented in WURDEPlaybackCamera, and WURDE1394Camera.

virtual bool startCapture (  )  [pure virtual]

Implemented in WURDEPlaybackCamera, and WURDE1394Camera.

Referenced by WURDEVision::loadCameras().

virtual void stopCapture (  )  [pure virtual]

Implemented in WURDEPlaybackCamera, and WURDE1394Camera.

std::string getName (  )  [inline]

Reimplemented in WURDE1394Camera.

Definition at line 121 of file WURDECam.H.

References WURDECamera::m_name.

void setName ( std::string  value  )  [inline]

Reimplemented in WURDE1394Camera.

Definition at line 122 of file WURDECam.H.

References WURDECamera::m_name.

bool haveCam (  )  [inline]

Definition at line 123 of file WURDECam.H.

References WURDECamera::m_haveCam.

virtual WURDE::WURDEImage captureYUV24 (  )  [inline, virtual]

Return the timestamp of the current frame.

Reimplemented in WURDE1394Camera.

Definition at line 129 of file WURDECam.H.

References WURDEVision::ERROR_UNSUPPORTED_IMAGE_TYPE, WURDE::g_logerror, WURDEVision::g_wurdeCamErrno, and WURDECamera::m_name.

virtual WURDE::WURDEImage captureYUV422 (  )  [inline, virtual]

Reimplemented in WURDE1394Camera.

Definition at line 130 of file WURDECam.H.

References WURDEVision::ERROR_UNSUPPORTED_IMAGE_TYPE, WURDE::g_logerror, WURDEVision::g_wurdeCamErrno, and WURDECamera::m_name.

virtual WURDE::WURDEImage captureGray (  )  [inline, virtual]

Reimplemented in WURDE1394Camera.

Definition at line 131 of file WURDECam.H.

References WURDEVision::ERROR_UNSUPPORTED_IMAGE_TYPE, WURDE::g_logerror, WURDEVision::g_wurdeCamErrno, and WURDECamera::m_name.

virtual WURDE::WURDEImage captureRGB (  )  [inline, virtual]

Reimplemented in WURDEPlaybackCamera, and WURDE1394Camera.

Definition at line 132 of file WURDECam.H.

References WURDEVision::ERROR_UNSUPPORTED_IMAGE_TYPE, WURDE::g_logerror, WURDEVision::g_wurdeCamErrno, and WURDECamera::m_name.

virtual void resetFrame (  )  [pure virtual]

Releases the DMA buffer for the current frame, and resets all the boolean values indicating that we have a current frame.

Implemented in WURDEPlaybackCamera, and WURDE1394Camera.

virtual void setFramerate ( const WURDEVisionFramerate value  )  [inline, virtual]

Definition at line 143 of file WURDECam.H.

References WURDECamera::m_framerate.

virtual void setMode ( const WURDEVisionMode value  )  [inline, virtual]

Definition at line 148 of file WURDECam.H.

References WURDECamera::m_mode.

virtual void setSpeed ( WURDEVisionSpeed  value  )  [inline, virtual]

setSpeed can only be used before the capture is started.

this will likely be meaningless for some cameras.

Definition at line 154 of file WURDECam.H.

References WURDECamera::m_speed.

virtual float getFramerate (  )  const [inline, virtual]

Definition at line 156 of file WURDECam.H.

References WURDECamera::m_framerate.

virtual WURDEVisionMode getMode (  )  const [inline, virtual]

Definition at line 157 of file WURDECam.H.

References WURDECamera::m_mode.

virtual WURDEVisionSpeed getSpeed (  )  const [inline, virtual]

Definition at line 159 of file WURDECam.H.

References WURDECamera::m_speed.

virtual unsigned int getBrightness (  )  const [inline, virtual]

Set defaults of "unsupported" for each of these functions.

To use them, they must be overridden by the derived class.

Definition at line 166 of file WURDECam.H.

References WURDE::g_logwarn.

virtual unsigned int getExposure (  )  const [inline, virtual]

Definition at line 167 of file WURDECam.H.

References WURDE::g_logwarn.

virtual unsigned int getSharpness (  )  const [inline, virtual]

Definition at line 168 of file WURDECam.H.

References WURDE::g_logwarn.

virtual unsigned int getHue (  )  const [inline, virtual]

Definition at line 169 of file WURDECam.H.

References WURDE::g_logwarn.

virtual unsigned int getSaturation (  )  const [inline, virtual]

Definition at line 170 of file WURDECam.H.

References WURDE::g_logwarn.

virtual unsigned int getGamma (  )  const [inline, virtual]

Definition at line 171 of file WURDECam.H.

References WURDE::g_logwarn.

virtual unsigned int getShutter (  )  const [inline, virtual]

Definition at line 172 of file WURDECam.H.

References WURDE::g_logwarn.

virtual unsigned int getGain (  )  const [inline, virtual]

Definition at line 173 of file WURDECam.H.

References WURDE::g_logwarn.

virtual unsigned int getIris (  )  const [inline, virtual]

Definition at line 174 of file WURDECam.H.

References WURDE::g_logwarn.

virtual unsigned int getFocus (  )  const [inline, virtual]

Definition at line 175 of file WURDECam.H.

References WURDE::g_logwarn.

virtual unsigned int getZoom (  )  const [inline, virtual]

Definition at line 176 of file WURDECam.H.

References WURDE::g_logwarn.

virtual unsigned int getTriggerDelay (  )  const [inline, virtual]

Definition at line 177 of file WURDECam.H.

References WURDE::g_logwarn.

virtual unsigned int getPan (  )  const [inline, virtual]

Definition at line 178 of file WURDECam.H.

References WURDE::g_logwarn.

virtual unsigned int getTilt (  )  const [inline, virtual]

Definition at line 179 of file WURDECam.H.

References WURDE::g_logwarn.

virtual unsigned int getOpticalFilter (  )  const [inline, virtual]

Definition at line 180 of file WURDECam.H.

References WURDE::g_logwarn.

virtual bool setBrightness ( const unsigned int &  value  )  [inline, virtual]

Definition at line 182 of file WURDECam.H.

References WURDE::g_logwarn.

virtual bool setExposure ( const unsigned int &  value  )  [inline, virtual]

Definition at line 183 of file WURDECam.H.

References WURDE::g_logwarn.

virtual bool setSharpness ( const unsigned int &  value  )  [inline, virtual]

Definition at line 184 of file WURDECam.H.

References WURDE::g_logwarn.

virtual bool setHue ( const unsigned int &  value  )  [inline, virtual]

Definition at line 185 of file WURDECam.H.

References WURDE::g_logwarn.

virtual bool setSaturation ( const unsigned int &  value  )  [inline, virtual]

Definition at line 186 of file WURDECam.H.

References WURDE::g_logwarn.

virtual bool setGamma ( const unsigned int &  value  )  [inline, virtual]

Definition at line 187 of file WURDECam.H.

References WURDE::g_logwarn.

virtual bool setShutter ( const unsigned int &  value  )  [inline, virtual]

Definition at line 188 of file WURDECam.H.

References WURDE::g_logwarn.

virtual bool setGain ( const unsigned int &  value  )  [inline, virtual]

Definition at line 189 of file WURDECam.H.

References WURDE::g_logwarn.

virtual bool setIris ( const unsigned int &  value  )  [inline, virtual]

Definition at line 190 of file WURDECam.H.

References WURDE::g_logwarn.

virtual bool setAutoIris ( const bool &  value  )  [inline, virtual]

Definition at line 191 of file WURDECam.H.

References WURDE::g_logwarn.

virtual bool setFocus ( const unsigned int &  value  )  [inline, virtual]

Definition at line 192 of file WURDECam.H.

References WURDE::g_logwarn.

virtual bool setTriggerMode ( const unsigned int &  value  )  [inline, virtual]

Definition at line 193 of file WURDECam.H.

References WURDE::g_logwarn.

virtual bool setZoom ( const unsigned int &  value  )  [inline, virtual]

Definition at line 194 of file WURDECam.H.

References WURDE::g_logwarn.

virtual bool setTriggerDelay ( const unsigned int &  value  )  [inline, virtual]

Definition at line 195 of file WURDECam.H.

References WURDE::g_logwarn.

virtual bool setPan ( const unsigned int &  value  )  [inline, virtual]

Definition at line 196 of file WURDECam.H.

References WURDE::g_logwarn.

virtual bool setTilt ( const unsigned int &  value  )  [inline, virtual]

Definition at line 197 of file WURDECam.H.

References WURDE::g_logwarn.

virtual bool setOpticalFilter ( const unsigned int &  value  )  [inline, virtual]

Definition at line 198 of file WURDECam.H.

References WURDE::g_logwarn.

virtual void setCalibration ( Calibration  val  )  [inline, virtual]

Reimplemented in WURDE1394Camera.

Definition at line 200 of file WURDECam.H.

References WURDECamera::m_calib, and val.

virtual Calibration getCalibration (  )  const [inline, virtual]

Definition at line 201 of file WURDECam.H.

References WURDECamera::m_calib.


Member Data Documentation

std::string m_name [protected]

Definition at line 204 of file WURDECam.H.

Referenced by WURDECamera::captureGray(), WURDECamera::captureRGB(), WURDECamera::captureYUV24(), WURDECamera::captureYUV422(), WURDECamera::getName(), WURDE1394Camera::getName(), WURDECamera::setName(), WURDE1394Camera::setName(), WURDE1394Camera::startCapture(), WURDE1394Camera::WURDE1394Camera(), and WURDECamera::WURDECamera().

std::map<std::string,std::string> m_options [protected]

Definition at line 205 of file WURDECam.H.

Referenced by WURDE1394Camera::init(), WURDEPlaybackCamera::init(), WURDE1394Camera::WURDE1394Camera(), and WURDECamera::WURDECamera().

WURDEVisionFramerate m_framerate [protected]

Reimplemented in WURDE1394Camera.

Definition at line 207 of file WURDECam.H.

Referenced by WURDECamera::getFramerate(), and WURDECamera::setFramerate().

WURDEVisionMode m_mode [protected]

Reimplemented in WURDE1394Camera.

Definition at line 208 of file WURDECam.H.

Referenced by WURDECamera::getMode(), and WURDECamera::setMode().

WURDEVisionSpeed m_speed [protected]

Reimplemented in WURDE1394Camera.

Definition at line 209 of file WURDECam.H.

Referenced by WURDECamera::getSpeed(), and WURDECamera::setSpeed().

bool m_haveCam [protected]

Definition at line 211 of file WURDECam.H.

Referenced by WURDECamera::haveCam(), and WURDE1394Camera::WURDE1394Camera().

bool m_haveFrame [protected]

Definition at line 212 of file WURDECam.H.

Referenced by WURDE1394Camera::captureGray(), WURDE1394Camera::captureRGB(), WURDE1394Camera::captureYUV24(), WURDE1394Camera::captureYUV422(), and WURDE1394Camera::resetFrame().

bool m_init [protected]

Definition at line 213 of file WURDECam.H.

Referenced by WURDE1394Camera::init(), WURDEPlaybackCamera::init(), WURDE1394Camera::WURDE1394Camera(), and WURDEPlaybackCamera::WURDEPlaybackCamera().

Calibration m_calib [protected]

Definition at line 215 of file WURDECam.H.

Referenced by WURDECamera::getCalibration(), WURDE1394Camera::getCalibration(), WURDECamera::setCalibration(), and WURDE1394Camera::setCalibration().


The documentation for this class was generated from the following file:
Generated on Thu Feb 1 15:31:56 2007 for WURDE by  doxygen 1.5.1