vpi.brute_force_matcher

vpi.brute_force_matcher(query_descriptor: vpi.Array, reference_descriptor: vpi.Array, *, backend: vpi.Backend = vpi.Backend.DEFAULT, norm_type: vpi.Norm = vpi.Norm.HAMMING, max_matches_per_query: int = 1, out: vpi.Array = None, flags: int = 0, stream: vpi.Stream = None) → vpi.Array

Computes brute force matcher of two arrays.

This function computes the brute force matcher algorithm on the two given input BRIEF descriptor arrays.

Parameters

  • query_descriptor (vpi.Array) – Input array with query descriptors.

  • reference_descriptor (vpi.Array) – Input array with reference descriptors.

  • backend (vpi.Backend, optional) – The backend to be used by the algorithm.

  • norm_type (vpi.Norm,optional) – Specifies the norm calculation metric.

  • max_matches_per_query (int,optional) – Specifies the number of matches per query to be calculated. Must <= 3.

  • out (vpi.Array, optional) – Output array with the resulting matches.

  • flags (vpi.BruteForceMatcherFlags) – Specifies flags for the algorithm.

  • stream (vpi.Stream, optional) – The stream to be used by the algorithm.

Returns

The matches.

Return type

vpi.Array

Caution

Restrictions to several arguments may apply. Check the C API references of the submit function and the group concepts for more details.