HALCON 7.0 Frame Grabber Interface for The Imaging Source DFG/BW1, DFG/BW4, and DFG/RGB2 Boards
This page provides the documentation about the HALCON frame grabber interface HFGDFG-BW.dll for the The Imaging Source frame grabber boards DFG/BW1, DFG/BW4, and DFG/RGB2. Registered customers can download the latest revision of this interface from the MVTec WWW server.
Revision: 2.3
System Requirements
- Intel compatible PC with Windows NT 4.0 (Service Pack 4) or Windows 2000.
- Successfully installed DFG/BW1, DFG/BW4, or DFG/RGB2 board. This installation includes the files eleye416.dll (or eleye516.dll, respectively), el_hard.dll, and eleye416.cam (or eleye516.cam), which must be placed within your search path %PATH% (e.g., in bin\i586-nt4 within the HALCON base directory %HALCONROOT% you have chosen during the installation of HALCON). If you do not have these files, please contact the vendor from which you bought the frame grabber board.
-
HALCON frame grabber interface HFGDFG-BW.dll or
parHFGDFG-BW.dll, respectively.
If you have properly installed the interface, both DLLs should reside in bin\i586-nt4 within the HALCON base directory %HALCONROOT% you have chosen during the installation of HALCON. - Configuration files for your boards, created with the The Imaging Source configuration tool.
Features
- Multiple frame grabber boards.
- Synchronous and asynchronous grabbing.
- Cropping of image parts.
- External trigger.
- LUTs (DFG/BW1 only).
- Software control of 'black' and 'white' levels.
- Support of color CCD cameras with software control of 'gain', 'hue' ,'saturation', and 'gamma' (DFG/BW1 only).
- Software control of the digital output lines.
- Support of dual mode (DFG/BW1 only).
Limitations
- grab_region() and grab_region_async() not supported.
- Support of monochrome and RGB 8 bits per channel only.
Description
Parameters for open_framegrabber():
| Name | 'DFG-BW' | The name of the HALCON frame grabber interface. | |||
| HorizontalResolution | --- | Ignored (value is set via the configuration file). | |||
| VerticalResolution | --- | Ignored (value is set via the configuration file). | |||
| ImageWidth | 0, width | The width of the desired image part (or 0 for the use of value set in the configuration file). Default: 0. | |||
| ImageHeight | 0, height | The height of the desired image part (or 0 for the use of value set in the configuration file). Default: 0. | |||
| StartRow | 0, row | The row coordinate of the upper left pixel of the desired image part (if ImageWidth and ImageHeight are set to 0, this value is ignored and taken from the configuration file). Default: 0. | |||
| StartColumn | 0, column | The column coordinate of the upper left pixel of the desired image part (if ImageWidth and ImageHeight are set to 0, this value is ignored and taken from the configuration file). Default: 0. | |||
| Field | --- | Ignored (value is set via the configuration file). | |||
| BitsPerChannel | --- | Ignored (value is set via the configuration file). | |||
| ColorSpace | --- | Ignored (value is set via the configuration file). | |||
| Gain | --- | Ignored (value is set via the configuration file). | |||
| ExternalTrigger | --- | Ignored (value is set via the configuration file). | |||
| CameraType | 'filename' | Name of the configuration file for the board. This has to be a valid '.dat'-file created with the The Imaging Source configuration tool. All the basic board setup is done using this file. Note that only the 'gray' (8 bit) and 'rgb' (8-8-8 bit) color modes are supported by this interface. A full path name has to be entered (e.g., 'C:\\my_configurations\\my_dfgbw1.dat'). | |||
| Device | 'name:id' |
The name and id of the frame grabber board. Devices must be named
'name:id', where name is either 'dfg-bw1',
'dfg-bw4', or 'dfg-rgb2', and id is the HEX setting of the
board (DFG/BW1: jumpers J101 and J102; DFG/BW4 and DFG/RGB2:
HEX switch). Example: 'dfg-bw1:3' is a DFG/BW1 board with HEX jumpers set to 3. Note, that different boards have to use different HEX settings. |
|||
| Port | --- | Ignored (value is set via the configuration file). | |||
| LineIn | --- | Ignored. | |||
Parameters for set_framegrabber_param():
All these settings are valid for all input lines (if applicable), i.e., cameras connected to one frame grabber board. Note that not all of these settings may be used with all boards. Some of these settings do not influence the grabbing on all camera inputs (see below).
| 'black_level' | min_level ... max_level | The desired voltage level for 'black' pixels in millivolts (floating point number). The valid range for a particular board can (and should) be queried via get_framegrabber_param(...,'black_level_min',...) and get_framegrabber_param(...,'black_level_max',...), respectively. Furthermore, 'black_level' must be smaller than 'white_level'. | |||||||||
| 'black_level_b' | min_level ... max_level | The desired voltage level for 'black' pixels in millivolts (floating point number) for the red channel (DFG/RGB2 only). The valid range for a particular board can (and should) be queried via get_framegrabber_param(...,'white_level_min',...) and get_framegrabber_param(...,'white_level_max',...), respectively. Furthermore, 'black_level_b' must be smaller than 'white_level_b'. | |||||||||
| 'black_level_g' | min_level ... max_level | The desired voltage level for 'black' pixels in millivolts (floating point number) for the red channel (DFG/RGB2 only). The valid range for a particular board can (and should) be queried via get_framegrabber_param(...,'black_level_min',...) and get_framegrabber_param(...,'black_level_max',...), respectively. Furthermore, 'black_level_g' must be smaller than 'white_level_g'. | |||||||||
| 'black_level_r' | min_level ... max_level | The desired voltage level for 'black' pixels in millivolts (floating point number) for the red channel (DFG/RGB2 only). The valid range for a particular board can (and should) be queried via get_framegrabber_param(...,'black_level_min',...) and get_framegrabber_param(...,'black_level_max',...), respectively. Furthermore, 'black_level_r' must be smaller than 'white_level_r'. | |||||||||
| 'gain' | 0.0 ... 2.0 | The desired gain (DFG/BW1 with RGB 8-8-8 only). The equation 0.0 <= 2*offset + gain <= 2.0 has to be satisfied; otherwise, 'offset' is decreased automatically. | |||||||||
| 'gamma' | 1.0, 1.4 | The desired gamma correction (DFG/BW1 with RGB 8-8-8 only). l_out = l_in * exp(gamma). | |||||||||
| 'grab_timeout' | 100 ... 327680 | Specify the desired timeout (milliseconds passed as an integer) for aborting a pending grab. Default: 5000. | |||||||||
| 'hue' | -180.0 ... 180.0 | The desired color hue in degree (DFG/BW1 with RGB 8-8-8 only). | |||||||||
| 'image_height' | height | The height of the desired image part. width must not be larger than VertcialResolution - StartRow and should be divisible by the 'pixelalign' value (see below); otherwise, 'image_height' is adjusted to a smaller valid value. | |||||||||
| 'image_width' | width | The width of the desired image part. width must not be larger than HorizontalResolution - StartColumn and should be divisible by the 'pixelalign' value (see below); otherwise, 'image_width' is adjusted to a smaller valid value. | |||||||||
| 'offset' | 0.0 ... 1.0 | The desired offset level (DFG/BW1 with RGB 8-8-8 only). The equation 0.0 <= 2*offset + gain <= 2.0 has to be satisfied; otherwise, 'gain' is decreased automatically. | |||||||||
| 'output_reset' |
1 ... 3 (DFG/BW1), 1 ... 7 (DFG/BW4, DFB/RGB2) |
Set value to 1, 2, and 4 (or any combination) to set output lines 1, 2, and 3 (or any combination) to low state (DFG/BW1: output lines 1 and 2 only). Note, that the output status can not be read via get_framegrabber_param(). | |||||||||
| 'output_set' |
1 ... 3 (DFG/BW1), 1 ... 7 (DFG/BW4, DFB/RGB2) |
Set value to 1, 2, and 4 (or any combination) to set output lines 1, 2, and 3 (or any combination) to high state (DFG/BW1: output lines 1 and 2 only). Note, that the output status can not be read via get_framegrabber_param(). | |||||||||
| 'port' |
0, 1, 16, 17, 32, 33, 48, 49 (DFG/BW1) 0, 2, 4, 6 (DFG/BW4) 8, 9 (DFG/RGB2) |
Select the desired camera input port for acquisition during
runtime. The following values are possible:
|
|||||||||
| 'saturation' | 0.0 ... 2.0 | The desired color saturation (DFG/BW1 with RGB 8-8-8 only). | |||||||||
| 'start_column' | column | The column coordinate of the upper left pixel of the desired image part. column must not be larger than HorizontalResolution - ImageWidth and should be divisible by the 'pixelalign' value (see below); otherwise, 'start_column' is adjusted to a smaller valid value. | |||||||||
| 'start_row' | row | The row coordinate of the upper left pixel of the desired image part. row must not be larger than VerticalResolution - ImageHeight and should be divisible by the 'pixelalign' value (see below); otherwise, 'start_row' is adjusted to a smaller valid value. | |||||||||
| 'switch_buffer' | 'enable', 'disable' | This parameter controls the buffer switching after each grab. Usually, two image buffers are allocated, which are used alternately. Default: 'enable'. Attention: Do not disable the buffer switching if you are using the volatile mode! | |||||||||
| 'sync_in' | 4, 5, 6, 7 |
Select the desired sync input port for acquisition during runtime
(DFG/BW4 and DFG/RGB2 only). The following values are possible:
|
|||||||||
| 'testacq_interval' | 1 ... 10 | Set time (in milliseonds) between two subsequent test calls while waiting for the end of a current grab. Default: 2. | |||||||||
| 'volatile' | 'enable', 'disable' | In the volatile mode (8 bit, one channel only!) the two frame grabber interface buffers are used directly to store HALCON images. This is the fastest mode avoiding to copy raw images in memory. However, be aware that older images are overwritten again and again as a side-effect. Thus, you can only process one image while you grab another image. Older images are invalid! Default: 'disable'. | |||||||||
| 'white_level' | min_level ... max_level | The desired voltage level for 'white' pixels in millivolts (floating point number). The valid range for a particular board can (and should) be queried via get_framegrabber_param(...,'white_level_min',...) and get_framegrabber_param(...,'white_level_max',...), respectively. Furthermore, 'white_level' must be larger than 'black_level'. | |||||||||
| 'white_level_b' | min_level ... max_level | The desired voltage level for 'white' pixels in millivolts (floating point number) for the red channel (DFG/RGB2 only). The valid range for a particular board can (and should) be queried via get_framegrabber_param(...,'white_level_min',...) and get_framegrabber_param(...,'white_level_max',...), respectively. Furthermore, 'white_level_b' must be larger than 'black_level_b'. | |||||||||
| 'white_level_g' | min_level ... max_level | The desired voltage level for 'white' pixels in millivolts (floating point number) for the red channel (DFG/RGB2 only). The valid range for a particular board can (and should) be queried via get_framegrabber_param(...,'white_level_min',...) and get_framegrabber_param(...,'white_level_max',...), respectively. Furthermore, 'white_level_g' must be larger than 'black_level_g'. | |||||||||
| 'white_level_r' | min_level ... max_level | The desired voltage level for 'white' pixels in millivolts (floating point number) for the red channel (DFG/RGB2 only). The valid range for a particular board can (and should) be queried via get_framegrabber_param(...,'white_level_min',...) and get_framegrabber_param(...,'white_level_max',...), respectively. Furthermore, 'white_level_r' must be larger than 'black_level_r'. |
Parameters for get_framegrabber_param():
Additional parameters supported by get_framegrabber_param only. Note that all parameters supported by set_framegrabber_param (except 'output_set' and 'output_reset') can also be accessed by get_framegrabber_param.
| 'black_level_max' | max_level | The maximum allowed voltage level for 'black' pixels in millivolts. | |||
| 'black_level_min' | min_level | The minimum allowed voltage level for 'black' pixels in millivolts. | |||
| 'pixelalign' | bits | Alignment of the desired acquisition window in the memory: The parameter values for 'start_row', 'start_column', 'image_width', and 'image_height' must be divisible by bits. | |||
| 'revision' | revision | The revision number of the HALCON DFG-BW interface. | |||
| 'white_level_max' | max_level | The maximum allowed voltage level for 'white' pixels in millivolts. | |||
| 'white_level_min' | min_level | The minimum allowed voltage level for 'white' pixels in millivolts. | |||
Release Notes
-
Revision 2.3 (Dec 1, 2004):
- The query types 'bits_per_channel', 'camera_type', 'color_space', 'device', 'external_trigger', 'field', and 'port' for info_framegrabber provide now specific value lists for the corresponding parameters in open_framegrabber.
-
Revision 2.2 (Apr 9, 2002):
- HALCON 7.0 version of the interface (included in HALCON 7.0 CD).
- HALCON 6.1 version of the interface (included in HALCON 6.1 CD).
- Added support for DFG/BW4 and DFG/RGB2.
- Added board type specification in device parameter during open_framegrabber().
- New parameter 'sync_in'.
- New parameters 'image_width' and 'image_height' for changing the acquisition window during runtime.
-
Revision 2.1 (Dec 19, 2000):
- Query board information in info_framegrabber().
- Bugfix in initializing frame grabber board.
-
Revision 2.0 (Sep 20, 2000):
- Adaptation to the HALCON 6.0 frame grabber interface.
-
Revision 1.4 (Jul 5, 2000):
- First official release.
