Evision v0.1.17

View Source Evision.KeyPoint (Evision v0.1.17)

Link to this section Summary

Types

t()

Type that represents an Evision.KeyPoint struct.

Functions

convert(points2f)

convert

convert(points2f, opts)

convert

get_angle(self)
get_class_id(self)
get_octave(self)
get_pt(self)
get_response(self)
get_size(self)
keyPoint()

KeyPoint

keyPoint(x, y, size)

KeyPoint

keyPoint(x, y, size, opts)

KeyPoint

overlap(kp1, kp2)

overlap

set_angle(self, prop)
set_class_id(self, prop)
set_octave(self, prop)
set_pt(self, prop)
set_response(self, prop)
set_size(self, prop)

Link to this section Types

Link to this type

t()

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

Type that represents an Evision.KeyPoint struct.

  • ref. reference()

    The underlying erlang resource variable.

Link to this section Functions

Link to this function

convert(points2f)

View Source 
@spec convert([{number(), number()}]) :: [t()] | {:error, String.t()}

convert

Positional Arguments

  • points2f: [Point2f].

    Array of (x,y) coordinates of each keypoint

Keyword Arguments

  • size: float.

    keypoint diameter

  • response: float.

    keypoint detector response on the keypoint (that is, strength of the keypoint)

  • octave: int.

    pyramid octave in which the keypoint has been detected

  • class_id: int.

    object id

Return

  • keypoints: [Evision.KeyPoint].

    Keypoints obtained from any feature detection algorithm like SIFT/SURF/ORB

Has overloading in C++

Python prototype (for reference only):

convert(points2f[, size[, response[, octave[, class_id]]]]) -> keypoints
Link to this function

convert(points2f, opts)

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

convert

Positional Arguments

  • points2f: [Point2f].

    Array of (x,y) coordinates of each keypoint

Keyword Arguments

  • size: float.

    keypoint diameter

  • response: float.

    keypoint detector response on the keypoint (that is, strength of the keypoint)

  • octave: int.

    pyramid octave in which the keypoint has been detected

  • class_id: int.

    object id

Return

  • keypoints: [Evision.KeyPoint].

    Keypoints obtained from any feature detection algorithm like SIFT/SURF/ORB

Has overloading in C++

Python prototype (for reference only):

convert(points2f[, size[, response[, octave[, class_id]]]]) -> keypoints
Link to this function

get_angle(self)

View Source 
@spec get_angle(t()) :: number()
Link to this function

get_class_id(self)

View Source 
@spec get_class_id(t()) :: integer()
Link to this function

get_octave(self)

View Source 
@spec get_octave(t()) :: integer()
Link to this function

get_pt(self)

View Source 
@spec get_pt(t()) :: {number(), number()}
Link to this function

get_response(self)

View Source 
@spec get_response(t()) :: number()
Link to this function

get_size(self)

View Source 
@spec get_size(t()) :: number()
Link to this function

keyPoint()

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

KeyPoint

Return

Python prototype (for reference only):

KeyPoint() -> <KeyPoint object>
Link to this function

keyPoint(x, y, size)

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

KeyPoint

Positional Arguments

  • x: float.

    x-coordinate of the keypoint

  • y: float.

    y-coordinate of the keypoint

  • size: float.

    keypoint diameter

Keyword Arguments

  • angle: float.

    keypoint orientation

  • response: float.

    keypoint detector response on the keypoint (that is, strength of the keypoint)

  • octave: int.

    pyramid octave in which the keypoint has been detected

  • class_id: int.

    object id

Return

Python prototype (for reference only):

KeyPoint(x, y, size[, angle[, response[, octave[, class_id]]]]) -> <KeyPoint object>
Link to this function

keyPoint(x, y, size, opts)

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

KeyPoint

Positional Arguments

  • x: float.

    x-coordinate of the keypoint

  • y: float.

    y-coordinate of the keypoint

  • size: float.

    keypoint diameter

Keyword Arguments

  • angle: float.

    keypoint orientation

  • response: float.

    keypoint detector response on the keypoint (that is, strength of the keypoint)

  • octave: int.

    pyramid octave in which the keypoint has been detected

  • class_id: int.

    object id

Return

Python prototype (for reference only):

KeyPoint(x, y, size[, angle[, response[, octave[, class_id]]]]) -> <KeyPoint object>
Link to this function

overlap(kp1, kp2)

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

overlap

Positional Arguments
Return
  • retval: float

This method computes overlap for pair of keypoints. Overlap is the ratio between area of keypoint regions' intersection and area of keypoint regions' union (considering keypoint region as circle). If they don't overlap, we get zero. If they coincide at same location with same size, we get 1.

Python prototype (for reference only):

overlap(kp1, kp2) -> retval
Link to this function

set_angle(self, prop)

View Source 
@spec set_angle(t(), number()) :: t()
Link to this function

set_class_id(self, prop)

View Source 
@spec set_class_id(t(), integer()) :: t()
Link to this function

set_octave(self, prop)

View Source 
@spec set_octave(t(), integer()) :: t()
Link to this function

set_pt(self, prop)

View Source 
@spec set_pt(
  t(),
  {number(), number()}
) :: t()
Link to this function

set_response(self, prop)

View Source 
@spec set_response(t(), number()) :: t()
Link to this function

set_size(self, prop)

View Source 
@spec set_size(t(), number()) :: t()