The interface checks if the application 'halcon_application' exists on the camera. Otherwise it will be created and set as active application. If this application already exists, it is checked if it is active and if necessary, it will be activated. The timeout for connecting with the camera can be set by a generic parameter.

Read the camera manual for further details of the parameters.

There may exist additional read-only parameters with the following postfixes:

• '_description': These parameters provide the tool-tip of the corresponding parameter as a string.
• '_range': These parameters provide the minimum, maximum, step width, and default values for the corresponding integer or float parameter as a tuple with 4 elements, e.g., get_framegrabber_param(.., 'Shutter_range', ..) will return the output tuple [min, max, step, default].
• '_values': These parameters provide the valid value list for the corresponding parameter as a tuple, e.g., get_framegrabber_param(.., 'volatile_values', ..) will return the output tuple ['enable', 'disable'].

All these postfixed parameter names are not returned when calling info_framegrabber(.., 'parameters', ..) and are used to enable the easy parameterization via a generic graphical user interface, particularly the HDevelop Image Acquisition Assistant.

Not supported by this interface.

Not supported by this interface.

Not supported by this interface.

Not supported by this interface.

Starts a new asynchronous grab. See also grab_image_start. If a synchronous grab changed the trigger mode this setting is reverted. In case that the trigger mode is set to 'process_interface' grab_image_start sends a software trigger in order to start an asynchronous grab. However, if a software trigger is send via set_framegrabber_param the image captured with this trigger will be returned by the next asynchronous grab.

grab_image starts a new synchronous grab. See also grab_image. In case of the trigger mode set to 'free_run' it will be implicitly changed to 'process_interface'. The image buffer on the camera is flushed to ensure that a new image is captured. The z-image is returned in Cartesian coordinates as int2 or real, depending on the value of the 'pixel_format'. The unit is millimeter, but if the 'pixel_format' is set to 'Mono32F', the unit can be changed to meter using the 'distance_unit' parameter.

grab_image_async starts a new asynchronous grab. See also grab_image_async. If a synchronous grab changed the trigger mode this setting is reverted. In case that the trigger mode is set to 'process_interface' manually a software trigger is performed after retrieving the image from the camera. The parameter 'MaxDelay' is ignored. The z-image is returned in Cartesian coordinates as int2 or real, depending on the value of the 'pixel_format'. The unit is millimeter, but if the 'pixel_format' is set to 'Mono32F', the unit can be changed to meter using the 'distance_unit' parameter.

grab_data returns six images synchronously. In case of the trigger mode set to 'free_run' it will be implicitly changed to 'process_interface'. The image buffer on the camera is flushed to ensure that a new image is captured. In addition the tuple Data holds some diagnostic data that is provided with the images and the exposure times for this frame.

grab_data_async returns six images asynchronously. If a synchronous grab changed the trigger mode this setting is reverted. In case that the trigger mode is set to 'process_interface' manually a software trigger is performed after retrieving the image from the camera. The parameter 'MaxDelay' is ignored. In addition the tuple Data holds some diagnostic data that is provided with the images.

This operator closes the device. See also close_framegrabber.

For this interface there are the following examples available:

• o3d3xx_simple.hdev - A simple example to show the usage of the interface.
• o3d3xx_parameters.hdev - Lists all parameters of a device.
• o3d3xx_objectmodel3d.hdev - Shows how to generate an object model 3D from the retrieved data.
• o3d3xx_valid_data.hdev - Shows how to use the confidence image in order to find out which data points are valid.
• o3d3xx_temporary_parameters.hdev - Shows how to use the temporary parameters.

• Revision 13.0.4 (May 4, 2018):
  • When getting info_framegrabber 'parameters' and get_framegrabber_param 'available_param_names' returned an error. This problem has been fixed.
  • Removed unnecessary checking on o3d3xx_parameters.hdev example.
