get_stereo_model_paramT_get_stereo_model_paramGetStereoModelParamGetStereoModelParamget_stereo_model_param (Operator)

Name

get_stereo_model_paramT_get_stereo_model_paramGetStereoModelParamGetStereoModelParamget_stereo_model_param — Get stereo model parameters.

Signature

get_stereo_model_param( : : StereoModelID, GenParamName : GenParamValue)

Herror T_get_stereo_model_param(const Htuple StereoModelID, const Htuple GenParamName, Htuple* GenParamValue)

void GetStereoModelParam(const HTuple& StereoModelID, const HTuple& GenParamName, HTuple* GenParamValue)

HTuple HStereoModel::GetStereoModelParam(const HTuple& GenParamName) const

HTuple HStereoModel::GetStereoModelParam(const HString& GenParamName) const

HTuple HStereoModel::GetStereoModelParam(const char* GenParamName) const

HTuple HStereoModel::GetStereoModelParam(const wchar_t* GenParamName) const   (Windows only)

static void HOperatorSet.GetStereoModelParam(HTuple stereoModelID, HTuple genParamName, out HTuple genParamValue)

HTuple HStereoModel.GetStereoModelParam(HTuple genParamName)

HTuple HStereoModel.GetStereoModelParam(string genParamName)

def get_stereo_model_param(stereo_model_id: HHandle, gen_param_name: MaybeSequence[str]) -> Sequence[Union[float, int, str]]

Description

The operator get_stereo_model_paramget_stereo_model_paramGetStereoModelParamGetStereoModelParamGetStereoModelParamget_stereo_model_param can be used to inspect diverse parameters of the stereo model StereoModelIDStereoModelIDStereoModelIDStereoModelIDstereoModelIDstereo_model_id by specifying their names in GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and getting their values in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value. Two types of parameters can be inspected with this operator - general and specific for surface reconstruction. Note that no specific parameters are provided for 3D point stereo reconstruction.

All parameters that can be set with set_stereo_model_paramset_stereo_model_paramSetStereoModelParamSetStereoModelParamSetStereoModelParamset_stereo_model_param can also be queried with get_stereo_model_paramget_stereo_model_paramGetStereoModelParamGetStereoModelParamGetStereoModelParamget_stereo_model_param - for a description see the former operator. In contrast, the following parameters are set by other operators and cannot be modified afterwards.

General parameters

'type'"type""type""type""type""type":

Type of the stereo model (currently either 'surface_pairwise'"surface_pairwise""surface_pairwise""surface_pairwise""surface_pairwise""surface_pairwise", 'surface_fusion'"surface_fusion""surface_fusion""surface_fusion""surface_fusion""surface_fusion" or 'points_3d'"points_3d""points_3d""points_3d""points_3d""points_3d").

'camera_setup_model'"camera_setup_model""camera_setup_model""camera_setup_model""camera_setup_model""camera_setup_model":

Handle to a copy of the camera setup model set in the stereo model. Changing properties of the copy does not affect the camera setup model stored in the stereo model.

'from_cam_param_rect N'"from_cam_param_rect N""from_cam_param_rect N""from_cam_param_rect N""from_cam_param_rect N""from_cam_param_rect N", 'to_cam_param_rect N'"to_cam_param_rect N""to_cam_param_rect N""to_cam_param_rect N""to_cam_param_rect N""to_cam_param_rect N":

Camera parameters of the rectified from- and to-cameras of camera pair N. See set_stereo_model_image_pairsset_stereo_model_image_pairsSetStereoModelImagePairsSetStereoModelImagePairsSetStereoModelImagePairsset_stereo_model_image_pairs for more information about camera pairs.

'from_cam_pose_rect N'"from_cam_pose_rect N""from_cam_pose_rect N""from_cam_pose_rect N""from_cam_pose_rect N""from_cam_pose_rect N", 'to_cam_pose_rect N'"to_cam_pose_rect N""to_cam_pose_rect N""to_cam_pose_rect N""to_cam_pose_rect N""to_cam_pose_rect N":

