Classes | Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes
ipa_CameraSensors::AVTPikeCam Class Reference

#include <AVTPikeCam.h>

Inheritance diagram for ipa_CameraSensors::AVTPikeCam:
Inheritance graph
[legend]

List of all members.

Classes

class  AVTPikeCamDeleter

Public Member Functions

 AVTPikeCam ()
 Constructor.
unsigned long Close ()
unsigned long GetColorImage (char *colorImageData, bool getLatestFrame)
unsigned long GetColorImage (cv::Mat *colorImage, bool getLatestFrame)
unsigned long GetProperty (t_cameraProperty *cameraProperty)
unsigned long Init (std::string directory, int cameraIndex=0)
unsigned long Open ()
unsigned long PrintCameraInformation ()
unsigned long SaveParameters (const char *filename)
unsigned long SetProperty (t_cameraProperty *cameraProperty)
unsigned long SetPropertyDefaults ()
unsigned long TestCamera (const char *filename)
 ~AVTPikeCam ()
 Destructor.

Private Member Functions

unsigned long LoadParameters (const char *filename, int cameraIndex)
unsigned long SetParameters ()

Private Attributes

UINT32HL m_GUID
 GUID (worldwide unique identifier) of the IEEE1395 camera.
bool m_operationMode_B
 Camera specific parameters.

Static Private Attributes

static AVTPikeCamDeleter m_Deleter
 of the number of cameras from this type
static bool m_OpenExecuted = false
 Trigger takes care, that AVT library is opend only once.

Detailed Description

Interface developed for AVT PIKE 145C camera. Interface should also fit to other IEEE 1394 cameras.

Definition at line 109 of file AVTPikeCam.h.


Constructor & Destructor Documentation

Constructor.

Definition at line 76 of file AVTPikeCam.cpp.

Destructor.

Definition at line 94 of file AVTPikeCam.cpp.


Member Function Documentation

unsigned long AVTPikeCam::Close ( ) [virtual]

Close camera device.

Returns:
Return code.

Implements ipa_CameraSensors::AbstractColorCamera.

Definition at line 380 of file AVTPikeCam.cpp.

unsigned long AVTPikeCam::GetColorImage ( char *  colorImageData,
bool  getLatestFrame 
)

Retrieves image data from the color camera.

Parameters:
colorImageDataAn array to be filled with image data
getLatestFrameTrue, when the latest picture has to be returned. Otherwise, the next picture following the last call to getLatestFrame is returned.
Returns:
Return code

Reimplemented from ipa_CameraSensors::AbstractColorCamera.

Definition at line 589 of file AVTPikeCam.cpp.

unsigned long AVTPikeCam::GetColorImage ( cv::Mat *  colorImage,
bool  getLatestFrame 
) [virtual]

Retrieves an image from the camera. cv::Mat object is initialized on demand.

Parameters:
colorImageThe image that has been acquired by the camera.
getLatestFrameIf true, the camera acquires a new frame and returns it. Otherwise, the next frame following the last returned frame is returned from the internal camera buffer.
Exceptions:
IPA_ExceptionThrows an exception, if camera access failed

Implements ipa_CameraSensors::AbstractColorCamera.

Definition at line 752 of file AVTPikeCam.cpp.

unsigned long AVTPikeCam::GetProperty ( t_cameraProperty *  cameraProperty) [virtual]

Function to get properties of the camera sensor.

Parameters:
propertyIDThe ID of the property.
cameraPropertyThe value of the property.
Returns:
Return code.

Implements ipa_CameraSensors::AbstractColorCamera.

Definition at line 445 of file AVTPikeCam.cpp.

unsigned long AVTPikeCam::Init ( std::string  directory,
int  cameraIndex = 0 
) [virtual]

Initializes the color camera. Camera specific constants may be set within the configuration file cameraSensorsIni.xml. The function has to set the member variable m_initialized.

Parameters:
directoryPath to the configuration file directory.
cameraIndexIt is possible to have several cameras of the same type on the system. One may us the camera index to apply different configuration files to each of them
Returns:
Return code.

< Error code variable

