Note that most parameters of this interface are generic, i.e. all implemented HALCON parameters can be queried by calling info_framegrabber(..., 'parameters', ...). All actually available parameters and also the generic applet parameters can be queried by calling get_framegrabber_param(..., 'available_param_names', ...).

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.

grab_image starts a new synchronous grab. See also grab_image. Note that the interface converts the image from the device to the desired image format specified by the parameters 'image_width', 'image_height', 'start_row', 'start_column', 'bits_per_channel', and 'color_space'.

grab_image_async returns an image and starts the next asynchronous grab. See also grab_image_async. Note that the interface converts the image from the device to the desired image format specified by the parameters 'image_width', 'image_height', 'start_row', 'start_column', 'bits_per_channel', and 'color_space'.

The behavior of the operator depends on the used SmartApplets family. The operator is needed to work with the Segmentation and Triangulation SmartApplets family. Please see the section "Support of Segmentation SmartApplets Family" or "Support of Binarization SmartApplets Family" to get further information.

Same return values as grab_data, but here an asynchronous grab is started.

This operator closes the device. See also close_framegrabber.

The generic parameters of a GigE Vision camera can also be handled via the HALCON operators get_framegrabber_param and set_framegrabber_param. In this case the user has to add the prefix 'gbe:' to the parameter name, e.g., use set_framegrabber_param(..., 'gbe:Gain', 42) to set the camera parameter "Gain" to the value 42 or get_framegrabber_param(..., 'gbe:Gain', ...) to query the current value.

To execute a write-only GigE Vision command parameter via the operator set_framegrabber_param, the user has to add the prefix 'gbex:' to the parameter name, e.g., use set_framegrabber_param(..., 'gbex:TriggerSoftware', -1) to send a software trigger to a GigE Vision camera. The value of the parameter will be ignored.

Note that the list of available camera parameters can not be queried in advance, e.g., by calling get_framegrabber_param(...'available_param_names'...) or info_framegrabber(..., 'parameters', ...). To list all actually available camera parameters you can use the Silicon Software GigE Explorer application.

The generic parameters of GigE Vision, CoaXPress and Camera Link HS cameras can be accessed by using the GenICam interface and can also be handled via the HALCON operators get_framegrabber_param and set_framegrabber_param. In this case the user must add the prefix 'sgc:' to the parameter name, e.g., use set_framegrabber_param(..., 'sgc:Gain', 42) to set the camera parameter "Gain" to the value 42 or get_framegrabber_param(..., 'sgc:Gain', ...) to query the current value.

To execute a write-only GenICam command parameter via the operator set_framegrabber_param, the user has to add the prefix 'sgcx:' to the parameter name, e.g., use set_framegrabber_param(..., 'sgcx:TriggerSoftware', -1) to send a software trigger to a GenICam camera. The value of the parameter will be ignored.

Note that the list of available camera parameters can't be queried in advance, e.g., by calling get_framegrabber_param(...'available_param_names'...) or info_framegrabber(..., 'parameters', ...). To list all actually available camera parameters you can use the Silicon Software GenICam Explorer application.

With the Binarization SmartApplets family, the HALCON SiliconSoftware interface will deliver also a binary image which is calculated by the FPGA. With the Port parameter value set to 0, the interface will provide for each call of grab_image or grab_image_async a multi-channel image corresponding to the microEnable DMA channels 0 and 1. The first channel contains the standard image data. The second channel provides the calculated binary image. The specific settings (e.g., the threshold) ca be adjusted in the configuration file or by setting the generic Binarization SmartApplets parameters via set_framegrabber_param.

With the Segmentation SmartApplets family, the user has the possibility to get preprocessed blob information by calling grab_data or grab_data_async.

A Segmentation SmartApplet will find blobs which are based on a user specific parameterisation. The specific settings can be adjusted in the the configuration file or by setting the generic Segmentation SmartApplets parameter via set_framegrabber_param.

To accelerate the call of grab_data/grab_data_async the calculation of these features can be disabled via the parameters 'blob_region', 'blob_center_of_gravity', 'blob_contour_length', 'blob_area', and 'blob_bounding_box'. By default, all features except the integer values for the bounding box are enabled. If all features are enabled, the region tuple will return the detected blobs and the data tuple will return the following integer values for each blob: cogx, cogy, conto, contd, area, bbx0, bby0, bbx1, bby1.

