set_scene_engine_paramset_scene_engine_paramSetSceneEngineParamSetSceneEngineParamset_scene_engine_paramT_set_scene_engine_param
Short description
set_scene_engine_paramset_scene_engine_paramSetSceneEngineParamSetSceneEngineParamset_scene_engine_paramT_set_scene_engine_param — Set parameters of a running Scene Engine instance.
Signature
set_scene_engine_param( scene_engine SceneEngine, attribute.name GenParamName, attribute.value GenParamValue )set_scene_engine_param( : : SceneEngine, GenParamName, GenParamValue : )void SetSceneEngineParam( const HTuple& SceneEngine, const HTuple& GenParamName, const HTuple& GenParamValue )static void HOperatorSet.SetSceneEngineParam( HTuple sceneEngine, HTuple genParamName, HTuple genParamValue )def set_scene_engine_param( scene_engine: HHandle, gen_param_name: str, gen_param_value: HTupleType ) -> None
Herror T_set_scene_engine_param( const Htuple SceneEngine, const Htuple GenParamName, const Htuple GenParamValue )
static void HDeepMatching3D::SetSceneEngineParam( const HSceneEngine& SceneEngine, const HString& GenParamName, const HTuple& GenParamValue )
static void HDeepMatching3D::SetSceneEngineParam( const HSceneEngine& SceneEngine, const HString& GenParamName, const HString& GenParamValue )
static void HDeepMatching3D::SetSceneEngineParam( const HSceneEngine& SceneEngine, const char* GenParamName, const char* GenParamValue )
static void HDeepMatching3D::SetSceneEngineParam( const HSceneEngine& SceneEngine, const wchar_t* GenParamName, const wchar_t* GenParamValue ) (Windows only)
static void HDeepMatching3D.SetSceneEngineParam( HSceneEngine sceneEngine, string genParamName, HTuple genParamValue )
static void HDeepMatching3D.SetSceneEngineParam( HSceneEngine sceneEngine, string genParamName, string genParamValue )
Description
The operator set_scene_engine_paramSetSceneEngineParam sets a parameter
of the running Scene Engine instance SceneEnginesceneEnginescene_engine.
The parameter name is specified in GenParamNamegenParamNamegen_param_name, the
corresponding value in GenParamValuegenParamValuegen_param_value.
The following parameters are supported:
-
'asset_path'"asset_path": A string containing the path of the
asset library. See open_scene_engineOpenSceneEngine for a description
of the assets. When starting a new Scene Engine, the path is
by default set to the value of the environment variable
HALCON_ASSET_DIR.
Default: The value of the environment variable
HALCON_ASSET_DIR
-
'select_device_idx'"select_device_idx":
An integer that selects the device (GPU) to be used for rendering
data during the data generation.
The index is the entry in the list returned by
get_scene_engine_paramGetSceneEngineParam with parameter 'devices'"devices".
Note that the device must be selected before the first call
of run_scene_engineRunSceneEngine. It is not possible to change the
device of a running Scene Engine instance after the first call of
run_scene_engineRunSceneEngine.
Default: 00
Execution information
-
Multithreading type: reentrant (runs in parallel with non-exclusive operators).
-
Multithreading scope: global (may be called from any thread).
-
Processed without parallelization.
Parameters
SceneEnginesceneEnginescene_engine (input_control) scene_engine → (handle)(handle)HTuple (HHandle)HSceneEngine, HTuple (IntPtr)HHandleHtuple (handle)
Handle of the Scene Engine connection.
GenParamNamegenParamNamegen_param_name (input_control) attribute.name → (string)(string)HTuple (HString)HTuple (string)strHtuple (char*)
Names of parameters.
Default: 'asset_path'"asset_path"
Suggested values: 'asset_path', 'select_device_idx'"asset_path", "select_device_idx"
GenParamValuegenParamValuegen_param_value (input_control) attribute.value(-array) → (string / real / integer / handle)(string / real / integer / handle)HTuple (HString / double / Hlong / HHandle)HTuple (string / double / int / long / HHandle)HTupleTypeHtuple (char* / double / Hlong / handle)
Values of parameters.
Default: [][]
Result
If the parameters are valid, the operator set_scene_engine_paramSetSceneEngineParam
returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.
Combinations with other operators
Combinations
Possible predecessors
open_scene_engineOpenSceneEngine, get_scene_engine_paramGetSceneEngineParam
Possible successors
run_scene_engineRunSceneEngine, get_scene_engine_paramGetSceneEngineParam
See also
create_deep_matching_3dCreateDeepMatching3d, get_scene_engine_paramGetSceneEngineParam
Module
3D Metrology