Operator Reference

HALCON Operator Reference / 3D Reconstruction / Sheet of Light

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

ClassesClasses | | Operators

query_sheet_of_light_paramsT_query_sheet_of_light_paramsQuerySheetOfLightParamsQuerySheetOfLightParamsquery_sheet_of_light_params (Operator)

query_sheet_of_light_paramsT_query_sheet_of_light_paramsQuerySheetOfLightParamsQuerySheetOfLightParamsquery_sheet_of_light_params — For a given sheet-of-light model get the names of the generic iconic or control parameters that can be used in the different sheet-of-light operators.

Signature

query_sheet_of_light_params( : : SheetOfLightModelID, QueryName : GenParamName)

Herror T_query_sheet_of_light_params(const Htuple SheetOfLightModelID, const Htuple QueryName, Htuple* GenParamName)

void QuerySheetOfLightParams(const HTuple& SheetOfLightModelID, const HTuple& QueryName, HTuple* GenParamName)

HTuple HSheetOfLightModel::QuerySheetOfLightParams(const HString& QueryName) const

HTuple HSheetOfLightModel::QuerySheetOfLightParams(const char* QueryName) const

HTuple HSheetOfLightModel::QuerySheetOfLightParams(const wchar_t* QueryName) const   ( Windows only)

static void HOperatorSet.QuerySheetOfLightParams(HTuple sheetOfLightModelID, HTuple queryName, out HTuple genParamName)

HTuple HSheetOfLightModel.QuerySheetOfLightParams(string queryName)

def query_sheet_of_light_params(sheet_of_light_model_id: HHandle, query_name: str) -> Sequence[str]

Description

The operator query_sheet_of_light_paramsquery_sheet_of_light_paramsQuerySheetOfLightParamsQuerySheetOfLightParamsquery_sheet_of_light_params returns the names of the generic parameters that are supported by the following operators create_sheet_of_light_modelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModelcreate_sheet_of_light_model, set_sheet_of_light_paramset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParamset_sheet_of_light_param, get_sheet_of_light_paramget_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParamget_sheet_of_light_param and get_sheet_of_light_resultget_sheet_of_light_resultGetSheetOfLightResultGetSheetOfLightResultget_sheet_of_light_result. The parameter QueryNameQueryNameQueryNamequeryNamequery_name is used to select the desired parameter group:

'create_model_params'"create_model_params""create_model_params""create_model_params""create_model_params":

create_sheet_of_light_modelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModelcreate_sheet_of_light_model - Parameters for adjusting the sheet-of-light model during its creation.

'set_model_params'"set_model_params""set_model_params""set_model_params""set_model_params":

set_sheet_of_light_paramset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParamset_sheet_of_light_param - Parameters for adjusting the parameters of an available sheet-of-light model.

'get_model_params'"get_model_params""get_model_params""get_model_params""get_model_params":

get_sheet_of_light_paramget_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParamget_sheet_of_light_param - Parameters for querying the values of the parameters of a sheet-of-light model.

'get_result_objects'"get_result_objects""get_result_objects""get_result_objects""get_result_objects":

get_sheet_of_light_resultget_sheet_of_light_resultGetSheetOfLightResultGetSheetOfLightResultget_sheet_of_light_result - Parameters for accessing the iconic objects resulting from the measurement.

The returned parameter list does not depend on the current state of the model or its results.

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.

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

Name of the parameter group.

Default: 'create_model_params' "create_model_params" "create_model_params" "create_model_params" "create_model_params"

List of values: 'create_model_params'"create_model_params""create_model_params""create_model_params""create_model_params", 'get_model_params'"get_model_params""get_model_params""get_model_params""get_model_params", 'get_result_objects'"get_result_objects""get_result_objects""get_result_objects""get_result_objects", 'set_model_params'"set_model_params""set_model_params""set_model_params""set_model_params"

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (output_control)  attribute.value-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

List containing the names of the supported generic parameters.

Result

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

Possible Successors

create_sheet_of_light_modelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModelcreate_sheet_of_light_model, set_sheet_of_light_paramset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParamset_sheet_of_light_param, get_sheet_of_light_paramget_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParamget_sheet_of_light_param, get_sheet_of_light_resultget_sheet_of_light_resultGetSheetOfLightResultGetSheetOfLightResultget_sheet_of_light_result

Module

3D Metrology

---

ClassesClasses | | Operators