View Source Evision.Detail.BestOf2NearestRangeMatcher (Evision v0.2.1)

Summary

Types

t()

Type that represents an Detail.BestOf2NearestRangeMatcher struct.

Functions

Performs images matching.

Performs images matching.

BestOf2NearestRangeMatcher

BestOf2NearestRangeMatcher

collectGarbage

create

create

isThreadSafe

Types

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

Type that represents an Detail.BestOf2NearestRangeMatcher struct.

  • ref. reference()

    The underlying erlang resource variable.

Functions

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

Performs images matching.

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

  • features: [Evision.Detail.ImageFeatures].

    Features of the source images

Keyword Arguments
  • mask: Evision.Mat.t().

    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(
  Evision.Detail.Detail.BestOf2NearestRangeMatcher.t(),
  [Evision.Detail.ImageFeatures.t()],
  [{:mask, term()}] | nil
) :: [Evision.Detail.MatchesInfo.t()] | {:error, String.t()}

Performs images matching.

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

  • features: [Evision.Detail.ImageFeatures].

    Features of the source images

Keyword Arguments
  • mask: Evision.Mat.t().

    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
@spec apply(
  Evision.Detail.Detail.BestOf2NearestRangeMatcher.t(),
  Evision.Detail.ImageFeatures.t(),
  Evision.Detail.ImageFeatures.t()
) :: Evision.Detail.MatchesInfo.t() | {:error, String.t()}

apply

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

  • features1: Evision.Detail.ImageFeatures.t().

    First image features

  • features2: Evision.Detail.ImageFeatures.t().

    Second image features

Return
  • matches_info: Evision.Detail.MatchesInfo.t().

    Found matches

Has overloading in C++

Python prototype (for reference only):

apply(features1, features2) -> matches_info
Link to this function

bestOf2NearestRangeMatcher()

View Source
@spec bestOf2NearestRangeMatcher() :: t() | {:error, String.t()}

BestOf2NearestRangeMatcher

Keyword Arguments
  • range_width: int.
  • try_use_gpu: bool.
  • match_conf: float.
  • num_matches_thresh1: int.
  • num_matches_thresh2: int.
Return
  • self: Evision.Detail.BestOf2NearestRangeMatcher.t()

Python prototype (for reference only):

BestOf2NearestRangeMatcher([, range_width[, try_use_gpu[, match_conf[, num_matches_thresh1[, num_matches_thresh2]]]]]) -> <detail_BestOf2NearestRangeMatcher object>
Link to this function

bestOf2NearestRangeMatcher(opts)

View Source
@spec bestOf2NearestRangeMatcher(
  [
    match_conf: term(),
    num_matches_thresh1: term(),
    num_matches_thresh2: term(),
    range_width: term(),
    try_use_gpu: term()
  ]
  | nil
) :: t() | {:error, String.t()}

BestOf2NearestRangeMatcher

Keyword Arguments
  • range_width: int.
  • try_use_gpu: bool.
  • match_conf: float.
  • num_matches_thresh1: int.
  • num_matches_thresh2: int.
Return
  • self: Evision.Detail.BestOf2NearestRangeMatcher.t()

Python prototype (for reference only):

BestOf2NearestRangeMatcher([, range_width[, try_use_gpu[, match_conf[, num_matches_thresh1[, num_matches_thresh2]]]]]) -> <detail_BestOf2NearestRangeMatcher object>
@spec collectGarbage(Evision.Detail.Detail.BestOf2NearestRangeMatcher.t()) ::
  Evision.Detail.Detail.BestOf2NearestRangeMatcher.t() | {:error, String.t()}

collectGarbage

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

Python prototype (for reference only):

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

create

Keyword Arguments
  • try_use_gpu: bool.
  • match_conf: float.
  • num_matches_thresh1: int.
  • num_matches_thresh2: int.
  • matches_confindece_thresh: double.
Return
  • retval: Evision.Detail.BestOf2NearestMatcher.t()

Python prototype (for reference only):

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

create

Keyword Arguments
  • try_use_gpu: bool.
  • match_conf: float.
  • num_matches_thresh1: int.
  • num_matches_thresh2: int.
  • matches_confindece_thresh: double.
Return
  • retval: Evision.Detail.BestOf2NearestMatcher.t()

Python prototype (for reference only):

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

isThreadSafe

Positional Arguments
  • self: Evision.Detail.BestOf2NearestRangeMatcher.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