HALCON Operator reference

HALCON Operator Reference / Matching / Descriptor-Based
ClassesClasses | | Operators

get_descriptor_model_resultsT_get_descriptor_model_resultsGetDescriptorModelResultsGetDescriptorModelResultsget_descriptor_model_results (Operator)

get_descriptor_model_resultsT_get_descriptor_model_resultsGetDescriptorModelResultsGetDescriptorModelResultsget_descriptor_model_results — Query alphanumerical results that were accumulated during descriptor-based matching.

Signature

get_descriptor_model_results( : : ModelID, ObjectID, ResultNames : Results)

Herror T_get_descriptor_model_results(const Htuple ModelID, const Htuple ObjectID, const Htuple ResultNames, Htuple* Results)

void GetDescriptorModelResults(const HTuple& ModelID, const HTuple& ObjectID, const HTuple& ResultNames, HTuple* Results)

HTuple HDescriptorModel::GetDescriptorModelResults(const HTuple& ObjectID, const HString& ResultNames) const

HTuple HDescriptorModel::GetDescriptorModelResults(Hlong ObjectID, const HString& ResultNames) const

HTuple HDescriptorModel::GetDescriptorModelResults(Hlong ObjectID, const char* ResultNames) const

HTuple HDescriptorModel::GetDescriptorModelResults(Hlong ObjectID, const wchar_t* ResultNames) const   ( Windows only)

static void HOperatorSet.GetDescriptorModelResults(HTuple modelID, HTuple objectID, HTuple resultNames, out HTuple results)

HTuple HDescriptorModel.GetDescriptorModelResults(HTuple objectID, string resultNames)

HTuple HDescriptorModel.GetDescriptorModelResults(int objectID, string resultNames)

def get_descriptor_model_results(model_id: HHandle, object_id: Union[int, str], result_names: str) -> Sequence[Union[int, float, str]]

def get_descriptor_model_results_s(model_id: HHandle, object_id: Union[int, str], result_names: str) -> Union[int, float, str]

Description

The operator get_descriptor_model_resultsget_descriptor_model_resultsGetDescriptorModelResultsGetDescriptorModelResultsget_descriptor_model_results allows to access alphanumeric results of the descriptor based matching process. The results are stored in a descriptor based model specified by ModelIDModelIDModelIDmodelIDmodel_id. ObjectIDObjectIDObjectIDobjectIDobject_id specifies for which object the results should be returned. The objects are 0-based indexed and in the same order as they are detected by find_uncalib_descriptor_modelfind_uncalib_descriptor_modelFindUncalibDescriptorModelFindUncalibDescriptorModelfind_uncalib_descriptor_model or find_calib_descriptor_modelfind_calib_descriptor_modelFindCalibDescriptorModelFindCalibDescriptorModelfind_calib_descriptor_model, respectively. Results can be queried for all objects at once by specifying 'all'"all""all""all""all" in ObjectIDObjectIDObjectIDobjectIDobject_id, if they are single valued (e.g., ResultNamesResultNamesResultNamesresultNamesresult_names='num_points'"num_points""num_points""num_points""num_points" or ResultNamesResultNamesResultNamesresultNamesresult_names='inlier_ratio'"inlier_ratio""inlier_ratio""inlier_ratio""inlier_ratio").

The results returned in ResultsResultsResultsresultsresults can be selected by setting ResultNamesResultNamesResultNamesresultNamesresult_names to:

'num_points'"num_points""num_points""num_points""num_points":

number of object points that correspond to model points.

'inlier_ratio'"inlier_ratio""inlier_ratio""inlier_ratio""inlier_ratio":

ratio of successfully matched object points relative to all descriptor model points.

'homography'"homography""homography""homography""homography":

a 3x3 projective transformation matrix which transforms model points into object points. Note that the result of the mapping depends on the selected model origin (see set_descriptor_model_originset_descriptor_model_originSetDescriptorModelOriginSetDescriptorModelOriginset_descriptor_model_origin).

