Operator Reference

HALCON Operator Reference / 3D Reconstruction / Sheet of Light
ClassesClasses | | Operators

get_sheet_of_light_paramT_get_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParamget_sheet_of_light_param (Operator)

get_sheet_of_light_paramT_get_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParamget_sheet_of_light_param — Get the value of a parameter, which has been set in a sheet-of-light model.

Signature

get_sheet_of_light_param( : : SheetOfLightModelID, GenParamName : GenParamValue)

Herror T_get_sheet_of_light_param(const Htuple SheetOfLightModelID, const Htuple GenParamName, Htuple* GenParamValue)

void GetSheetOfLightParam(const HTuple& SheetOfLightModelID, const HTuple& GenParamName, HTuple* GenParamValue)

HTuple HSheetOfLightModel::GetSheetOfLightParam(const HString& GenParamName) const

HTuple HSheetOfLightModel::GetSheetOfLightParam(const char* GenParamName) const

HTuple HSheetOfLightModel::GetSheetOfLightParam(const wchar_t* GenParamName) const   ( Windows only)

static void HOperatorSet.GetSheetOfLightParam(HTuple sheetOfLightModelID, HTuple genParamName, out HTuple genParamValue)

HTuple HSheetOfLightModel.GetSheetOfLightParam(string genParamName)

def get_sheet_of_light_param(sheet_of_light_model_id: HHandle, gen_param_name: str) -> Sequence[Union[int, float, str]]

def get_sheet_of_light_param_s(sheet_of_light_model_id: HHandle, gen_param_name: str) -> Union[int, float, str]

Description

The operator get_sheet_of_light_paramget_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParamget_sheet_of_light_param is used to query the values of the different parameters of a sheet-of-light model. The names of the desired parameters are passed in the generic parameter GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name, the corresponding values are returned in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value.

It is not possible to query the values of several parameters with a single operator call. In order to request the values of several parameters you have to successively call of the operator get_sheet_of_light_paramget_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParamget_sheet_of_light_param.

The possible parameters are listed and described in set_sheet_of_light_paramset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParamset_sheet_of_light_param.

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

SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelIDsheet_of_light_model_id (input_control)  sheet_of_light_model → HSheetOfLightModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the sheet-of-light model.

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

Name of the generic parameter that shall be queried.

Default: 'method' "method" "method" "method" "method"

List of values: 'ambiguity_solving'"ambiguity_solving""ambiguity_solving""ambiguity_solving""ambiguity_solving", 'calibration'"calibration""calibration""calibration""calibration", 'camera_parameter'"camera_parameter""camera_parameter""camera_parameter""camera_parameter", 'camera_pose'"camera_pose""camera_pose""camera_pose""camera_pose", 'lightplane_pose'"lightplane_pose""lightplane_pose""lightplane_pose""lightplane_pose", 'method'"method""method""method""method", 'min_gray'"min_gray""min_gray""min_gray""min_gray", 'movement_pose'"movement_pose""movement_pose""movement_pose""movement_pose", 'num_profiles'"num_profiles""num_profiles""num_profiles""num_profiles", 'offset_x'"offset_x""offset_x""offset_x""offset_x", 'offset_y'"offset_y""offset_y""offset_y""offset_y", 'offset_z'"offset_z""offset_z""offset_z""offset_z", 'scale'"scale""scale""scale""scale", 'scale_x'"scale_x""scale_x""scale_x""scale_x", 'scale_y'"scale_y""scale_y""scale_y""scale_y", 'scale_z'"scale_z""scale_z""scale_z""scale_z", 'score_type'"score_type""score_type""score_type""score_type"

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_control)  attribute.value(-array) → HTupleSequence[Union[int, float, str]]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

Value of the model parameter that shall be queried.

Result

The operator get_sheet_of_light_paramget_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParamget_sheet_of_light_param returns the value 2 ( H_MSG_TRUE) if the given parameters are correct. Otherwise, an exception will be raised.

Possible Predecessors

query_sheet_of_light_paramsquery_sheet_of_light_paramsQuerySheetOfLightParamsQuerySheetOfLightParamsquery_sheet_of_light_params, set_sheet_of_light_paramset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParamset_sheet_of_light_param

Possible Successors

measure_profile_sheet_of_lightmeasure_profile_sheet_of_lightMeasureProfileSheetOfLightMeasureProfileSheetOfLightmeasure_profile_sheet_of_light, set_sheet_of_light_paramset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParamset_sheet_of_light_param, apply_sheet_of_light_calibrationapply_sheet_of_light_calibrationApplySheetOfLightCalibrationApplySheetOfLightCalibrationapply_sheet_of_light_calibration

Module

3D Metrology

ClassesClasses | | Operators