Evision v0.1.28

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

Link to this section Summary

Types

t()

Type that represents an Face.StandardCollector struct.

Functions

create()

Static constructor

create(opts)

Static constructor

getMinDist(self)

Returns minimal distance value

getMinLabel(self)

Returns label with minimal distance

getResults(self)

Return results as vector

getResults(self, opts)

Return results as vector

Link to this section Types

Link to this type

t()

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

Type that represents an Face.StandardCollector struct.

  • ref. reference()

    The underlying erlang resource variable.

Link to this section Functions

Link to this function

create()

View Source 
@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
Link to this function

create(opts)

View Source 
@spec create([{atom(), 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
Link to this function

getMinDist(self)

View Source 
@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
Link to this function

getMinLabel(self)

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

Returns label with minimal distance

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

Python prototype (for reference only):

getMinLabel() -> retval
Link to this function

getResults(self)

View Source 
@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
Link to this function

getResults(self, opts)

View Source 
@spec getResults(t(), [{atom(), 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