Point transformation from the rectified from- and to-cameras of camera pair N to the respective unrectified camera. See set_stereo_model_image_pairsset_stereo_model_image_pairsSetStereoModelImagePairsSetStereoModelImagePairsSetStereoModelImagePairsset_stereo_model_image_pairs for more information about camera pairs.

'rel_pose_rect N'"rel_pose_rect N""rel_pose_rect N""rel_pose_rect N""rel_pose_rect N""rel_pose_rect N":

Point transformation from the rectified to-camera to the rectified from-camera. See set_stereo_model_image_pairsset_stereo_model_image_pairsSetStereoModelImagePairsSetStereoModelImagePairsSetStereoModelImagePairsset_stereo_model_image_pairs for more information about camera pairs.

The parameters 'type'"type""type""type""type""type" and 'camera_setup_model'"camera_setup_model""camera_setup_model""camera_setup_model""camera_setup_model""camera_setup_model" are set when creating the stereo model with create_stereo_modelcreate_stereo_modelCreateStereoModelCreateStereoModelCreateStereoModelcreate_stereo_model. For 'from_cam_param_rect N'"from_cam_param_rect N""from_cam_param_rect N""from_cam_param_rect N""from_cam_param_rect N""from_cam_param_rect N", 'to_cam_param_rect N'"to_cam_param_rect N""to_cam_param_rect N""to_cam_param_rect N""to_cam_param_rect N""to_cam_param_rect N", 'from_cam_pose_rect N'"from_cam_pose_rect N""from_cam_pose_rect N""from_cam_pose_rect N""from_cam_pose_rect N""from_cam_pose_rect N", 'to_cam_pose_rect N'"to_cam_pose_rect N""to_cam_pose_rect N""to_cam_pose_rect N""to_cam_pose_rect N""to_cam_pose_rect N", and 'rel_pose_rect N'"rel_pose_rect N""rel_pose_rect N""rel_pose_rect N""rel_pose_rect N""rel_pose_rect N", note that these parameters are only available after setting the image pairs (see set_stereo_model_image_pairsset_stereo_model_image_pairsSetStereoModelImagePairsSetStereoModelImagePairsSetStereoModelImagePairsset_stereo_model_image_pairs).

A note on tuple-valued model parameters

Most of the stereo model parameters are single-valued. Thus, you can provide a list (i.e., tuple) of parameter names and get a list (tuple) of values that has the same length as the output tuple. In contrast, when querying a tuple-valued parameter, a tuple of values is returned. When querying such a parameter together with other parameters, the value-to-parameter-name correspondence is not obvious anymore. Thus, tuple-valued parameters like 'bounding_box'"bounding_box""bounding_box""bounding_box""bounding_box""bounding_box", 'min_disparity'"min_disparity""min_disparity""min_disparity""min_disparity""min_disparity" or 'max_disparity'"max_disparity""max_disparity""max_disparity""max_disparity""max_disparity" should always be queried in a separate call to get_stereo_model_paramget_stereo_model_paramGetStereoModelParamGetStereoModelParamGetStereoModelParamget_stereo_model_param.

Execution Information

Parameters

StereoModelIDStereoModelIDStereoModelIDStereoModelIDstereoModelIDstereo_model_id (input_control)  stereo_model HStereoModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the stereo model.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  attribute.name(-array) HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Names of the parameters to be set.

