Operator Reference

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

get_sheet_of_light_resultT_get_sheet_of_light_resultGetSheetOfLightResultGetSheetOfLightResultget_sheet_of_light_result (Operator)

get_sheet_of_light_resultT_get_sheet_of_light_resultGetSheetOfLightResultGetSheetOfLightResultget_sheet_of_light_result — Get the iconic results of a measurement performed with the sheet-of light technique.

Signature

get_sheet_of_light_result( : ResultValue : SheetOfLightModelID, ResultName : )

Herror T_get_sheet_of_light_result(Hobject* ResultValue, const Htuple SheetOfLightModelID, const Htuple ResultName)

void GetSheetOfLightResult(HObject* ResultValue, const HTuple& SheetOfLightModelID, const HTuple& ResultName)

void HImage::GetSheetOfLightResult(const HSheetOfLightModel& SheetOfLightModelID, const HTuple& ResultName)

void HImage::GetSheetOfLightResult(const HSheetOfLightModel& SheetOfLightModelID, const HString& ResultName)

void HImage::GetSheetOfLightResult(const HSheetOfLightModel& SheetOfLightModelID, const char* ResultName)

void HImage::GetSheetOfLightResult(const HSheetOfLightModel& SheetOfLightModelID, const wchar_t* ResultName)   ( Windows only)

HImage HSheetOfLightModel::GetSheetOfLightResult(const HTuple& ResultName) const

HImage HSheetOfLightModel::GetSheetOfLightResult(const HString& ResultName) const

HImage HSheetOfLightModel::GetSheetOfLightResult(const char* ResultName) const

HImage HSheetOfLightModel::GetSheetOfLightResult(const wchar_t* ResultName) const   ( Windows only)

static void HOperatorSet.GetSheetOfLightResult(out HObject resultValue, HTuple sheetOfLightModelID, HTuple resultName)

void HImage.GetSheetOfLightResult(HSheetOfLightModel sheetOfLightModelID, HTuple resultName)

void HImage.GetSheetOfLightResult(HSheetOfLightModel sheetOfLightModelID, string resultName)

HImage HSheetOfLightModel.GetSheetOfLightResult(HTuple resultName)

HImage HSheetOfLightModel.GetSheetOfLightResult(string resultName)

def get_sheet_of_light_result(sheet_of_light_model_id: HHandle, result_name: MaybeSequence[str]) -> HObject

Description

The operator get_sheet_of_light_resultget_sheet_of_light_resultGetSheetOfLightResultGetSheetOfLightResultget_sheet_of_light_result provides access to the results of the calibrated and uncalibrated measurements performed with a given sheet-of-light model. The different kinds of results can be selected by setting the value of the parameter ResultNameResultNameResultNameresultNameresult_name as described below:

Non-calibrated results:

'disparity'"disparity""disparity""disparity""disparity":

the measured disparity i.e., the subpixel row value at which the profile was detected is returned for each pixel. The disparity values can be considered as non-calibrated pseudo-range values.

'score'"score""score""score""score":

the score values computed according to the value of the parameter 'score_type'"score_type""score_type""score_type""score_type" is returned. If the parameter 'score_type'"score_type""score_type""score_type""score_type" has been set to 'none'"none""none""none""none", no score value is computed during the measurement, therefore the returned image is empty. Refer to create_sheet_of_light_modelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModelcreate_sheet_of_light_model and set_sheet_of_light_paramset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParamset_sheet_of_light_param for details on the possible values of the model parameter 'score_type'"score_type""score_type""score_type""score_type".

Calibrated results:

'x'"x""x""x""x":

The calibrated X-coordinates of the reconstructed surface is returned as an image.

'y'"y""y""y""y":

The calibrated Y-coordinates of the reconstructed surface is returned as an image.

'z'"z""z""z""z":

The calibrated Z-coordinates of the reconstructed surface is returned as an image.

Please, note that the pixel values of the images returned when setting ResultNameResultNameResultNameresultNameresult_name to 'x'"x""x""x""x", 'y'"y""y""y""y" or 'z'"z""z""z""z" have the semantic of coordinates with respect to the world coordinate system that is implicitly defined during the calibration of the system. The unit of the returned coordinates depends on the value of the parameter 'scale'"scale""scale""scale""scale". (see create_sheet_of_light_modelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModelcreate_sheet_of_light_model and set_sheet_of_light_paramset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParamset_sheet_of_light_param for details on the possible values of the model parameter 'scale'"scale""scale""scale""scale".)

The operator get_sheet_of_light_resultget_sheet_of_light_resultGetSheetOfLightResultGetSheetOfLightResultget_sheet_of_light_result returns an empty object if the desired result has not been computed.

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

ResultValueResultValueResultValueresultValueresult_value (output_object)  singlechannelimage → objectHImageHObjectHObjectHobject * (real)

Desired measurement result.

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

Handle of the sheet-of-light model to be used.

ResultNameResultNameResultNameresultNameresult_name (input_control)  string(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Specify which result of the measurement shall be provided.

Default: 'disparity' "disparity" "disparity" "disparity" "disparity"

List of values: 'disparity'"disparity""disparity""disparity""disparity", 'score'"score""score""score""score", 'x'"x""x""x""x", 'y'"y""y""y""y", 'z'"z""z""z""z"

Result

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

Module

3D Metrology

ClassesClasses | | Operators