View Source Evision.Detail.BestOf2NearestMatcher (Evision v0.1.21)

Link to this section Summary

Types

t()

Type that represents an Evision.Detail.BestOf2NearestMatcher struct.

Functions

Performs images matching.

Performs images matching.

Constructs a "best of 2 nearest" matcher.

Constructs a "best of 2 nearest" matcher.

collectGarbage

create

create

isThreadSafe

Link to this section Types

@type t() :: %Evision.Detail.BestOf2NearestMatcher{ref: reference()}

Type that represents an Evision.Detail.BestOf2NearestMatcher struct.

  • ref. reference()

    The underlying erlang resource variable.

Link to this section Functions

@spec apply2(t(), [Evision.Detail.ImageFeatures.t()]) ::
  [Evision.Detail.MatchesInfo.t()] | {:error, String.t()}

Performs images matching.

Positional Arguments
  • self: Evision.Detail.BestOf2NearestMatcher.t()

  • features: [Evision.Detail.ImageFeatures].

    Features of the source images

Keyword Arguments
  • mask: Evision.Mat.

    Mask indicating which image pairs must be matched

Return
  • pairwise_matches: [Evision.Detail.MatchesInfo].

    Found pairwise matches

The function is parallelized with the TBB library. @sa detail::MatchesInfo

Python prototype (for reference only):

apply2(features[, mask]) -> pairwise_matches
Link to this function

apply2(self, features, opts)

View Source
@spec apply2(t(), [Evision.Detail.ImageFeatures.t()], [{atom(), term()}, ...] | nil) ::
  [Evision.Detail.MatchesInfo.t()] | {:error, String.t()}

Performs images matching.

Positional Arguments
  • self: Evision.Detail.BestOf2NearestMatcher.t()

  • features: [Evision.Detail.ImageFeatures].

    Features of the source images

Keyword Arguments
  • mask: Evision.Mat.

    Mask indicating which image pairs must be matched

Return
  • pairwise_matches: [Evision.Detail.MatchesInfo].

    Found pairwise matches

The function is parallelized with the TBB library. @sa detail::MatchesInfo

Python prototype (for reference only):

apply2(features[, mask]) -> pairwise_matches
Link to this function

apply(self, features1, features2)

View Source

apply

Positional Arguments
Return

Has overloading in C++

Python prototype (for reference only):

apply(features1, features2) -> matches_info
@spec bestOf2NearestMatcher() :: t() | {:error, String.t()}

Constructs a "best of 2 nearest" matcher.

Keyword Arguments
  • try_use_gpu: bool.

    Should try to use GPU or not

  • match_conf: float.

    Match distances ration threshold

  • num_matches_thresh1: int.

    Minimum number of matches required for the 2D projective transform estimation used in the inliers classification step

  • num_matches_thresh2: int.

    Minimum number of matches required for the 2D projective transform re-estimation on inliers

Return

Python prototype (for reference only):

BestOf2NearestMatcher([, try_use_gpu[, match_conf[, num_matches_thresh1[, num_matches_thresh2]]]]) -> <detail_BestOf2NearestMatcher object>
Link to this function

bestOf2NearestMatcher(opts)

View Source
@spec bestOf2NearestMatcher([{atom(), term()}, ...] | nil) ::
  t() | {:error, String.t()}

Constructs a "best of 2 nearest" matcher.

Keyword Arguments
  • try_use_gpu: bool.

    Should try to use GPU or not

  • match_conf: float.

    Match distances ration threshold

  • num_matches_thresh1: int.

    Minimum number of matches required for the 2D projective transform estimation used in the inliers classification step

  • num_matches_thresh2: int.

    Minimum number of matches required for the 2D projective transform re-estimation on inliers

Return

Python prototype (for reference only):

BestOf2NearestMatcher([, try_use_gpu[, match_conf[, num_matches_thresh1[, num_matches_thresh2]]]]) -> <detail_BestOf2NearestMatcher object>
@spec collectGarbage(t()) :: :ok | {:error, String.t()}

collectGarbage

Positional Arguments
  • self: Evision.Detail.BestOf2NearestMatcher.t()

Python prototype (for reference only):

collectGarbage() -> None
@spec create() :: t() | {:error, String.t()}

create

Keyword Arguments
  • try_use_gpu: bool.
  • match_conf: float.
  • num_matches_thresh1: int.
  • num_matches_thresh2: int.
Return

Python prototype (for reference only):

create([, try_use_gpu[, match_conf[, num_matches_thresh1[, num_matches_thresh2]]]]) -> retval
@spec create([{atom(), term()}, ...] | nil) :: t() | {:error, String.t()}

create

Keyword Arguments
  • try_use_gpu: bool.
  • match_conf: float.
  • num_matches_thresh1: int.
  • num_matches_thresh2: int.
Return

Python prototype (for reference only):

create([, try_use_gpu[, match_conf[, num_matches_thresh1[, num_matches_thresh2]]]]) -> retval
@spec isThreadSafe(t()) :: boolean() | {:error, String.t()}

isThreadSafe

Positional Arguments
  • self: Evision.Detail.BestOf2NearestMatcher.t()
Return
  • retval: bool

@return True, if it's possible to use the same matcher instance in parallel, false otherwise

Python prototype (for reference only):

isThreadSafe() -> retval