ipa_CameraSensors::AVTPikeCam Class Reference

#include <AVTPikeCam.h>

Inheritance diagram for ipa_CameraSensors::AVTPikeCam:

Classes
class	AVTPikeCamDeleter
Public Member Functions
	AVTPikeCam ()
	Constructor.
unsigned long	Close ()
unsigned long	GetColorImage (cv::Mat *colorImage, bool getLatestFrame)
unsigned long	GetColorImage (char *colorImageData, 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 107 of file AVTPikeCam.h.

Constructor & Destructor Documentation

AVTPikeCam::AVTPikeCam ( )

Constructor.

Definition at line 71 of file AVTPikeCam.cpp.

AVTPikeCam::~AVTPikeCam ( )

Destructor.

Definition at line 89 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 375 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:

	colorImage	The image that has been acquired by the camera.
	getLatestFrame	If 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_Exception

Throws an exception, if camera access failed

Implements ipa_CameraSensors::AbstractColorCamera.

Definition at line 747 of file AVTPikeCam.cpp.

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

Retrieves image data from the color camera.

Parameters:

	colorImageData	An array to be filled with image data
	getLatestFrame	True, 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 584 of file AVTPikeCam.cpp.

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

Function to get properties of the camera sensor.

Parameters:

	propertyID	The ID of the property.
	cameraProperty	The value of the property.

Returns:: Return code.

Implements ipa_CameraSensors::AbstractColorCamera.

Definition at line 440 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:

	directory	Path to the configuration file directory.
	cameraIndex	It 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 106 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:

	filename	The file name and path of the configuration file
	cameraIndex	The 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 3382 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 206 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 771 of file AVTPikeCam.cpp.

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

Saves all parameters on hard disk.

Parameters:

filename

The filename of the storage.

Returns:: Return code.

Implements ipa_CameraSensors::AbstractColorCamera.

Definition at line 366 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 2736 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 868 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 435 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:

filename

Path to the camera initialization xml file.

Returns:: Return code.

Reimplemented from ipa_CameraSensors::AbstractColorCamera.

Definition at line 857 of file AVTPikeCam.cpp.

Member Data Documentation

AVTPikeCam::AVTPikeCamDeleter AVTPikeCam::m_Deleter [static, private]

of the number of cameras from this type

Cleans up stuff that has to done only once independent

Definition at line 130 of file AVTPikeCam.h.

UINT32HL ipa_CameraSensors::AVTPikeCam::m_GUID [private]

GUID (worldwide unique identifier) of the IEEE1395 camera.

Definition at line 128 of file AVTPikeCam.h.

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

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

Definition at line 129 of file AVTPikeCam.h.

bool ipa_CameraSensors::AVTPikeCam::m_operationMode_B [private]

Camera specific parameters.

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

Definition at line 127 of file AVTPikeCam.h.

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

ipa_CameraSensors::AVTPikeCam Class Reference

Classes

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation