get_compute_device_paramT_get_compute_device_paramGetComputeDeviceParamGetComputeDeviceParamget_compute_device_param (Operator)
Name
get_compute_device_paramT_get_compute_device_paramGetComputeDeviceParamGetComputeDeviceParamget_compute_device_param — Query compute device parameters.
Signature
Description
get_compute_device_paramget_compute_device_paramGetComputeDeviceParamGetComputeDeviceParamGetComputeDeviceParamget_compute_device_param returns parameters of the
compute device DeviceHandleDeviceHandleDeviceHandleDeviceHandledeviceHandledevice_handle for the current HALCON thread
in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value.
The following parameters can be queried (for more information
see set_compute_device_paramset_compute_device_paramSetComputeDeviceParamSetComputeDeviceParamSetComputeDeviceParamset_compute_device_param) by setting them for
GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name:
- 'alloc_pinned'"alloc_pinned""alloc_pinned""alloc_pinned""alloc_pinned""alloc_pinned"
-
If 'true'"true""true""true""true""true", the output image matrices of all operators
are created in page locked (so called 'pinned') memory.
- 'asynchronous_execution'"asynchronous_execution""asynchronous_execution""asynchronous_execution""asynchronous_execution""asynchronous_execution"
-
If 'true'"true""true""true""true""true", operators executed on the compute device
do not wait for the device computations to finish but
return after initiation the computations.
- 'buffer_cache_capacity'"buffer_cache_capacity""buffer_cache_capacity""buffer_cache_capacity""buffer_cache_capacity""buffer_cache_capacity"
-
Maximum size (in bytes) of the compute device buffer cache.
- 'buffer_cache_used'"buffer_cache_used""buffer_cache_used""buffer_cache_used""buffer_cache_used""buffer_cache_used"
-
Current size (in bytes) of the compute device buffer cache.
- 'image_cache_capacity'"image_cache_capacity""image_cache_capacity""image_cache_capacity""image_cache_capacity""image_cache_capacity"
-
Maximum size (in bytes) of the compute device image cache.
- 'image_cache_used'"image_cache_used""image_cache_used""image_cache_used""image_cache_used""image_cache_used"
-
Current size (in bytes) of the compute device image cache.
- 'pinned_mem_cache_capacity'"pinned_mem_cache_capacity""pinned_mem_cache_capacity""pinned_mem_cache_capacity""pinned_mem_cache_capacity""pinned_mem_cache_capacity"
-
Maximum size (in bytes) of the page locked (pinned) memory
cache.
- 'pinned_mem_cache_used'"pinned_mem_cache_used""pinned_mem_cache_used""pinned_mem_cache_used""pinned_mem_cache_used""pinned_mem_cache_used"
Current size (in bytes) of the page locked (pinned) memory
cache.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: local (may only be called from the same thread in which the window, model, or tool instance was created).
- Processed without parallelization.
Parameters
DeviceHandleDeviceHandleDeviceHandleDeviceHandledeviceHandledevice_handle (input_control) compute_device → HComputeDevice, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Compute device handle.
GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of the parameter to query.
Default value:
'buffer_cache_capacity'
"buffer_cache_capacity"
"buffer_cache_capacity"
"buffer_cache_capacity"
"buffer_cache_capacity"
"buffer_cache_capacity"
List of values: 'alloc_pinned'"alloc_pinned""alloc_pinned""alloc_pinned""alloc_pinned""alloc_pinned", 'asynchronous_execution'"asynchronous_execution""asynchronous_execution""asynchronous_execution""asynchronous_execution""asynchronous_execution", 'buffer_cache_capacity'"buffer_cache_capacity""buffer_cache_capacity""buffer_cache_capacity""buffer_cache_capacity""buffer_cache_capacity", 'buffer_cache_used'"buffer_cache_used""buffer_cache_used""buffer_cache_used""buffer_cache_used""buffer_cache_used", 'image_cache_capacity'"image_cache_capacity""image_cache_capacity""image_cache_capacity""image_cache_capacity""image_cache_capacity", 'image_cache_used'"image_cache_used""image_cache_used""image_cache_used""image_cache_used""image_cache_used", 'pinned_mem_cache_capacity'"pinned_mem_cache_capacity""pinned_mem_cache_capacity""pinned_mem_cache_capacity""pinned_mem_cache_capacity""pinned_mem_cache_capacity", 'pinned_mem_cache_used'"pinned_mem_cache_used""pinned_mem_cache_used""pinned_mem_cache_used""pinned_mem_cache_used""pinned_mem_cache_used"
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_control) string(-array) → HTupleSequence[Union[str, int, float]]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)
Value of the parameter.
Result
The operator get_compute_device_paramget_compute_device_paramGetComputeDeviceParamGetComputeDeviceParamGetComputeDeviceParamget_compute_device_param returns the
value TRUE if the parameters are correct. Otherwise
an exception will be raised.
Possible Predecessors
activate_compute_deviceactivate_compute_deviceActivateComputeDeviceActivateComputeDeviceActivateComputeDeviceactivate_compute_device
See also
set_compute_device_paramset_compute_device_paramSetComputeDeviceParamSetComputeDeviceParamSetComputeDeviceParamset_compute_device_param,
get_compute_device_infoget_compute_device_infoGetComputeDeviceInfoGetComputeDeviceInfoGetComputeDeviceInfoget_compute_device_info
Module
Foundation