set_calib_data_calib_objectT_set_calib_data_calib_objectSetCalibDataCalibObjectSetCalibDataCalibObjectset_calib_data_calib_object (Operator)

Name

set_calib_data_calib_objectT_set_calib_data_calib_objectSetCalibDataCalibObjectSetCalibDataCalibObjectset_calib_data_calib_object — Define a calibration object in a calibration model.

Signature

set_calib_data_calib_object( : : CalibDataID, CalibObjIdx, CalibObjDescr : )

Herror T_set_calib_data_calib_object(const Htuple CalibDataID, const Htuple CalibObjIdx, const Htuple CalibObjDescr)

void SetCalibDataCalibObject(const HTuple& CalibDataID, const HTuple& CalibObjIdx, const HTuple& CalibObjDescr)

void HCalibData::SetCalibDataCalibObject(Hlong CalibObjIdx, const HTuple& CalibObjDescr) const

void HCalibData::SetCalibDataCalibObject(Hlong CalibObjIdx, double CalibObjDescr) const

static void HOperatorSet.SetCalibDataCalibObject(HTuple calibDataID, HTuple calibObjIdx, HTuple calibObjDescr)

void HCalibData.SetCalibDataCalibObject(int calibObjIdx, HTuple calibObjDescr)

void HCalibData.SetCalibDataCalibObject(int calibObjIdx, double calibObjDescr)

def set_calib_data_calib_object(calib_data_id: HHandle, calib_obj_idx: int, calib_obj_descr: MaybeSequence[Union[float, int, str]]) -> None

Description

The operator set_calib_data_calib_objectset_calib_data_calib_objectSetCalibDataCalibObjectSetCalibDataCalibObjectSetCalibDataCalibObjectset_calib_data_calib_object defines the calibration object with the index CalibObjIdxCalibObjIdxCalibObjIdxCalibObjIdxcalibObjIdxcalib_obj_idx in the camera calibration data model CalibDataIDCalibDataIDCalibDataIDCalibDataIDcalibDataIDcalib_data_id. The index must be between 0 and NumCalibObjectsNumCalibObjectsNumCalibObjectsNumCalibObjectsnumCalibObjectsnum_calib_objects-1 (NumCalibObjectsNumCalibObjectsNumCalibObjectsNumCalibObjectsnumCalibObjectsnum_calib_objects is specified during model creation with create_calib_datacreate_calib_dataCreateCalibDataCreateCalibDataCreateCalibDatacreate_calib_data and can be queried with get_calib_dataget_calib_dataGetCalibDataGetCalibDataGetCalibDataget_calib_data).

If a calibration object description with index CalibObjIdxCalibObjIdxCalibObjIdxCalibObjIdxcalibObjIdxcalib_obj_idx is already defined, then the current object description overwrites it (the description is 'substituted'). Note that all NumCalibObjectsNumCalibObjectsNumCalibObjectsNumCalibObjectsnumCalibObjectsnum_calib_objects calibration objects must be set to perform calibrate_camerascalibrate_camerasCalibrateCamerasCalibrateCamerasCalibrateCamerascalibrate_cameras.

The parameter CalibObjDescrCalibObjDescrCalibObjDescrCalibObjDescrcalibObjDescrcalib_obj_descr can be used in two ways:

as a file name:

it specifies a calibration plate description file as created with create_caltabcreate_caltabCreateCaltabCreateCaltabCreateCaltabcreate_caltab or gen_caltabgen_caltabGenCaltabGenCaltabGenCaltabgen_caltab.

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_dataget_calib_dataGetCalibDataGetCalibDataGetCalibDataget_calib_data.

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

Execution Information

This operator modifies the state of the following input parameter:

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

Parameters

CalibDataIDCalibDataIDCalibDataIDCalibDataIDcalibDataIDcalib_data_id (input_control, state is modified)  calib_data HCalibData, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of a calibration data model.

CalibObjIdxCalibObjIdxCalibObjIdxCalibObjIdxcalibObjIdxcalib_obj_idx (input_control)  number HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Calibration object index.

Default value: 0

Suggested values: 0, 1, 2

CalibObjDescrCalibObjDescrCalibObjDescrCalibObjDescrcalibObjDescrcalib_obj_descr (input_control)  number(-array) HTupleMaybeSequence[Union[float, int, str]]HTupleHtuple (real / integer / string) (double / int / long / string) (double / Hlong / HString) (double / Hlong / char*)

3D point coordinates or a description file name.

List of values: 'calplate.cpd'"calplate.cpd""calplate.cpd""calplate.cpd""calplate.cpd""calplate.cpd", 'calplate_20mm.cpd'"calplate_20mm.cpd""calplate_20mm.cpd""calplate_20mm.cpd""calplate_20mm.cpd""calplate_20mm.cpd", 'calplate_40mm.cpd'"calplate_40mm.cpd""calplate_40mm.cpd""calplate_40mm.cpd""calplate_40mm.cpd""calplate_40mm.cpd", 'calplate_80mm.cpd'"calplate_80mm.cpd""calplate_80mm.cpd""calplate_80mm.cpd""calplate_80mm.cpd""calplate_80mm.cpd", 'caltab.descr'"caltab.descr""caltab.descr""caltab.descr""caltab.descr""caltab.descr", 'caltab_160mm.cpd'"caltab_160mm.cpd""caltab_160mm.cpd""caltab_160mm.cpd""caltab_160mm.cpd""caltab_160mm.cpd"

Possible Predecessors

create_calib_datacreate_calib_dataCreateCalibDataCreateCalibDataCreateCalibDatacreate_calib_data, set_calib_data_cam_paramset_calib_data_cam_paramSetCalibDataCamParamSetCalibDataCamParamSetCalibDataCamParamset_calib_data_cam_param

Possible Successors

set_calib_data_cam_paramset_calib_data_cam_paramSetCalibDataCamParamSetCalibDataCamParamSetCalibDataCamParamset_calib_data_cam_param, set_calib_data_observ_pointsset_calib_data_observ_pointsSetCalibDataObservPointsSetCalibDataObservPointsSetCalibDataObservPointsset_calib_data_observ_points, find_calib_objectfind_calib_objectFindCalibObjectFindCalibObjectFindCalibObjectfind_calib_object

Module

Calibration