List of values: 'binocular_filter'"binocular_filter""binocular_filter""binocular_filter""binocular_filter""binocular_filter", 'binocular_mask_height'"binocular_mask_height""binocular_mask_height""binocular_mask_height""binocular_mask_height""binocular_mask_height", 'binocular_mask_width'"binocular_mask_width""binocular_mask_width""binocular_mask_width""binocular_mask_width""binocular_mask_width", 'binocular_method'"binocular_method""binocular_method""binocular_method""binocular_method""binocular_method", 'binocular_mg_cycle_type'"binocular_mg_cycle_type""binocular_mg_cycle_type""binocular_mg_cycle_type""binocular_mg_cycle_type""binocular_mg_cycle_type", 'binocular_mg_gradient_constancy'"binocular_mg_gradient_constancy""binocular_mg_gradient_constancy""binocular_mg_gradient_constancy""binocular_mg_gradient_constancy""binocular_mg_gradient_constancy", 'binocular_mg_gray_constancy'"binocular_mg_gray_constancy""binocular_mg_gray_constancy""binocular_mg_gray_constancy""binocular_mg_gray_constancy""binocular_mg_gray_constancy", 'binocular_mg_initial_guess'"binocular_mg_initial_guess""binocular_mg_initial_guess""binocular_mg_initial_guess""binocular_mg_initial_guess""binocular_mg_initial_guess", 'binocular_mg_initial_level'"binocular_mg_initial_level""binocular_mg_initial_level""binocular_mg_initial_level""binocular_mg_initial_level""binocular_mg_initial_level", 'binocular_mg_iterations'"binocular_mg_iterations""binocular_mg_iterations""binocular_mg_iterations""binocular_mg_iterations""binocular_mg_iterations", 'binocular_mg_post_relax'"binocular_mg_post_relax""binocular_mg_post_relax""binocular_mg_post_relax""binocular_mg_post_relax""binocular_mg_post_relax", 'binocular_mg_pre_relax'"binocular_mg_pre_relax""binocular_mg_pre_relax""binocular_mg_pre_relax""binocular_mg_pre_relax""binocular_mg_pre_relax", 'binocular_mg_pyramid_factor'"binocular_mg_pyramid_factor""binocular_mg_pyramid_factor""binocular_mg_pyramid_factor""binocular_mg_pyramid_factor""binocular_mg_pyramid_factor", 'binocular_mg_smoothness'"binocular_mg_smoothness""binocular_mg_smoothness""binocular_mg_smoothness""binocular_mg_smoothness""binocular_mg_smoothness", 'binocular_mg_solver'"binocular_mg_solver""binocular_mg_solver""binocular_mg_solver""binocular_mg_solver""binocular_mg_solver", 'binocular_ms_consistency_check'"binocular_ms_consistency_check""binocular_ms_consistency_check""binocular_ms_consistency_check""binocular_ms_consistency_check""binocular_ms_consistency_check", 'binocular_ms_edge_smoothing'"binocular_ms_edge_smoothing""binocular_ms_edge_smoothing""binocular_ms_edge_smoothing""binocular_ms_edge_smoothing""binocular_ms_edge_smoothing", 'binocular_ms_similarity_measure'"binocular_ms_similarity_measure""binocular_ms_similarity_measure""binocular_ms_similarity_measure""binocular_ms_similarity_measure""binocular_ms_similarity_measure", 'binocular_ms_sub_disparity'"binocular_ms_sub_disparity""binocular_ms_sub_disparity""binocular_ms_sub_disparity""binocular_ms_sub_disparity""binocular_ms_sub_disparity", 'binocular_ms_surface_smoothing'"binocular_ms_surface_smoothing""binocular_ms_surface_smoothing""binocular_ms_surface_smoothing""binocular_ms_surface_smoothing""binocular_ms_surface_smoothing", 'binocular_num_levels'"binocular_num_levels""binocular_num_levels""binocular_num_levels""binocular_num_levels""binocular_num_levels", 'binocular_score_thresh'"binocular_score_thresh""binocular_score_thresh""binocular_score_thresh""binocular_score_thresh""binocular_score_thresh", 'binocular_sub_disparity'"binocular_sub_disparity""binocular_sub_disparity""binocular_sub_disparity""binocular_sub_disparity""binocular_sub_disparity", 'binocular_texture_thresh'"binocular_texture_thresh""binocular_texture_thresh""binocular_texture_thresh""binocular_texture_thresh""binocular_texture_thresh", 'bounding_box'"bounding_box""bounding_box""bounding_box""bounding_box""bounding_box", 'camera_setup_model'"camera_setup_model""camera_setup_model""camera_setup_model""camera_setup_model""camera_setup_model", 'color'"color""color""color""color""color", 'color_invisible'"color_invisible""color_invisible""color_invisible""color_invisible""color_invisible", 'disparity_method'"disparity_method""disparity_method""disparity_method""disparity_method""disparity_method", 'from_cam_param_rect'"from_cam_param_rect""from_cam_param_rect""from_cam_param_rect""from_cam_param_rect""from_cam_param_rect", 'from_cam_pose_rect'"from_cam_pose_rect""from_cam_pose_rect""from_cam_pose_rect""from_cam_pose_rect""from_cam_pose_rect", 'max_disparity'"max_disparity""max_disparity""max_disparity""max_disparity""max_disparity", 'min_disparity'"min_disparity""min_disparity""min_disparity""min_disparity""min_disparity", 'min_thickness'"min_thickness""min_thickness""min_thickness""min_thickness""min_thickness", 'persistence'"persistence""persistence""persistence""persistence""persistence", 'point_meshing'"point_meshing""point_meshing""point_meshing""point_meshing""point_meshing", 'poisson_depth'"poisson_depth""poisson_depth""poisson_depth""poisson_depth""poisson_depth", 'poisson_samples_per_node'"poisson_samples_per_node""poisson_samples_per_node""poisson_samples_per_node""poisson_samples_per_node""poisson_samples_per_node", 'poisson_solver_divide'"poisson_solver_divide""poisson_solver_divide""poisson_solver_divide""poisson_solver_divide""poisson_solver_divide", 'rectif_interpolation'"rectif_interpolation""rectif_interpolation""rectif_interpolation""rectif_interpolation""rectif_interpolation", 'rectif_method'"rectif_method""rectif_method""rectif_method""rectif_method""rectif_method", 'rectif_sub_sampling'"rectif_sub_sampling""rectif_sub_sampling""rectif_sub_sampling""rectif_sub_sampling""rectif_sub_sampling", 'rel_pose_rect'"rel_pose_rect""rel_pose_rect""rel_pose_rect""rel_pose_rect""rel_pose_rect", 'resolution'"resolution""resolution""resolution""resolution""resolution", 'smoothing'"smoothing""smoothing""smoothing""smoothing""smoothing", 'sub_sampling_step'"sub_sampling_step""sub_sampling_step""sub_sampling_step""sub_sampling_step""sub_sampling_step", 'surface_tolerance'"surface_tolerance""surface_tolerance""surface_tolerance""surface_tolerance""surface_tolerance", 'to_cam_param_rect'"to_cam_param_rect""to_cam_param_rect""to_cam_param_rect""to_cam_param_rect""to_cam_param_rect", 'to_cam_pose_rect'"to_cam_pose_rect""to_cam_pose_rect""to_cam_pose_rect""to_cam_pose_rect""to_cam_pose_rect", 'type'"type""type""type""type""type"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_control)  attribute.value-array HTupleSequence[Union[float, int, str]]HTupleHtuple (real / integer / string) (double / int / long / string) (double / Hlong / HString) (double / Hlong / char*)

Values of the parameters to be set.

Possible Predecessors

create_stereo_modelcreate_stereo_modelCreateStereoModelCreateStereoModelCreateStereoModelcreate_stereo_model, set_stereo_model_paramset_stereo_model_paramSetStereoModelParamSetStereoModelParamSetStereoModelParamset_stereo_model_param

Possible Successors

reconstruct_surface_stereoreconstruct_surface_stereoReconstructSurfaceStereoReconstructSurfaceStereoReconstructSurfaceStereoreconstruct_surface_stereo, reconstruct_points_stereoreconstruct_points_stereoReconstructPointsStereoReconstructPointsStereoReconstructPointsStereoreconstruct_points_stereo

See also

set_stereo_model_paramset_stereo_model_paramSetStereoModelParamSetStereoModelParamSetStereoModelParamset_stereo_model_param

Module

3D Metrology