Skip to content

get_camera_setup_paramGetCameraSetupParamGetCameraSetupParamget_camera_setup_paramT_get_camera_setup_param🔗

Short description🔗

get_camera_setup_paramGetCameraSetupParamGetCameraSetupParamget_camera_setup_paramT_get_camera_setup_param — Get generic camera setup model parameters.

Signature🔗

get_camera_setup_param( camera_setup_model CameraSetupModelID, integer CameraIdx, attribute.name GenParamName, out attribute.value GenParamValue )void GetCameraSetupParam( const HTuple& CameraSetupModelID, const HTuple& CameraIdx, const HTuple& GenParamName, HTuple* GenParamValue )static void HOperatorSet.GetCameraSetupParam( HTuple cameraSetupModelID, HTuple cameraIdx, HTuple genParamName, out HTuple genParamValue )def get_camera_setup_param( camera_setup_model_id: HHandle, camera_idx: MaybeSequence[Union[int, str]], gen_param_name: str ) -> Sequence[Union[float, int, str]]

def get_camera_setup_param_s( camera_setup_model_id: HHandle, camera_idx: MaybeSequence[Union[int, str]], gen_param_name: str ) -> Union[float, int, str]Herror T_get_camera_setup_param( const Htuple CameraSetupModelID, const Htuple CameraIdx, const Htuple GenParamName, Htuple* GenParamValue )

HTuple HCameraSetupModel::GetCameraSetupParam( const HTuple& CameraIdx, const HString& GenParamName ) const

HTuple HCameraSetupModel::GetCameraSetupParam( Hlong CameraIdx, const HString& GenParamName ) const

HTuple HCameraSetupModel::GetCameraSetupParam( Hlong CameraIdx, const char* GenParamName ) const

HTuple HCameraSetupModel::GetCameraSetupParam( Hlong CameraIdx, const wchar_t* GenParamName ) const (Windows only)

HTuple HCameraSetupModel.GetCameraSetupParam( HTuple cameraIdx, string genParamName )

HTuple HCameraSetupModel.GetCameraSetupParam( int cameraIdx, string genParamName )

Description🔗

The operator get_camera_setup_paramGetCameraSetupParam can be used to inspect diverse generic parameters of the camera setup model CameraSetupModelIDcameraSetupModelIDcamera_setup_model_id. Two types of parameters can be queried with this operator:

General parameters:

By setting CameraIdxcameraIdxcamera_idx to 'general'"general" and GenParamNamegenParamNamegen_param_name to one of the following values, general camera setup parameters are returned in GenParamValuegenParamValuegen_param_value:

  • 'num_cameras'"num_cameras": Number of cameras described in the model. The number of cameras is fixed with the creation of the camera setup model and cannot be changed after that (see create_camera_setup_modelCreateCameraSetupModel).

  • 'camera_calib_error'"camera_calib_error": The root mean square error (RMSE) of the back projection of the optimization of the camera system. This error is identical with the error returned by calibrate_camerasCalibrateCameras.

  • 'reference_camera'"reference_camera": Returns the index of the camera that has been defined as reference camera within the system. If no reference camera has been specified using set_camera_setup_paramSetCameraSetupParam, the index 0 is returned. If the coordinate system has been moved by setting a pose with the parameter 'coord_transf_pose'"coord_transf_pose" in set_camera_setup_paramSetCameraSetupParam, the origin of the coordinate system is not located in any of the available cameras. Therefore, the index -1 is returned.

  • 'coord_transf_pose'"coord_transf_pose": Returns the pose in which the coordinate system of the setup has been moved. Please note that after setting a reference camera with set_camera_setup_paramSetCameraSetupParam, the pose of this camera is returned. Adjusting this coordinate system subsequently using the parameter 'coord_transf_pose'"coord_transf_pose" in set_camera_setup_paramSetCameraSetupParam yields a pose that corresponds to the location and orientation of the desired coordinate system relative to the current one.

Camera parameters:

By setting CameraIdxcameraIdxcamera_idx to a valid setup camera index (a value between 0 and NumCamerasnumCamerasnum_cameras-1) and GenParamNamegenParamNamegen_param_name to one of the following values, camera-specific parameters are returned in GenParamValuegenParamValuegen_param_value:

  • 'type'"type": Camera type (see set_camera_setup_cam_paramSetCameraSetupCamParam).

  • 'params'"params": A tuple with internal camera parameters. The length of the tuple depends on the camera type.

  • 'params_deviations'"params_deviations": A tuple representing the standard deviations of the internal camera parameters. The length of the tuple depends on the camera type.

  • 'params_covariances'"params_covariances": A tuple representing the covariance matrix if the internal camera parameters. The length of the tuple depends on the camera type.

  • 'pose'"pose": Camera pose relative to the setup’s coordinate system (see create_camera_setup_modelCreateCameraSetupModel for more details).

Note that the camera needs to be set first by set_camera_setup_cam_paramSetCameraSetupCamParam, before any of its parameters can be inspected by get_camera_setup_paramGetCameraSetupParam. If CameraIdxcameraIdxcamera_idx is an index of an undefined camera, the operator returns an error.

For more 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.

Parameters🔗

CameraSetupModelIDcameraSetupModelIDcamera_setup_model_id (input_control) camera_setup_model → (handle)HTuple (HHandle)HCameraSetupModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle to the camera setup model.

CameraIdxcameraIdxcamera_idx (input_control) integer(-array) → (integer / string)HTuple (Hlong / HString)HTuple (int / long / string)MaybeSequence[Union[int, str]]Htuple (Hlong / char*)

Index of the camera in the setup.

Default: 00
Suggested values: 0, 1, 2, 'general'0, 1, 2, "general"

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

Names of the generic parameters to be queried.

List of values: 'camera_calib_error', 'coord_transf_pose', 'num_cameras', 'params', 'params_covariances', 'params_deviations', 'pose', 'reference_camera', 'type'"camera_calib_error", "coord_transf_pose", "num_cameras", "params", "params_covariances", "params_deviations", "pose", "reference_camera", "type"

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

Values of the generic parameters to be queried.

Module🔗

Calibration