Skip to content

get_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParamget_sheet_of_light_paramT_get_sheet_of_light_param🔗

Short description🔗

get_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParamget_sheet_of_light_paramT_get_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( sheet_of_light_model SheetOfLightModelID, attribute.name GenParamName, out attribute.value GenParamValue )void GetSheetOfLightParam( const HTuple& SheetOfLightModelID, const HTuple& GenParamName, HTuple* GenParamValue )static void HOperatorSet.GetSheetOfLightParam( HTuple sheetOfLightModelID, HTuple genParamName, out HTuple genParamValue )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]Herror T_get_sheet_of_light_param( 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)

HTuple HSheetOfLightModel.GetSheetOfLightParam( string genParamName )

Description🔗

The operator get_sheet_of_light_paramGetSheetOfLightParam 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 GenParamNamegenParamNamegen_param_name, the corresponding values are returned in GenParamValuegenParamValuegen_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_paramGetSheetOfLightParam.

The possible parameters are listed and described in set_sheet_of_light_paramSetSheetOfLightParam.

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.

Parameters🔗

SheetOfLightModelIDsheetOfLightModelIDsheet_of_light_model_id (input_control) sheet_of_light_model → (handle)HTuple (HHandle)HSheetOfLightModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the sheet-of-light model.

GenParamNamegenParamNamegen_param_name (input_control) attribute.name → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of the generic parameter that shall be queried.

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

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

Value of the model parameter that shall be queried.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

query_sheet_of_light_paramsQuerySheetOfLightParams, set_sheet_of_light_paramSetSheetOfLightParam

Possible successors

measure_profile_sheet_of_lightMeasureProfileSheetOfLight, set_sheet_of_light_paramSetSheetOfLightParam, apply_sheet_of_light_calibrationApplySheetOfLightCalibration

Module🔗

3D Metrology