With the 3D Triangulation SmartApplets family, the HALCON SiliconSoftware interface will deliver also a disparity image that is calculated by the FPGA. The user has the possibility to receive this pre-processed image by calling grab_data or grab_data_async.
To receive an image with multiple disparity lines at once, the number of disparity lines can be set via set_framerabber_param(..., 'num_scans', ...). The default is 1.
Please use the generic 3D Triangulation SmartApplets parameter 'FG_3D_IMAGE_OUTPUT' to enable or disable the output of images which correspond to the calculated disparity image lines. By default, the parameter 'FG_3D_IMAGE_OUTPUT' is enabled, and grab_data or grab_data_async returns multiple images. The first image is always the disparity image. Please note, if you change the parameter 'FG_3D_IMAGE_OUTPUT' after calling grab_data_async, a current pending grab will be aborted.
Please use the generic 3D Triangulation SmartApplets parameter 'FG_3D_THRESHOLD' to set the threshold parameter that influences the detection of the laser line. The default value for this parameter is 155.
The image width of the camera and the corresponding disparity image is always aligned (reduced) to a divisible value of 8 pixels.

With the Multi RoI module provided by VisualApplets the HALCON SiliconSoftware image acquisition interface supports the request of multiple Region of Interests (RoI) for each buffered image. The RoIs are accessible via images returned by grab_data and grab_data_async. The configuration of the RoI module can be done by using the parameters listed in the table below. Please use the set_parameter_param and get_framegrabber_param operators as usual. To get further information about the RoI functionality, please read the module section provided in the VisualApplets documentation. Please use the following parameters to configure the RoI module:

multi_roi_module_name:	Specifies the base name of the RoI module	string
multi_roi_num:	Specifies the number of RoIs to request	integer
multi_roi_xlength:	Specifies the xlength (width) for each RoI	integer tuple
multi_roi_xoffset:	Specifies the xoffset (start column) for each RoI	integer tuple
multi_roi_ylength:	Specifies the ylength (height) for each RoI	integer tuple
multi_roi_yoffset:	Specifies the yoffset (start row) for each RoI	integer tuple

Please note, if you have trouble setting the parameter 'multi_roi_num', please check the maximum number of RoIs provided by the RoI module. The maximum number can only be changed before the applet is generated. If an applet with RoI functionality is used, the parameter 'continuous_grabbing' is not supported. The multi RoI parameters are not accessible by the HALCON Image Acquisition Assistant.

For this interface there are the following examples available:

• siliconsoftware_continuous.hdev - Grabbing images with continuous grabbing.
• siliconsoftware_gige_vision.hdev - Shows usage of a Silicon Software GigE Vision frame grabber.
• siliconsoftware.hdev - Benchmark
• siliconsoftware_parameters.hdev - Lists all parameters of a device.
• siliconsoftware_simple.hdev - A simple example to show the usage of the interface.
• siliconsoftware_smartapplets.hdev - Shows usage of Silicon Software SmartApplets.
• siliconsoftware_multiroi.hdev - Shows usage of Silicon Software VisualApplets' RoI functionality.
• siliconsoftware_fieldparameter.hdev - Shows how to access the Silicon Software generic field parameter.
• siliconsoftware_objectmodel3d.hdev - Shows usage of Silicon Software Triangulation SmartApplets, and how to create a HALCON 3D object model.

• Revision 13.0.6 (Nov 30, 2018):
  • A problem during the buffer allocation could lead to a speed reduction, when changing the following parameters via set_framegrabber_param: 'start_row', 'start_column', 'image_width' and 'image_height'. This problem has been fixed.
  • The value of the Generic parameter 'genicam_xml_file' could not be queried via get_framegrabber_param. This problem has been fixed.
  • The parameters 'applet_type_description', 'do_exsync_description', 'num_buffers_description', 'slave_description' and 'genicam_xml_file_description' were not implemented. This problem has been fixed.
• Revision 13.0.5 (Apr 13, 2018):
  • The technical dependency from the HALCON Library has been removed.
  • After aborting an asynchronous grab with the parameter 'do_abort_grab' an error occurred. This problem has been fixed.
  • When opening a device a lot of low-level error messages occurred. This problem has been fixed.
  • Added support of extended error info.
  • Added support of master/slave mode. Therefor the new parameter 'slave' has been added to get_framegrabber_param and open_framegrabber (Generic).
  • Added support for the 'Mono4p' pixel format.
  • Added support for the 'YCbCr411_8' pixel format.
  • The range of the parameter 'exposure' was not correct in the documentation. This problem has been fixed.
  • Added information about accessing cameras with the GenICam interface directly from HALCON.
  • Improved error messages in case of sgc and gce parameters.