• Revision 13.0.3 (Feb 1, 2018):
  • The technical dependency from the HALCON Library has been removed.
  • With firmware version 1.20.67 the compatibility was broken. This problem has been fixed.
  • Added parameter 'connect_timeout' to get_framegrabber_param.
• Revision 13.0.2 Addendum (Jun 19, 2017):
  • This documentation was inconsistent about the additional values returned by grab_data. This problem has been fixed.
• Revision 13.0.2 (Apr 27, 2017):
  • When using a firmware version higher than 1.5.x grabbing images led to a crash. This problem has been fixed.
  • The operator grab_data returns five additional values in the Data tuple. These values are the exposure times used for this frame. If the camera is used in a mode with only one or two exposures, the remaining exposure times will be zero. Please note, that this feature is only available with firmware version 1.8.x or higher. When using a lower firmware version the returned values will be zero.
  • Three temporary parameters have been added that can be set while the camera is in run mode. These changes are not persistent and are lost when entering edit mode, i.e. when changing any non-temporary parameter using set_framegrabber_param. The three new parameters are 'temporary_exposure_time', 'temporary_exposure_time_ratio' and 'temporary_channel'. Please note, that this feature is only available with firmware version 1.8.x or higher.
  • The example o3d3xx_temporary_parameters.hdev has been added that shows how to use the new temporary parameters.
• Revision 13.0.1 (Oct 28, 2016):
  • HALCON 13 version of the interface.
• Revision 6.5 (Mar 29, 2016):
  • If binning was disabled, the values of the image size were not set correctly. This problem has been fixed.
  • Querying the possible values of the parameter 'binning' returned zero as a possible value, which isn't correct. The list has been corrected.
• Revision 6.4 (Mar 2, 2016):
  • The minimum value expected by the parameter 'exposure_time' was 0, but the correct minimum value is 1. This problem has been fixed.
  • The 'imager_configuration_type_values' parameter returned the unsupported value 'morethan30m_high'. This value has been removed.
• Revision 6.3 (Feb 15, 2016):
  • The parameters 'pixel_format' and 'distance_unit' have been added to specify the output type of the images as well as the distance unit of the X, Y, Z and distance images, respectively.
  • The HDevelop example o3d3xx_objectmodel3d.hdev and o3d3xx_simple.hdev have been improved by using the new parameters 'pixel_format' and 'distance_unit'.
  • The binning mode could not be switched off. The parameter 'binning' has been added to enable this option. Note that it is only available with firmware version 1.3.1001 or higher.
  • The HDevelop example o3d3xx_valid_data.hdev has been added.
  • When setting the parameters 'exposure_time' and 'exposure_time_ratio', incorrect limits values were used. This caused that, in some cases, these parameters could not be set. This problem has been fixed.
  • The parameter 'reduce_motion_artifacts' had no impact. This parameter has been removed.
  • The HDevelop example o3d3xx_parameters.hdev has been improved to show the range and values of the available parameters.
  • The parameters list returned by 'available_param_names' (via get_framegrabber_param) and 'parameters', 'parameters_readonly', and 'parameters_writeonly' (via info_framegrabber) were not returned in alphabetical order. This problem has been fixed.
  • The O3D3xx interface was available for Linux, but not mentioned in this documentation. The Linux support has been added to the 'System Requirements' section.
• Revision 6.2 Addendum (Sep 17, 2015):
  • The imager configuration type 'morethan30m_high' is not supported. This value option has been removed from the parameter 'imager_configuration_type' documentation.
• Revision 6.2 (Jun 15, 2015):
  • First official release.
  • In case that there is no application on the sensor open_framegrabber crashed. This problem has been fixed.
  • Minor internal fixes.
• Revision 6.1 (May 29, 2015):
  • Using set_framegrabber_param with the parameter 'exposure_time' led to a crash in most cases. This problem has been fixed.
• Revision 6.0 (Apr 10, 2015):
  • HALCON 12 version of the interface.