set_calib_data_calib_objectSetCalibDataCalibObjectSetCalibDataCalibObjectset_calib_data_calib_objectT_set_calib_data_calib_object🔗

Short description🔗

set_calib_data_calib_objectSetCalibDataCalibObjectSetCalibDataCalibObjectset_calib_data_calib_objectT_set_calib_data_calib_object — Define a calibration object in a calibration model.

Signature🔗

set_calib_data_calib_object( calib_data CalibDataID, number CalibObjIdx, number CalibObjDescr )

Description🔗

The operator set_calib_data_calib_objectSetCalibDataCalibObject defines the calibration object with the index CalibObjIdxcalibObjIdxcalib_obj_idx in the camera calibration data model CalibDataIDcalibDataIDcalib_data_id. The index must be between 0 and NumCalibObjectsnumCalibObjectsnum_calib_objects-1 (NumCalibObjectsnumCalibObjectsnum_calib_objects is specified during model creation with create_calib_dataCreateCalibData and can be queried with get_calib_dataGetCalibData).

If a calibration object description with index CalibObjIdxcalibObjIdxcalib_obj_idx is already defined, then the current object description overwrites it (the description is ‘substituted’). Note that all NumCalibObjectsnumCalibObjectsnum_calib_objects calibration objects must be set to perform calibrate_camerasCalibrateCameras.

The parameter CalibObjDescrcalibObjDescrcalib_obj_descr can be used in two ways:

as a file name: it specifies a calibration plate description file as created with create_caltabCreateCaltab or gen_caltabGenCaltab.
as a numerical tuple: it specifies the 3D coordinates of all points of the calibration object. All X, Y, and Z coordinates, respectively, of all points must be packed sequentially in the tuple in form: [X, Y, Z], i.e., [X1, ..., Xn, Y1, ..., Yn, Z1, ..., Zn], where |X| = |Y| = |Z| and all coordinates are in meters.

To query the calibration objects parameters stored earlier in a calibration data model, use get_calib_dataGetCalibData.

To get detailed information about the calibration process of your camera setup see the chapter Calibration.

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 modifies the state of the following input parameter:

CalibDataIDcalibDataIDcalib_data_id

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters🔗

CalibDataIDcalibDataIDcalib_data_id (input_control, state is modified) calib_data → (handle)HTuple (HHandle)HCalibData, HTuple (IntPtr)HHandleHtuple (handle)

Handle of a calibration data model.

CalibObjIdxcalibObjIdxcalib_obj_idx (input_control) number → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Calibration object index.

Default: 00
Suggested values: 0, 1, 20, 1, 2

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

3D point coordinates or a description file name.

List of values: 'calplate.cpd', 'calplate_10mm.cpd', 'calplate_1200mm.cpd', 'calplate_160mm.cpd', 'calplate_20mm.cpd', 'calplate_20mm_dark_on_light.cpd', 'calplate_320mm.cpd', 'calplate_40mm.cpd', 'calplate_40mm_dark_on_light.cpd', 'calplate_5mm.cpd', 'calplate_640mm.cpd', 'calplate_80mm.cpd', 'calplate_80mm_dark_on_light.cpd', 'caltab.descr', 'caltab_100mm.descr', 'caltab_10mm.descr', 'caltab_200mm.descr', 'caltab_2500um.descr', 'caltab_30mm.descr', 'caltab_650um.descr', 'caltab_6mm.descr', 'caltab_800mm.descr', 'caltab_big.descr', 'caltab_small.descr'

Combinations with other operators🔗

Combinations

Possible predecessors

create_calib_dataCreateCalibData, set_calib_data_cam_paramSetCalibDataCamParam

Possible successors

set_calib_data_cam_paramSetCalibDataCamParam, set_calib_data_observ_pointsSetCalibDataObservPoints, find_calib_objectFindCalibObject

Module🔗

Calibration