• Revision 13.0.4 (Jun 12, 2017):
  • The generic applet parameters could not be accessed when using Silicon Software driver version 5.5.0. This problem has been fixed.
• Revision 13.0.3 (May 3, 2017):
  • The mE5 marathon VCX QP board runs into a timeout error during grab_image and grab_image_async. Internally the AcquisitionStart command was not executed. This problem has been fixed.
  • A call of info_framegrabber with the parameter 'info_boards' does not list a mE5 marathon VCX QP board. This problem has been fixed.
• Revision 13.0.2 (Mar 7, 2017):
  • Adapted to Silicon Software SDK 5.4.4.
  • Support of new frame grabber models mE5 marathon ACL, mE5 marathon VCL, mE5 marathon AF2, and mE5 marathon ACX QP.
• Revision 13.0.1 (Oct 28, 2016):
  • HALCON 13 version of the interface.
• Revision 6.6 (Sep 26, 2016):
  • Adapted range of maximum possible timeout value to 2^32-1 milliseconds. With -1 the maximum possible value will be set.
  • Improved error handling of Generic parameter in open_framegrabber.
• Revision 6.5 (Jul 27, 2016):
  • If a generic visual applets field parameter was queried, the last value of the list was not returned. This problem has been fixed.
• Revision 6.4 (May 13, 2016):
  • open_framegrabber failed with error 5312 when the Generic parameter 'genicam_xml_file' was used. This problem has been fixed.
  • close_framegrabber in rare cases crashed when using more than one GenICam device. This problem has been fixed.
• Revision 6.3 (Apr 27, 2016):
  • set_framegrabber_param crashed when setting 'do_exsync' or 'do_flash' with an empty tuple. This problem has been fixed.
  • Fixed memory leak in close_framegrabber which led to a crash in rare cases. This problem has been fixed.
  • In continuous mode the synchronous call grab_image always returned a timeout. This problem has been fixed.
  • If a generic float parameter was set with an integer value a later call with get_framegrabber_param returned the wrong result. This problem has been fixed.
  • The description of the parameters 'num_last_image' and 'num_images_in_progress' has been improved.
  • The legacy parameter 'current_buffer_index' has been removed from this documentation. This parameter is no longer supported. Please use the parameters 'num_blocked_images', 'num_block_lost_images', 'num_grabbed_images', 'num_last_image', 'num_next_image', and 'num_images_in_progress' instead.
• Revision 6.2 (Feb 15, 2016):
  • Grabbing images with microEnable GigE Vision boards failed. Any attempt at grabbing returned with a timeout and it was not possible to get or set the GenICam parameters. This problem has been fixed.
  • If the parameter 'multi_roi_xlength', 'multi_roi_xoffset', 'multi_roi_ylength' and 'multi_roi_yoffset' were not supported by the used hardware applet, the call of set_framegrabber_param and get_framegrabber_param with these parameters might have crashed. This problem has been fixed.
• Revision 6.1 (Oct 20, 2015):
  • Adapted to Silicon Software SDK 5.4.
  • Added support of microEnable V frame grabber family.
  • Added new parameters 'num_blocked_images', 'num_block_lost_images', 'num_grabbed_images', 'num_last_image', 'num_next_image', and 'num_images_in_progress' to get a status information of the buffer queue.
  • Added new parameter 'acquisition_mode' to control the behaviour of the buffer queue.
  • A call of info_framegrabber with the parameter 'device' returned a static list with possible device values. Now the dynamic values of connected devices are returned.
  • Added generic parameter 'genicam_xml_file' to pass a predefined configuration in case of a microEnable CoaXPress frame grabber.
  • Removed limitation of 'num_buffers'. Previously it was only possible to use up to 255 buffers.
  • In case of an error, the information of some low level errors is not sufficient. Detailed information is not available. This problem has been fixed.
  • Every DMA channel on a micro enable board is controlled by its own acquisition handle. The initialization of the board for all DMA channels will be done by the first call of open_framegrabber. There is no low level error to notify the user that the second open_framegrabber call on the same board will ignore the passed configuration file. This problem has been fixed.
• Revision 6.0 (Oct 31, 2014):
  • HALCON 12 version of the interface.
