Skip to content

open_scene_engineOpenSceneEngineOpenSceneEngineopen_scene_engineT_open_scene_engine🔗

Short description🔗

open_scene_engineOpenSceneEngineOpenSceneEngineopen_scene_engineT_open_scene_engine — Start and connect to the Scene Engine synthetic data generator.

Signature🔗

open_scene_engine( attribute.name GenParamName, attribute.value GenParamValue, out scene_engine SceneEngine )void OpenSceneEngine( const HTuple& GenParamName, const HTuple& GenParamValue, HTuple* SceneEngine )static void HOperatorSet.OpenSceneEngine( HTuple genParamName, HTuple genParamValue, out HTuple sceneEngine )def open_scene_engine( gen_param_name: MaybeSequence[str], gen_param_value: MaybeSequence[Union[str, float, int]] ) -> HHandle

Herror T_open_scene_engine( const Htuple GenParamName, const Htuple GenParamValue, Htuple* SceneEngine )

void HSceneEngine::HSceneEngine( const HTuple& GenParamName, const HTuple& GenParamValue )

void HSceneEngine::HSceneEngine( const HString& GenParamName, const HString& GenParamValue )

void HSceneEngine::HSceneEngine( const char* GenParamName, const char* GenParamValue )

void HSceneEngine::HSceneEngine( const wchar_t* GenParamName, const wchar_t* GenParamValue ) (Windows only)

public HSceneEngine( HTuple genParamName, HTuple genParamValue )

public HSceneEngine( string genParamName, string genParamValue )

static HSceneEngine HDeepMatching3D::OpenSceneEngine( const HTuple& GenParamName, const HTuple& GenParamValue )

static HSceneEngine HDeepMatching3D::OpenSceneEngine( const HString& GenParamName, const HString& GenParamValue )

static HSceneEngine HDeepMatching3D::OpenSceneEngine( const char* GenParamName, const char* GenParamValue )

static HSceneEngine HDeepMatching3D::OpenSceneEngine( const wchar_t* GenParamName, const wchar_t* GenParamValue ) (Windows only)

static HSceneEngine HDeepMatching3D.OpenSceneEngine( HTuple genParamName, HTuple genParamValue )

static HSceneEngine HDeepMatching3D.OpenSceneEngine( string genParamName, string genParamValue )

Description🔗

The operator open_scene_engineOpenSceneEngine starts the executable of the synthetic data generation tool Scene Engine and connects to the started instance. Starting and connecting the Scene Engine can be configured using the generic parameters GenParamNamegenParamNamegen_param_name and GenParamValuegenParamValuegen_param_value, which are described further below.

The executable is terminated when the handle returned in SceneEnginesceneEnginescene_engine is cleared. This is typically the case once no tuple contains that handle. To terminate the executable manually, use clear_handleClearHandle to clear the SceneEnginesceneEnginescene_engine-Handle.

Location of the executable🔗

The operator looks for the executable at the following locations, using the first matching location.

  1. The generic parameter 'executable'"executable" (see below).

  2. The environment variable HALCON_SCENE_ENGINE, which is typically set during installation. Note that the value of HALCON_SCENE_ENGINE must end with '/scene_engine'"/scene_engine" (on Linux) or '/scene_engine.exe'"/scene_engine.exe" (on Windows).

  3. The file 'run_scene_engine.sh'"run_scene_engine.sh" (on Linux) or 'scene_engine.exe'"scene_engine.exe" (on Windows) in the default installation path $HALCONROOT/../SceneEngine-26.05.

Note that a proper installation of the executable is required, e.g. using the MVTec Software Manager (SOM). Most notable, it must be able to find its dynamic link libraries. On Linux, this requires extending the value of the environment variable LD_LIBRARY_PATH with the /lib directory from the Scene Engine installation:

LD_LIBRARY_PATH=/path/to/SceneEngine/lib:$LD_LIBRARY_PATH

Alternatively, the script 'run_scene_engine.sh'"run_scene_engine.sh" from the Scene Engine installation can be used as value of the generic parameter 'executable'"executable" (see below).

Location of assets🔗

Assets are 3D models, textures and environment maps that are used to add variation to the generated images, as well as to make them more realistic. Note that assets need to be installed beforehand, using for example the MVTec Software Manager (SOM). The path to the assets must be set in the environment variable HALCON_ASSET_DIR. Alternatively, the path to the assets can be set using set_scene_engine_paramSetSceneEngineParam. To check if assets were correctly found by the Scene Engine, use get_scene_engine_paramGetSceneEngineParam with the parameter 'assets'"assets".

Generic Parameters🔗

The operator supports the following additional parameters, which can be set by passing a pair of tuples to GenParamNamegenParamNamegen_param_name and GenParamValuegenParamValuegen_param_value which contain the parameter names and values, respectively.

  • 'debug_log_file'"debug_log_file": A string that specifies the filename and location of a debug file, for example 'c:/temp/scene_engine.log'"c:/temp/scene_engine.log". If set, the opened Scene Engine instance creates the corresponding file and writes debug information into it.

  • 'executable'"executable": A string containing the location of the executable to be started. Note that the value of 'executable'"executable" must end with '/scene_engine'"/scene_engine" (on Linux) or '/scene_engine.exe'"/scene_engine.exe" (on Windows). On Linux, it is also possible to use the script 'run_scene_engine.sh'"run_scene_engine.sh" from the Scene Engine installation as value of 'executable'"executable", as long as its full path is specified. This script helps set the correct environment variables.

    Default: See above for the default search locations.

  • 'timeout'"timeout": After starting the executable, the operator will wait this many seconds for the executable to connect. If the executable does not start up within that time, an error is returned. Setting the timeout to 00 disables the timeout.

    Default: 60.060.0

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters🔗

GenParamNamegenParamNamegen_param_name (input_control) attribute.name(-array) → (string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)

Names of parameters.

Default: [][]
Suggested values: 'debug_log_file', 'executable', 'timeout'"debug_log_file", "executable", "timeout"

GenParamValuegenParamValuegen_param_value (input_control) attribute.value(-array) → (string / real / integer)HTuple (HString / double / Hlong)HTuple (string / double / int / long)MaybeSequence[Union[str, float, int]]Htuple (char* / double / Hlong)

Values of parameters.

Default: [][]
Suggested values: 'c:/temp/scene_engine.log', '/tmp/scene_engine.log', 'scene_engine', 'scene_engine.exe', 10.0, 0"c:/temp/scene_engine.log", "/tmp/scene_engine.log", "scene_engine", "scene_engine.exe", 10.0, 0

SceneEnginesceneEnginescene_engine (output_control) scene_engine → (handle)HTuple (HHandle)HSceneEngine, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the Scene Engine connection.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible successors

set_scene_engine_paramSetSceneEngineParam, run_scene_engineRunSceneEngine

Alternatives

render_object_model_3dRenderObjectModel3d, disp_object_model_3dDispObjectModel3d

See also

create_deep_matching_3dCreateDeepMatching3d

Module🔗

3D Metrology