Implements ipa_CameraSensors::AbstractColorCamera.

Definition at line 111 of file AVTPikeCam.cpp.

unsigned long AVTPikeCam::LoadParameters ( const char *  filename,
int  cameraIndex 
) [private, virtual]

Parses the XML configuration file, that holds the camera settings

Parameters:
filenameThe file name and path of the configuration file
cameraIndexThe index of the camera within the configuration file i.e. AVT_PIKE_CAM_0 or AVT_PIKE_CAM_1
Returns:
Return value

Implements ipa_CameraSensors::AbstractColorCamera.

Definition at line 3387 of file AVTPikeCam.cpp.

unsigned long AVTPikeCam::Open ( ) [virtual]

Opens the camera device. All camera specific parameters for opening the camera should have been set within the Init function.

Returns:
Return code.

Implements ipa_CameraSensors::AbstractColorCamera.

Definition at line 211 of file AVTPikeCam.cpp.

unsigned long AVTPikeCam::PrintCameraInformation ( ) [virtual]

Shows the camera's parameters information. Shows actual value, max and min value and auto mode for each parameter

Implements ipa_CameraSensors::AbstractColorCamera.

Definition at line 776 of file AVTPikeCam.cpp.

unsigned long AVTPikeCam::SaveParameters ( const char *  filename) [virtual]

Saves all parameters on hard disk.

Parameters:
filenameThe filename of the storage.
Returns:
Return code.

Implements ipa_CameraSensors::AbstractColorCamera.

Definition at line 371 of file AVTPikeCam.cpp.

unsigned long AVTPikeCam::SetParameters ( ) [private, virtual]

Parses the data extracted by LoadParameters and calls the corresponding SetProperty functions.

Returns:
Return code

Implements ipa_CameraSensors::AbstractColorCamera.

Definition at line 2741 of file AVTPikeCam.cpp.

unsigned long AVTPikeCam::SetProperty ( t_cameraProperty *  cameraProperty) [virtual]

Sets the camera properties. The following parameters are admitted: ol> PROP_BRIGHTNESS: 0..1023 PROP_SHUTTER: 0..4095, VALUE_AUTO PROP_AUTO_EXPOSURE: 50..205 PROP_WHITE_BALANCE_U: 0..568, VALUE_AUTO PROP_WHITE_BALANCE_V: 0..568, VALUE_AUTO PROP_HUE: 0..80 PROP_SATURATION: 0..511 PROP_GAMMA: 0..2 PROP_GAIN: 0..680 PROP_FRAME_RATE: 0..60 PROP_FW_OPERATION_MODE: A / B /ol>

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

====================================================================

Implements ipa_CameraSensors::AbstractColorCamera.

Definition at line 873 of file AVTPikeCam.cpp.

unsigned long AVTPikeCam::SetPropertyDefaults ( ) [virtual]

Function to set property defaults of the camera sensor.

Returns:
Return code.

Implements ipa_CameraSensors::AbstractColorCamera.

Definition at line 440 of file AVTPikeCam.cpp.

unsigned long AVTPikeCam::TestCamera ( const char *  filename) [virtual]

Unit Test for the camera interface. Tests each of the single interface functions and displays the output on standard out.

Parameters:
filenamePath to the camera initialization xml file.
Returns:
Return code.

Reimplemented from ipa_CameraSensors::AbstractColorCamera.

Definition at line 862 of file AVTPikeCam.cpp.


Member Data Documentation

of the number of cameras from this type

Cleans up stuff that has to done only once independent

Definition at line 132 of file AVTPikeCam.h.

GUID (worldwide unique identifier) of the IEEE1395 camera.

Definition at line 130 of file AVTPikeCam.h.

bool AVTPikeCam::m_OpenExecuted = false [static, private]

Trigger takes care, that AVT library is opend only once.

Definition at line 131 of file AVTPikeCam.h.

Camera specific parameters.

FireWire A (400Mbit/s) or FireWire B (800Mbit/s).

Definition at line 129 of file AVTPikeCam.h.


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


cob_camera_sensors
Author(s): Jan Fischer
autogenerated on Sun Oct 5 2014 23:07:55