View Source Evision.Face.StandardCollector (Evision v0.2.7)

Summary

Types

t()

Type that represents an Face.StandardCollector struct.

Functions

Static constructor

Static constructor

Returns minimal distance value

Returns label with minimal distance

Return results as vector

Return results as vector

Types

@type t() :: %Evision.Face.StandardCollector{ref: reference()}

Type that represents an Face.StandardCollector struct.

  • ref. reference()

    The underlying erlang resource variable.

Functions

@spec create() :: t() | {:error, String.t()}

Static constructor

Keyword Arguments
  • threshold: double.

    set threshold

Return
  • retval: StandardCollector

Python prototype (for reference only):

create([, threshold]) -> retval
@spec create(Keyword.t()) :: any() | {:error, String.t()}
@spec create([{:threshold, term()}] | nil) :: t() | {:error, String.t()}

Static constructor

Keyword Arguments
  • threshold: double.

    set threshold

Return
  • retval: StandardCollector

Python prototype (for reference only):

create([, threshold]) -> retval
@spec getMinDist(Keyword.t()) :: any() | {:error, String.t()}
@spec getMinDist(t()) :: number() | {:error, String.t()}

Returns minimal distance value

Positional Arguments
  • self: Evision.Face.StandardCollector.t()
Return
  • retval: double

Python prototype (for reference only):

getMinDist() -> retval
@spec getMinLabel(Keyword.t()) :: any() | {:error, String.t()}
@spec getMinLabel(t()) :: integer() | {:error, String.t()}

Returns label with minimal distance

Positional Arguments
  • self: Evision.Face.StandardCollector.t()
Return
  • retval: integer()

Python prototype (for reference only):

getMinLabel() -> retval
@spec getResults(Keyword.t()) :: any() | {:error, String.t()}
@spec getResults(t()) :: [{integer(), number()}] | {:error, String.t()}

Return results as vector

Positional Arguments
  • self: Evision.Face.StandardCollector.t()
Keyword Arguments
  • sorted: bool.

    If set, results will be sorted by distance Each values is a pair of label and distance.

Return
  • retval: [pair<int, double>]

Python prototype (for reference only):

getResults([, sorted]) -> retval
@spec getResults(t(), [{:sorted, term()}] | nil) ::
  [{integer(), number()}] | {:error, String.t()}

Return results as vector

Positional Arguments
  • self: Evision.Face.StandardCollector.t()
Keyword Arguments
  • sorted: bool.

    If set, results will be sorted by distance Each values is a pair of label and distance.

Return
  • retval: [pair<int, double>]

Python prototype (for reference only):

getResults([, sorted]) -> retval