'pose'"pose""pose""pose""pose":

returns the estimated object pose. Note that this result can only be queried after find_calib_descriptor_modelfind_calib_descriptor_modelFindCalibDescriptorModelFindCalibDescriptorModelfind_calib_descriptor_model was called.

'point_classification'"point_classification""point_classification""point_classification""point_classification":

returns concatenated triads representing the classification results for the interest points extracted from the search image during the last call of find_uncalib_descriptor_modelfind_uncalib_descriptor_modelFindUncalibDescriptorModelFindUncalibDescriptorModelfind_uncalib_descriptor_model or find_calib_descriptor_modelfind_calib_descriptor_modelFindCalibDescriptorModelFindCalibDescriptorModelfind_calib_descriptor_model. Each triad consists of a search point index on the first, a model point index on the second, and a classification score on the third position. The search and model point indices correspond to the point coordinates returned by get_descriptor_model_pointsget_descriptor_model_pointsGetDescriptorModelPointsGetDescriptorModelPointsget_descriptor_model_points with the parameter SubsetSubsetSubsetsubsetsubset set to 'all'"all""all""all""all" and the parameter SetSetSetsetset set to 'search'"search""search""search""search" and 'model'"model""model""model""model", respectively. If a number is passed in ObjectIDObjectIDObjectIDobjectIDobject_id only the classification results for the points matched to this object are returned. If 'all'"all""all""all""all" is passed in ObjectIDObjectIDObjectIDobjectIDobject_id the classification results for all points, including the points not matched to any object, are returned. The triads are sorted in descending order with respect to their score. Points having a score less than the value of the descriptor parameter 'min_score_descr'"min_score_descr""min_score_descr""min_score_descr""min_score_descr" (see find_calib_descriptor_modelfind_calib_descriptor_modelFindCalibDescriptorModelFindCalibDescriptorModelfind_calib_descriptor_model or find_uncalib_descriptor_modelfind_uncalib_descriptor_modelFindUncalibDescriptorModelFindUncalibDescriptorModelfind_uncalib_descriptor_model) are rejected and are not listed in the resulting classification results.

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

ModelIDModelIDModelIDmodelIDmodel_id (input_control)  descriptor_model → HDescriptorModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of a descriptor model.

ObjectIDObjectIDObjectIDobjectIDobject_id (input_control)  integer → HTupleUnion[int, str]HTupleHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*)

Handle of the object for which the results are queried.

Default: 'all' "all" "all" "all" "all"

Suggested values: 'all'"all""all""all""all", 0, 1, 2, 3

ResultNamesResultNamesResultNamesresultNamesresult_names (input_control)  attribute.name → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of the results to be queried.

Default: 'num_points' "num_points" "num_points" "num_points" "num_points"

List of values: 'homography'"homography""homography""homography""homography", 'inlier_ratio'"inlier_ratio""inlier_ratio""inlier_ratio""inlier_ratio", 'num_points'"num_points""num_points""num_points""num_points", 'point_classification'"point_classification""point_classification""point_classification""point_classification", 'pose'"pose""pose""pose""pose"

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

Returned results.

Possible Predecessors

find_uncalib_descriptor_modelfind_uncalib_descriptor_modelFindUncalibDescriptorModelFindUncalibDescriptorModelfind_uncalib_descriptor_model, find_calib_descriptor_modelfind_calib_descriptor_modelFindCalibDescriptorModelFindCalibDescriptorModelfind_calib_descriptor_model

See also

get_descriptor_model_originget_descriptor_model_originGetDescriptorModelOriginGetDescriptorModelOriginget_descriptor_model_origin, get_descriptor_model_paramsget_descriptor_model_paramsGetDescriptorModelParamsGetDescriptorModelParamsget_descriptor_model_params, get_descriptor_model_pointsget_descriptor_model_pointsGetDescriptorModelPointsGetDescriptorModelPointsget_descriptor_model_points

Module

Matching

ClassesClasses | | Operators