• Revision 5.5 (Jan 27, 2014):
  • Fixed bug in parameter 'grab_timeout'. If the parameter was set via set_framegrabber_param, also the DMA timeout of the frame grabber was adapted. This setting could lead to unexpected timeout errors.
  • Corrected documentation by adding support of WoW64.
• Revision 5.4 (Jun 12, 2013):
  • Fixed bug in continuous grabbing mode. In case of a Standard Acquisition Applet with a single camera that is not connected to Camera Link port A, a wrong DMA channel was internally selected.
  • Fixed bug in buffer allocation during the activation of continuous grabbing.
  • Added missing parameter 'do_process_image_values'.
  • Fixed bug in close_framegrabber.
• Revision 5.3 (May 24, 2013):
  • Adapted to Silicon Software SDK 5.2.1.
  • Added support of VisualApplets modules with RoI functionality. Now also the CoaXPress frame grabbers are supported.
  • Improved the 'generic' Silicon Software parameter configuration by adding access to field parameters.
  • Added parameters 'multi_roi_module_name', 'multi_roi_num', 'multi_roi_xlength', 'multi_roi_xoffset', 'multi_roi_ylength', 'multi_roi_yoffset', and 'num_field_parameter'.
  • Added new HDevelop example programs 'siliconsoftware_multiroi.hdev' and 'siliconsoftware_fieldparameter.hdev'.
  • Fixed bug if an unknown 'description' parameter was used.
  • Corrected documentation of the Generic parameter.
  • Fixed bug in close_framegrabber when using more than one camera in case of Silicon Software GigE Vision boards.
  • Fixed bug in open_framegrabber: The horizontal_resolution and vertical_resolution parameters are now ignored as documented.
  • Adapted and unified all existing HDevelop example programs.
• Revision 5.2 (Oct 29, 2012):
  • Fixed bug in parameter 'available_param_names'.
  • Adapted evaluation of 'applet_type' parameter inside HDevelop example 'siliconsoftware_smartapplets.hdev'.
  • Added generic parameter 'discovery_timeout'.
  • Fixed bug in open_framegrabber. Cleanup the already opened device handles, if the initialization of a connected device or the initialization of the Silicon Software GigE Vision board fails.
  • Added new example 'siliconsoftware_objectmodel3d.hdev'.
• Revision 5.1 (Jul 18, 2012):
  • Extended grab_data and grab_data_async to support the 3D Triangulation SmartApplets family.
  • Added parameter 'num_scans' to control the number of disparity lines.
• Revision 5.0 (May 15, 2012):
  • HALCON 11 version of the interface (included in HALCON 11 DVD).
  • Fixed thread safety problem in grab_image and grab_image_async that can occur if grabbing was aborted via the 'do_abort_grab' parameter of set_framegrabber_param.
  • Adapted return value if grab_image or grab_image_async was aborted by the user. The return value now is H_ERR_FGF ("Failed grabbing of an image").
• Revision 4.4 (Feb 4, 2012):
  • Fixed bug in the continuous grabbing mode. If a timeout occurred the internal used acquisition engine was erroneously restarted and the previously queued images were discarded.
  • Added parameter 'image_available'.
  • Improved error handling in open_framegrabber.
• Revision 4.3 (May 30, 2011):
  • Improved continuous grabbing mode: Now, this mode supports to queue an arbitrary number of trigger signals (corresponding to the parameter 'num_buffers').
  • Added parameter 'image_tag'.
  • Added support of GigE Vision command parameters.
• Revision 4.2 (Mar 15, 2011):
  • Implemented grab_data and grab_data_async to enable the use of Segmentation SmartApplets (Blob).
  • Added parameters 'blob_contour_length', 'blob_center_of_gravity', 'blob_area', 'blob_bounding_box', and 'blob_region' to control the Data and Region output parameters of grab_data and grab_data_async.
  • Added parameter 'applet_type'.
  • Fixed bug in 'continuous_grabbing'.
• Revision 4.1 (Sep 8, 2010):
  • Adapted to Silicon Software SDK 5.1.
  • Support of Silicon Software GigE Vision boards including generic parameterization.
  • Added functionality to use the SmartApplets or other applets with multiple DMA channels.
  • Updated error handling in coprocessor mode, i.e., in this mode grab_image and grab_image_start will return the error H_ERR_FNS.
  • Adapted the board names to new Silicon Software product names.
  • HALCON 10 version of the interface (included in HALCON 10 DVD).
• Revision 4.0 (Mar 16, 2010):
  • First official release.