Parameter |
Value List |
Type |
Kind |
Description |
'bits_per_channel' |
[] |
|
|
Ignored. |
'camera_type' |
['CAMFILE:', 'dcf', <camera_path>
'M_CCIR', 'M_CCIR_VIA_RGB',
'M_DEFAULT', 'M_NTSC',
'M_NTSC_RGB', 'M_NTSC_YC',
'M_PAL', 'M_PAL_RGB',
'M_PAL_YC', 'M_RS170',
'M_RS170_VIA_RGB']
|
string |
pre-defined |
Syntax for camera configuration file and possible values for camera type. |
'color_space' |
['gray', 'rgb'] |
string |
pre-defined |
Values for color space. |
'defaults' |
[1, 1, 0, 0, 0, 0, 'interlaced', 8, 'gray', -1.0, 'false', 'M_DEFAULT', '0', -1, 0]
|
mixed |
pre-defined |
Default values for open_framegrabber. |
'device' |
['<BoardType>:<nr>[:DIG:<nr>]'] |
string |
pre-defined |
Type ( 'MORPHIS', 'RADIENT', 'SOLIOS', or 'VIO') and number ('0', '1', '2' ...) of the frame grabber board, optionally plus ':DIG:' and the
number ('0', '1', '2' ...) of the independent digitizer (passed as one
string!), e.g., 'SOLIOS:0'. If no digitizer is specified, the first
digitizer (i.e., number '0') is chosen. The installed boards can be
inquired calling info_framegrabber(..., 'info_boards', ...).
|
'external_trigger' |
['false', 'true'] |
string |
pre-defined |
Values for the external trigger. |
'field' |
[] |
|
|
Unused. |
'general' |
[] |
string |
pre-defined |
Information about the HALCON MILLite interface. |
'generic' |
['', 'num_buffers=<num>'] |
string |
pre-defined |
Value list for the Generic parameter. |
'horizontal_resolution' |
1 |
integer |
pre-defined |
Value list for horizontal resolution. |
'image_height' |
[] |
|
|
Unsupported query. |
'image_width' |
[] |
|
|
Unsupported query. |
'info_boards' |
['<BoardType>:<nr>[:DIG:<nr>]'] |
string |
dynamic |
A list of the available devices. |
'parameters' |
[] |
string |
pre-defined |
Ignored |
'parameters_readonly' |
[] |
string |
pre-defined |
Ignored |
'parameters_writeonly' |
[] |
string |
pre-defined |
Ignored |
'port' |
[] |
|
pre-defined |
Unused. |
'revision' |
'<revision>' |
string |
pre-defined |
Revision number of the MILLite interface. |
'start_column' |
[] |
|
|
Unsupported query. |
'start_row' |
[] |
|
|
Unsupported query. |
'vertical_resolution' |
1 |
integer |
pre-defined |
Value list for vertical resolution. |
Parameter |
Values |
Default |
Type |
Description |
Name |
'MILLite' |
|
string |
Name of the HALCON interface. |
HorizontalResolution |
--- |
1 |
|
Ignored. |
VerticalResolution |
--- |
1 |
|
Ignored. |
ImageWidth |
0, <width> |
0 |
|
The width of the desired image part ('0' stands for the complete image). Default: 0.
|
ImageHeight |
0, <height> |
0 |
|
The height of the desired image part ('0' stands for the complete image). Default: 0.
|
StartRow |
0, <row> |
0 |
|
The row coordinate of the upper left pixel within the desired image part ('0' obviously results in delivering the complete image).
Default: 0.
|
StartColumn |
0, <column> |
0 |
|
The column coordinate of the upper left pixel within the desired 0 image part ('0' obviously results in delivering the complete image).
Default: 0.
|
Field |
--- |
|
|
Ignored. |
BitsPerChannel |
--- |
|
|
Ignored. |
ColorSpace |
'gray', 'rgb' |
'gray' |
string |
Desired color space and thus the number of image channels of the resulting HALCON image.
|
Generic |
'', 'num_buffers=<num>', -1 |
-1 |
mixed |
With the Generic parameter 'num_buffers' the current number of image buffers used in the HALCON acquisition interface can be set before the camera is
initialized. Note that the parameter must be specified as a string, e.g.,
'num_buffers=5'. The specified value for num_buffers has to be a positive
integer (Default: 2). Note that depending on the image size of the used camera
a high number of buffers can exceed the available memory size of your computer,
see also the non-paged memory size settings with the Matrox MILConfig
configuration tool.
|
ExternalTrigger |
'false', 'true' |
'false' |
string |
Enable/disable external trigger. |
CameraType |
'<configuration>' |
'M_DEFAULT' |
string |
Specify the name (including the full path name) of the desired camera configuration file (e.g., 'c:\\MyFolder\\rs170.dcf') or a predefined
configuration (e.g., 'M_DEFAULT', 'M_RS170').
For possible values, please see the documentation of your board.
|
Device |
'<BoardType>:<nr>[:DIG:<nr>]' |
'0' |
string |
Type ( 'MORPHIS', 'RADIENT', 'SOLIOS', or 'VIO') and number ('0', '1', '2' ...) of the frame grabber board, optionally plus ':DIG:' and the
number ('0', '1', '2' ...) of the independent digitizer (passed as one
string!), e.g., 'SOLIOS:0'. If no digitizer is specified, the first
digitizer (i.e., number '0') is chosen. The installed boards can be
inquired calling info_framegrabber(..., 'info_boards', ...).
|
Port |
<port> |
-1 |
integer |
Unused. |
LineIn |
--- |
|
|
Ignored. |
Parameter |
Values |
Default |
Type |
Description |
'cc1_select' |
'default', 'grab_exposure', 'pixclk', 'user_bit_cc_a', 'user_bit_cc_b', 'hsync', 'vsync'
|
|
string |
Assign a particular signal to Camera Link cc1 line. |
'cc2_select' |
'default', 'grab_exposure', 'pixclk', 'user_bit_cc_a', 'user_bit_cc_b', 'hsync', 'vsync'
|
|
string |
Assign a particular signal to Camera Link cc2 line. |
'cc3_select' |
'default', 'grab_exposure', 'pixclk', 'user_bit_cc_a', 'user_bit_cc_b', 'hsync', 'vsync'
|
|
string |
Assign a particular signal to Camera Link cc3 line. |
'cc4_select' |
'default', 'grab_exposure', 'pixclk', 'user_bit_cc_a', 'user_bit_cc_b', 'hsync', 'vsync'
|
|
string |
Assign a particular signal to Camera Link cc4 line. |
'continuous_grabbing' |
'disable', 'enable' |
'disable' |
string |
Enables/disables the continuous grabbing mode. If the continuous grabbing mode is enabled, the camera grabs all the time. Note that in this mode the
grab_image and grab_image_async calls will always deliver the most recent
image! The continuous grabbing mode is not supported in combination with
software trigger.
Note that in combination with the continuous grabbing mode you can exploit
the specific Trigger Arm Characteristics settings which can be configured
in the used DCF file, see also below for more information.
|
'current_buffer_index' |
0 ... <num_buffers>-1 |
|
integer |
Index of the current image buffer. |
'do_abort_grab' |
--- |
|
|
Cancel current grab. |
'do_force_trigger' |
--- |
|
|
Forces an event trigger from the application, when using the external trigger. This might be useful for testing purposes. Note, that
'do_force_trigger' requires an already pending asynchronous grab.
Please, see also the 'trigger_mode' parameter, to see how this action
can be controlled.
|
'do_gpio_write:XX' |
0, 1 |
|
integer |
Functional state of a specific GPIO line (with XX = 0, 1, ..., 15 as unique index of the desired GPIO line).
|
'do_reset_rotary_counter' |
--- |
|
|
Resets the rotary counter to zero. |
'exposure_time' |
<nanoseconds> |
|
integer |
Time (in nanoseconds) for the active portion of the exposure signal (that is, the exposure time). By specifying 0, exposure is disabled and
the grab is performed immediately. Note, that an error is returned if the
specified exposure time cannot be generated.
|
'exposure_time_delay' |
<nanoseconds> |
|
integer |
Delay (in nanoseconds) between the trigger and the start of exposure. Note, that an error is returned if the specified delay cannot be generated.
|
'external_trigger' |
'false', 'true' |
|
string |
Enable/disable external trigger. |
'gpio_format:XX' |
'default', 'disable', 'enable', 'lvds', 'opto', 'tri-state', 'ttl' |
|
string |
Format of the specified GPIO signal (with XX = 0, 1, ..., 15 as unique index of the desired GPIO line).
|
'gpio_mode:XX' |
'default', 'input', 'output' |
|
string |
Controls the direction of the specified GPIO signal (with XX = 0, 1, ..., 15 as unique index of the desired GPIO line).
|
'grab_timeout' |
<milliseconds> |
5000 |
integer |
Desired timeout (milliseconds) for aborting a pending grab. If -1 is specified, the timeout is set to INFINITE.
|
'image_height' |
<height> |
|
integer |
Dynamically change the current image height of the grabbed image. Note that by changing this value, all active image grabs are
cancelled.
|
'image_width' |
<width> |
|
integer |
Dynamically change the current image width of the grabbed image. Note that by changing this value, all active image grabs are
cancelled.
|
'rotary_counter' |
'false', 'true' |
'false' |
string |
Activate/deactivate the rotary counter. |
'rotary_counter_direction' |
'backward', 'forward' |
'forward' |
string |
Direction of the rotary counter, i.e. the rotary counter gets incremented for a value of 'forward', or decremented for a value of
'backward', respectively.
|
'rotary_counter_trigger_position' |
0, ..., 65535 |
|
integer |
Rotary counter value upon which a trigger is generated. |
'start_async_after_grab_async' |
'disable', 'enable' |
'enable' |
string |
By default a new asynchronous grab command is automatically given to the acquisition device at the end of grab_image_async. If the parameter
'start_async_after_grab_async' is set to 'disable', this new grab command
is omitted.
|
'start_column' |
0, <max_column> |
|
integer |
Sets the column coordinate of the upper left corner of the resulting HALCON image part.
|
'start_field' |
'default', 'even', 'next', 'odd' |
'default' |
string |
Specifies the field that the grabbing of a frame starts with.
- 'even': the grabbing starts with the even field
- 'odd': the grabbing starts with the odd field
- 'next': the grabbing starts with the next field
- 'default': the grabbing starts with the board-specific default.
For the actual default start field, please see the documentation of your
Matrox frame grabber board.
|
'start_row' |
0, <max_row> |
|
integer |
Sets the row coordinate of the upper left corner of the resulting HALCON image part.
|
'trigger_mode' |
'software', 'exposure' |
|
string, integer |
The parameter 'trigger_mode' specifies the mode of the trigger signal released by the parameter 'do_force_trigger'. If the option 'software' is
selected, a signal to trigger the grab of an image will be released. With
the option 'exposure' an exposure trigger signal for the specified exposure
timer will be released when calling parameter 'do_force_trigger'. It's
also possible to pass an integer value in case that a special trigger mode
should be used. For the supported integer values (defines), please have a
look at the chapter 'MdigControl' in the MIL Help documentaion. Any mode
that has to be enabled with 'M_ACTIVE' is supported.
|
'trigger_signal' |
'default', 'falling', 'high', 'low', 'rising' |
|
string |
Defines the expected type of input trigger.
- 'rising' ('falling'): requires the external trigger to go low (high)
and high (low) again before the next image can be acquired
- 'high' ('low'): an image can be acquired during the whole time the
trigger is high (low).
- 'default': specifies the trigger mode in the DCF file or, if none,
'rising'.
|
'trigger_source' |
'default', 'hw_port_camera', 'hw_port0', ..., 'hw_port11', 'none', 'rotary_counter', 'software', 'timer1', 'timer2'
|
|
string |
Defines the source of the input trigger. For details, please see the documentation of your frame grabber board.
|
Parameter |
Values |
Default |
Type |
Kind |
Description |
'available_param_descriptions' |
['<parameters>'] |
|
string |
dynamic |
A list containing additional information about all parameters. The order of the entries is equal to the order of the parameter names returned by
'available_param_names'.
|
'available_param_names' |
['<parameters>'] |
|
string |
dynamic |
The list contains the names of all available parameters. |
'bits_per_channel' |
<default> |
8 |
integer |
pre-defined |
The value is not used, so a default value is returned. |
'board_type' |
<board_type> |
|
integer |
dynamic |
Current board type. |
'camera_type' |
'<configuration>' |
'M_DEFAULT' |
string |
pre-defined |
Current camera type. |
'cc1_select' |
'default', 'grab_exposure', 'pixclk', 'user_bit_cc_a', 'user_bit_cc_b', 'hsync', 'vsync'
|
|
string |
dynamic |
Assign a particular signal to Camera Link cc1 line. |
'cc2_select' |
'default', 'grab_exposure', 'pixclk', 'user_bit_cc_a', 'user_bit_cc_b', 'hsync', 'vsync'
|
|
string |
dynamic |
Assign a particular signal to Camera Link cc2 line. |
'cc3_select' |
'default', 'grab_exposure', 'pixclk', 'user_bit_cc_a', 'user_bit_cc_b', 'hsync', 'vsync'
|
|
string |
dynamic |
Assign a particular signal to Camera Link cc3 line. |
'cc4_select' |
'default', 'grab_exposure', 'pixclk', 'user_bit_cc_a', 'user_bit_cc_b', 'hsync', 'vsync'
|
|
string |
dynamic |
Assign a particular signal to Camera Link cc4 line. |
'color_space' |
'gray', 'rgb' |
'gray' |
string |
pre-defined |
Desired color space and thus the number of image channels of the resulting HALCON image.
|
'continuous_grabbing' |
'disable', 'enable' |
'disable' |
string |
pre-defined |
Continuous grabbing mode. |
'current_buffer_index' |
0 ... <num_buffers>-1 |
|
integer |
dynamic |
Index of the current image buffer. |
'device' |
'<BoardType>:<nr>[:DIG:<nr>]' |
'0' |
string |
pre-defined |
Current type of the frame grabber board. |
'exposure_time' |
<nanoseconds> |
|
integer |
dynamic |
Time (in nanoseconds) for the active portion of the exposure signal (that is, the exposure time).
|
'exposure_time_delay' |
<nanoseconds> |
|
integer |
dynamic |
Delay (in nanoseconds) between the trigger and the start of exposure. Note, that an error is returned if the specified delay cannot be generated.
|
'external_trigger' |
'false', 'true' |
'false' |
string |
pre-defined |
Status of the external trigger. |
'field' |
'<default>' |
'interlaced' |
string |
pre-defined |
The value is not used, so a default value is returned. |
'generic' |
'', 'num_buffers=<num>', -1 |
-1 |
mixed |
pre-defined |
Values of the Generic parameter. |
'gpio_format:XX' |
'default', 'disable', 'enable', 'lvds', 'opto', 'tri-state', 'ttl' |
|
string |
dynamic |
Format of the specified GPIO signal (with XX = 0, 1, ..., 15 as unique index of the desired GPIO line).
|
'gpio_mode:XX' |
'default', 'input', 'output' |
|
string |
dynamic |
Controls the direction of the specified GPIO signal (with XX = 0, 1, ..., 15 as unique index of the desired GPIO line).
|
'gpio_read:XX' |
0, 1 |
|
integer |
dynamic |
Current state of the specified GPIO input (with XX = 0, 1, ..., 15 as unique index of the desired GPIO line).
|
'grab_timeout' |
<milliseconds> |
5000 |
integer |
pre-defined |
Current grab timeout in milliseconds. |
'horizontal_resolution' |
<resolution> |
|
integer |
pre-defined |
Current value of horizontal resolution. |
'image_height' |
<height> |
|
integer |
pre-defined |
Dynamically change the current image height of the grabbed image. Note that by changing this value, all active image grabs are
cancelled.
|
'image_width' |
<width> |
|
integer |
pre-defined |
Dynamically change the current image width of the grabbed image. Note that by changing this value, all active image grabs are
cancelled.
|
'line_in' |
<default> |
0 |
integer |
pre-defined |
The value is not used, so a default value is returned. |
'name' |
'MILLite' |
|
string |
pre-defined |
Name of the HALCON interface. |
'port' |
<port> |
-1 |
integer |
pre-defined |
Current port number. |
'revision' |
'<revision>' |
|
string |
pre-defined |
Revision number of the MILLite interface. |
'rotary_counter' |
'false', 'true' |
'false' |
string |
pre-defined |
Activate/deactivate the rotary counter. |
'rotary_counter_direction' |
'backward', 'forward' |
'forward' |
string |
pre-defined |
Direction of the rotary counter, i.e. the rotary counter gets incremented for a value of 'forward', or decremented for a value of
'backward', respectively.
|
'rotary_counter_position' |
<position> |
|
integer |
dynamic |
Current value of the rotary counter. |
'rotary_counter_trigger_position' |
0, ..., 65535 |
|
integer |
dynamic |
Rotary counter value upon which a trigger is generated. |
'start_async_after_grab_async' |
'disable', 'enable' |
'enable' |
string |
pre-defined |
Status of 'start_async_after_grab_async'. |
'start_column' |
0, <max_column> |
|
integer |
pre-defined |
Returns the current start column of the HALCON image. |
'start_field' |
'default', 'even', 'next', 'odd' |
'default' |
string |
pre-defined |
Field that the grabbing of a frame starts with. |
'start_row' |
0, <max_row> |
|
integer |
pre-defined |
Returns the current start row of the HALCON image. |
'trigger_mode' |
'software', 'exposure' |
|
string, integer |
dynamic |
The parameter 'trigger_mode' specifies the mode of the trigger signal released by the parameter 'do_force_trigger'. If the option 'software' is
selected, a signal to trigger the grab of an image will be released. With
the option 'exposure' an exposure trigger signal for the specified exposure
timer will be released when calling parameter 'do_force_trigger'. It's
also possible to pass an integer value in case that a special trigger mode
should be used. For the supported integer values (defines), please have a
look at the chapter 'MdigControl' in the MIL Help documentaion. Any mode
that has to be enabled with 'M_ACTIVE' is supported.
|
'trigger_signal' |
'default', 'falling', 'high', 'low', 'rising' |
|
string |
dynamic |
Type of input trigger. |
'trigger_source' |
'default', 'hw_port_camera', 'hw_port0', ..., 'hw_port11', 'none', 'rotary_counter', 'software', 'timer1', 'timer2'
|
|
string |
dynamic |
Defines the source of the input trigger. For details, please see the documentation of your frame grabber board.
|
'vertical_resolution' |
<resolution> |
|
integer |
pre-defined |
Current value of vertical resolution. |
Not supported by this interface.
Not supported by this interface.
All actually supported callback types of a specific image acquisition device can be queried by calling
get_framegrabber_param with the parameter
'available_callback_types'. Once the callback is registered, on every
occurrence of the underlying event (e.g., the notification that the
exposure has finished) the specified callback function will be called. If
the callback function is set to NULL, the corresponding callback will be
unregistered.
The signature of the callback function is
Herror (__stdcall *HAcqCallback)(void *AcqHandle, void *Context,
void *UserContext) and uses the following parameters:
- AcqHandle
Acquisition handle of the corresponding image acquisition instance.
- Context
Optional context data of the specific callback. In the
MILLite interface, this parameter is not used, i.e., Context
is set to NULL.
- UserContext
User context as set via set_framegrabber_callback.
Using user-callback functions
Note that the execution time of a user-specific callback function should
always be as short as possible since during the execution of a callback
function the handling of further internal callbacks might be blocked.
This can be achieved by removing the current processing from the
user-specific callback function to a separate thread that is controlled via
signals or events.
Not supported by this interface.
Not supported by this interface.