FG Camera Library  1.5.0.0 (2023-09-08)
Configure special features

Detailed Description

Functions for configuring camera or sensor specific parameters.

Hardware specific features can be accessed using the generic functions FG_set_special_option() and FG_get_special_option(). The desired feature is specified using a property name. Most properties have an integer value which can be read and written.

The following table describes available properties for the VisionCam XM and VisionSensor PV.

Special features
Platform Property name Description FGCamera.so
VisionCam XM / XM2 TriggerLine Sets the VIB::Multiplexer line to use as trigger source in hardware triggered mode (default: 0). See Using hardware trigger mode for an example. ≥ 1.1.1.0
VisionCam XM InsertImageCounter Enables or disables insertion of a frame / line counter, see Using embedded image, trigger and timestamp counters:
0: disable counter (default)
1: enable counter
This feature requires FPGA firmware ≥ 1.0.0.48
≥ 1.2.4.0
InsertTriggerCounter Enables or disables insertion of a trigger counter, see Using embedded image, trigger and timestamp counters:
0: disable counter (default)
1: enable counter
This feature requires FPGA firmware ≥ 1.0.0.48
InsertTimeStamp Enables or disables insertion of a time stamp, see Using embedded image, trigger and timestamp counters:
0: disable time stamp (default)
1: enable time stamp
This feature requires FPGA firmware ≥ 1.0.0.48
VisionSensor PV/PV2/PV3 StrobeMode Sets the operating mode for the integrated LED and the exposure signal for replacing the physical mode switch. See Controlling the integrated LED and exposure signal output for a description and possible values.
For the VisionSensor PV/PV2, this feature requires PRU firmware ≥ 1.1.0.0.
≥ 1.2.0.0
StrobeOutput Sets the output signal if the strobe mode is configured to copy the sensor exposure signal to a digital output. See also Controlling the integrated LED and exposure signal output.
For the VisionSensor PV/PV2, this feature requires PRU firmware ≥ 1.3.0.0.
0...3: index of digital output signal OUT<i>, default: 0
≥ 1.2.3.0

There are also sensor specific properties:

Functions

UINT32 DLL_FG_API FG_get_special_option (const char *option, INT64 *result)
 Returns a special camera property value. More...
 
UINT32 DLL_FG_API FG_set_special_option (const char *option, INT64 arg)
 Configures a special camera property. More...
 

Function Documentation

◆ FG_get_special_option()

UINT32 FG_get_special_option ( const char *  option,
INT64 *  result 
)

Returns a special camera property value.

Parameters
optionProperty name
resultPointer for stroring the property value
Returns
FG_ERROR_CODE_NoError (0) for success, other values indicate an error (see eFG_ERROR_CODE)

◆ FG_set_special_option()

UINT32 FG_set_special_option ( const char *  option,
INT64  arg 
)

Configures a special camera property.

Parameters
optionProperty name
argProperty value
Returns
FG_ERROR_CODE_NoError (0) for success, other values indicate an error (see eFG_ERROR_CODE)
Example:
The following example configures the VisionCam XM to use the Multiplexer output 2 as trigger signal.
FG_TRIGGER_MODE_HARDWARE
@ FG_TRIGGER_MODE_HARDWARE
Hardware triggered mode.
Definition: FG_CameraInterface.h:142
FG_install_camera
UINT32 DLL_FG_API FG_install_camera(enum eFG_CAMERA_TYPE camera_type)
Opens and initializes the camera.
Definition: FG_CameraInterface.cpp:282
FG_CAMERA_TYPE_X_X_IMAGO_Vxx_AUTO
@ FG_CAMERA_TYPE_X_X_IMAGO_Vxx_AUTO
IMAGO VisionCam/Sensor (automatic)
Definition: FG_CameraInterface.h:54
FG_set_special_option
UINT32 DLL_FG_API FG_set_special_option(const char *option, INT64 arg)
Configures a special camera property.
Definition: FG_CameraInterface.cpp:893
FG_set_trigger_mode
UINT32 DLL_FG_API FG_set_trigger_mode(enum eFG_TRIGGER_MODE trigger_mode)
Sets the trigger mode.
Definition: FG_CameraInterface.cpp:770