Operator Reference

HALCON Operator Reference / 3D Matching / Deep 3D Matching

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

set_scene_engine_paramT_set_scene_engine_paramSetSceneEngineParamSetSceneEngineParamset_scene_engine_param (Operator)

set_scene_engine_paramT_set_scene_engine_paramSetSceneEngineParamSetSceneEngineParamset_scene_engine_param — Sets a parameter of a running Scene Engine instance.

Signature

set_scene_engine_param( : : SceneEngine, GenParamName, GenParamValue : )

Herror T_set_scene_engine_param(const Htuple SceneEngine, const Htuple GenParamName, const Htuple GenParamValue)

void SetSceneEngineParam(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 HOperatorSet.SetSceneEngineParam(HTuple sceneEngine, HTuple genParamName, HTuple genParamValue)

static void HDeepMatching3D.SetSceneEngineParam(HSceneEngine sceneEngine, string genParamName, HTuple genParamValue)

static void HDeepMatching3D.SetSceneEngineParam(HSceneEngine sceneEngine, string genParamName, string genParamValue)

def set_scene_engine_param(scene_engine: HHandle, gen_param_name: str, gen_param_value: HTupleType) -> None

Description

The operator set_scene_engine_paramset_scene_engine_paramSetSceneEngineParamSetSceneEngineParamset_scene_engine_param sets a parameter of the running Scene Engine instance SceneEngineSceneEngineSceneEnginesceneEnginescene_engine. The parameter name is specified in GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name, the corresponding value in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value.

The following parameter names are supported:

• 'asset_path'"asset_path""asset_path""asset_path""asset_path": A string containing the path of the asset library. See open_scene_engineopen_scene_engineOpenSceneEngineOpenSceneEngineopen_scene_engine 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'"HALCON_ASSET_DIR""HALCON_ASSET_DIR""HALCON_ASSET_DIR""HALCON_ASSET_DIR".

  Default: The value of the environment variable 'HALCON_ASSET_DIR'"HALCON_ASSET_DIR""HALCON_ASSET_DIR""HALCON_ASSET_DIR""HALCON_ASSET_DIR"

• 'select_device_idx'"select_device_idx""select_device_idx""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_paramget_scene_engine_paramGetSceneEngineParamGetSceneEngineParamget_scene_engine_param with parameter 'devices'"devices""devices""devices""devices".

  Note that the device must be selected before the first call to run_scene_enginerun_scene_engineRunSceneEngineRunSceneEnginerun_scene_engine. It is not possible to change the device of a running Scene Engine instance after the first call to run_scene_enginerun_scene_engineRunSceneEngineRunSceneEnginerun_scene_engine.

  Default: By default, the scene engine uses the first available device (0).

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

SceneEngineSceneEngineSceneEnginesceneEnginescene_engine (input_control)  scene_engine → HSceneEngine, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the Scene Engine connection.

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  attribute.name → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Names of parameters.

Default: 'asset_path' "asset_path" "asset_path" "asset_path" "asset_path"

Suggested values: 'asset_path'"asset_path""asset_path""asset_path""asset_path", 'select_device_idx'"select_device_idx""select_device_idx""select_device_idx""select_device_idx"

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control)  attribute.value(-array) → HTupleHTupleTypeHTupleHtuple (string / real / integer / handle) (string / double / int / long / HHandle) (HString / double / Hlong / HHandle) (char* / double / Hlong / handle)

Values of parameters.

Default: []

Suggested values:

Result

If the parameters are valid, the operator set_scene_engine_paramset_scene_engine_paramSetSceneEngineParamSetSceneEngineParamset_scene_engine_param returns the value 2 ( H_MSG_TRUE) . If necessary, an exception is raised.

Possible Predecessors

open_scene_engineopen_scene_engineOpenSceneEngineOpenSceneEngineopen_scene_engine, get_scene_engine_paramget_scene_engine_paramGetSceneEngineParamGetSceneEngineParamget_scene_engine_param

Possible Successors

run_scene_enginerun_scene_engineRunSceneEngineRunSceneEnginerun_scene_engine, get_scene_engine_paramget_scene_engine_paramGetSceneEngineParamGetSceneEngineParamget_scene_engine_param

See also

create_deep_matching_3dcreate_deep_matching_3dCreateDeepMatching3dCreateDeepMatching3dcreate_deep_matching_3d, get_scene_engine_paramget_scene_engine_paramGetSceneEngineParamGetSceneEngineParamget_scene_engine_param

Module

3D Metrology

---

ClassesClasses | | Operators