View Source Evision.BRISK (Evision v0.2.2)

Summary

Types

t()

Type that represents an BRISK struct.

Functions

The BRISK constructor

The BRISK constructor

The BRISK constructor for a custom pattern

The BRISK constructor for a custom pattern

The BRISK constructor for a custom pattern, detection threshold and octaves

The BRISK constructor for a custom pattern, detection threshold and octaves

defaultNorm

descriptorSize

descriptorType

Variant 1:

detect

Variant 1:

detect

empty

getDefaultName

getOctaves

getPatternScale

getThreshold

Variant 1:

read

Set detection octaves.

Set detection patternScale.

Set detection threshold.

Types

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

Type that represents an BRISK struct.

  • ref. reference()

    The underlying erlang resource variable.

Functions

Link to this function

compute(self, images, keypoints)

View Source
@spec compute(t(), [Evision.Mat.maybe_mat_in()], [[Evision.KeyPoint.t()]]) ::
  {[[Evision.KeyPoint.t()]], [Evision.Mat.t()]} | {:error, String.t()}
@spec compute(t(), Evision.Mat.maybe_mat_in(), [Evision.KeyPoint.t()]) ::
  {[Evision.KeyPoint.t()], Evision.Mat.t()} | {:error, String.t()}

Variant 1:

compute

Positional Arguments
  • self: Evision.BRISK.t()

  • images: [Evision.Mat].

    Image set.

Return
  • keypoints: [[Evision.KeyPoint]].

    Input collection of keypoints. Keypoints for which a descriptor cannot be computed are removed. Sometimes new keypoints can be added, for example: SIFT duplicates keypoint with several dominant orientations (for each orientation).

  • descriptors: [Evision.Mat].

    Computed descriptors. In the second variant of the method descriptors[i] are descriptors computed for a keypoints[i]. Row j is the keypoints (or keypoints[i]) is the descriptor for keypoint j-th keypoint.

Has overloading in C++

Python prototype (for reference only):

compute(images, keypoints[, descriptors]) -> keypoints, descriptors

Variant 2:

Computes the descriptors for a set of keypoints detected in an image (first variant) or image set (second variant).

Positional Arguments
Return
  • keypoints: [Evision.KeyPoint].

    Input collection of keypoints. Keypoints for which a descriptor cannot be computed are removed. Sometimes new keypoints can be added, for example: SIFT duplicates keypoint with several dominant orientations (for each orientation).

  • descriptors: Evision.Mat.t().

    Computed descriptors. In the second variant of the method descriptors[i] are descriptors computed for a keypoints[i]. Row j is the keypoints (or keypoints[i]) is the descriptor for keypoint j-th keypoint.

Python prototype (for reference only):

compute(image, keypoints[, descriptors]) -> keypoints, descriptors
Link to this function

compute(self, images, keypoints, opts)

View Source
@spec compute(
  t(),
  [Evision.Mat.maybe_mat_in()],
  [[Evision.KeyPoint.t()]],
  [{atom(), term()}, ...] | nil
) :: {[[Evision.KeyPoint.t()]], [Evision.Mat.t()]} | {:error, String.t()}
@spec compute(
  t(),
  Evision.Mat.maybe_mat_in(),
  [Evision.KeyPoint.t()],
  [{atom(), term()}, ...] | nil
) ::
  {[Evision.KeyPoint.t()], Evision.Mat.t()} | {:error, String.t()}

Variant 1:

compute

Positional Arguments
  • self: Evision.BRISK.t()

  • images: [Evision.Mat].

    Image set.

Return
  • keypoints: [[Evision.KeyPoint]].

    Input collection of keypoints. Keypoints for which a descriptor cannot be computed are removed. Sometimes new keypoints can be added, for example: SIFT duplicates keypoint with several dominant orientations (for each orientation).

  • descriptors: [Evision.Mat].

    Computed descriptors. In the second variant of the method descriptors[i] are descriptors computed for a keypoints[i]. Row j is the keypoints (or keypoints[i]) is the descriptor for keypoint j-th keypoint.

Has overloading in C++

Python prototype (for reference only):

compute(images, keypoints[, descriptors]) -> keypoints, descriptors

Variant 2:

Computes the descriptors for a set of keypoints detected in an image (first variant) or image set (second variant).

Positional Arguments
Return
  • keypoints: [Evision.KeyPoint].

    Input collection of keypoints. Keypoints for which a descriptor cannot be computed are removed. Sometimes new keypoints can be added, for example: SIFT duplicates keypoint with several dominant orientations (for each orientation).

  • descriptors: Evision.Mat.t().

    Computed descriptors. In the second variant of the method descriptors[i] are descriptors computed for a keypoints[i]. Row j is the keypoints (or keypoints[i]) is the descriptor for keypoint j-th keypoint.

Python prototype (for reference only):

compute(image, keypoints[, descriptors]) -> keypoints, descriptors
@spec create() :: t() | {:error, String.t()}

The BRISK constructor

Keyword Arguments
  • thresh: integer().

    AGAST detection threshold score.

  • octaves: integer().

    detection octaves. Use 0 to do single scale.

  • patternScale: float.

    apply this scale to the pattern used for sampling the neighbourhood of a keypoint.

Return
  • retval: Evision.BRISK.t()

Python prototype (for reference only):

create([, thresh[, octaves[, patternScale]]]) -> retval
@spec create([octaves: term(), patternScale: term(), thresh: term()] | nil) ::
  t() | {:error, String.t()}

The BRISK constructor

Keyword Arguments
  • thresh: integer().

    AGAST detection threshold score.

  • octaves: integer().

    detection octaves. Use 0 to do single scale.

  • patternScale: float.

    apply this scale to the pattern used for sampling the neighbourhood of a keypoint.

Return
  • retval: Evision.BRISK.t()

Python prototype (for reference only):

create([, thresh[, octaves[, patternScale]]]) -> retval
Link to this function

create(radiusList, numberList)

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

The BRISK constructor for a custom pattern

Positional Arguments
  • radiusList: [float].

    defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).

  • numberList: [integer()].

    defines the number of sampling points on the sampling circle. Must be the same size as radiusList..

Keyword Arguments
  • dMax: float.

    threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).

  • dMin: float.

    threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).

  • indexChange: [integer()].

    index remapping of the bits.

Return
  • retval: Evision.BRISK.t()

Python prototype (for reference only):

create(radiusList, numberList[, dMax[, dMin[, indexChange]]]) -> retval
Link to this function

create(radiusList, numberList, opts)

View Source
@spec create(
  [number()],
  [integer()],
  [dMax: term(), dMin: term(), indexChange: term()] | nil
) ::
  t() | {:error, String.t()}

The BRISK constructor for a custom pattern

Positional Arguments
  • radiusList: [float].

    defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).

  • numberList: [integer()].

    defines the number of sampling points on the sampling circle. Must be the same size as radiusList..

Keyword Arguments
  • dMax: float.

    threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).

  • dMin: float.

    threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).

  • indexChange: [integer()].

    index remapping of the bits.

Return
  • retval: Evision.BRISK.t()

Python prototype (for reference only):

create(radiusList, numberList[, dMax[, dMin[, indexChange]]]) -> retval
Link to this function

create(thresh, octaves, radiusList, numberList)

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

The BRISK constructor for a custom pattern, detection threshold and octaves

Positional Arguments
  • thresh: integer().

    AGAST detection threshold score.

  • octaves: integer().

    detection octaves. Use 0 to do single scale.

  • radiusList: [float].

    defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).

  • numberList: [integer()].

    defines the number of sampling points on the sampling circle. Must be the same size as radiusList..

Keyword Arguments
  • dMax: float.

    threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).

  • dMin: float.

    threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).

  • indexChange: [integer()].

    index remapping of the bits.

Return
  • retval: Evision.BRISK.t()

Python prototype (for reference only):

create(thresh, octaves, radiusList, numberList[, dMax[, dMin[, indexChange]]]) -> retval
Link to this function

create(thresh, octaves, radiusList, numberList, opts)

View Source
@spec create(
  integer(),
  integer(),
  [number()],
  [integer()],
  [dMax: term(), dMin: term(), indexChange: term()] | nil
) :: t() | {:error, String.t()}

The BRISK constructor for a custom pattern, detection threshold and octaves

Positional Arguments
  • thresh: integer().

    AGAST detection threshold score.

  • octaves: integer().

    detection octaves. Use 0 to do single scale.

  • radiusList: [float].

    defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).

  • numberList: [integer()].

    defines the number of sampling points on the sampling circle. Must be the same size as radiusList..

Keyword Arguments
  • dMax: float.

    threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).

  • dMin: float.

    threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).

  • indexChange: [integer()].

    index remapping of the bits.

Return
  • retval: Evision.BRISK.t()

Python prototype (for reference only):

create(thresh, octaves, radiusList, numberList[, dMax[, dMin[, indexChange]]]) -> retval
@spec defaultNorm(t()) :: integer() | {:error, String.t()}

defaultNorm

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

Python prototype (for reference only):

defaultNorm() -> retval
@spec descriptorSize(t()) :: integer() | {:error, String.t()}

descriptorSize

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

Python prototype (for reference only):

descriptorSize() -> retval
@spec descriptorType(t()) :: integer() | {:error, String.t()}

descriptorType

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

Python prototype (for reference only):

descriptorType() -> retval
@spec detect(t(), [Evision.Mat.maybe_mat_in()]) ::
  [[Evision.KeyPoint.t()]] | {:error, String.t()}
@spec detect(t(), Evision.Mat.maybe_mat_in()) ::
  [Evision.KeyPoint.t()] | {:error, String.t()}

Variant 1:

detect

Positional Arguments
  • self: Evision.BRISK.t()

  • images: [Evision.Mat].

    Image set.

Keyword Arguments
  • masks: [Evision.Mat].

    Masks for each input image specifying where to look for keypoints (optional). masks[i] is a mask for images[i].

Return
  • keypoints: [[Evision.KeyPoint]].

    The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] .

Has overloading in C++

Python prototype (for reference only):

detect(images[, masks]) -> keypoints

Variant 2:

Detects keypoints in an image (first variant) or image set (second variant).

Positional Arguments
Keyword Arguments
  • mask: Evision.Mat.

    Mask specifying where to look for keypoints (optional). It must be a 8-bit integer matrix with non-zero values in the region of interest.

Return
  • keypoints: [Evision.KeyPoint].

    The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] .

Python prototype (for reference only):

detect(image[, mask]) -> keypoints
Link to this function

detect(self, images, opts)

View Source
@spec detect(t(), [Evision.Mat.maybe_mat_in()], [{:masks, term()}] | nil) ::
  [[Evision.KeyPoint.t()]] | {:error, String.t()}
@spec detect(t(), Evision.Mat.maybe_mat_in(), [{:mask, term()}] | nil) ::
  [Evision.KeyPoint.t()] | {:error, String.t()}

Variant 1:

detect

Positional Arguments
  • self: Evision.BRISK.t()

  • images: [Evision.Mat].

    Image set.

Keyword Arguments
  • masks: [Evision.Mat].

    Masks for each input image specifying where to look for keypoints (optional). masks[i] is a mask for images[i].

Return
  • keypoints: [[Evision.KeyPoint]].

    The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] .

Has overloading in C++

Python prototype (for reference only):

detect(images[, masks]) -> keypoints

Variant 2:

Detects keypoints in an image (first variant) or image set (second variant).

Positional Arguments
Keyword Arguments
  • mask: Evision.Mat.

    Mask specifying where to look for keypoints (optional). It must be a 8-bit integer matrix with non-zero values in the region of interest.

Return
  • keypoints: [Evision.KeyPoint].

    The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] .

Python prototype (for reference only):

detect(image[, mask]) -> keypoints
Link to this function

detectAndCompute(self, image, mask)

View Source
@spec detectAndCompute(t(), Evision.Mat.maybe_mat_in(), Evision.Mat.maybe_mat_in()) ::
  {[Evision.KeyPoint.t()], Evision.Mat.t()} | {:error, String.t()}

detectAndCompute

Positional Arguments
Keyword Arguments
  • useProvidedKeypoints: bool.
Return
  • keypoints: [Evision.KeyPoint]
  • descriptors: Evision.Mat.t().

Detects keypoints and computes the descriptors

Python prototype (for reference only):

detectAndCompute(image, mask[, descriptors[, useProvidedKeypoints]]) -> keypoints, descriptors
Link to this function

detectAndCompute(self, image, mask, opts)

View Source
@spec detectAndCompute(
  t(),
  Evision.Mat.maybe_mat_in(),
  Evision.Mat.maybe_mat_in(),
  [{:useProvidedKeypoints, term()}] | nil
) :: {[Evision.KeyPoint.t()], Evision.Mat.t()} | {:error, String.t()}

detectAndCompute

Positional Arguments
Keyword Arguments
  • useProvidedKeypoints: bool.
Return
  • keypoints: [Evision.KeyPoint]
  • descriptors: Evision.Mat.t().

Detects keypoints and computes the descriptors

Python prototype (for reference only):

detectAndCompute(image, mask[, descriptors[, useProvidedKeypoints]]) -> keypoints, descriptors
@spec empty(t()) :: boolean() | {:error, String.t()}

empty

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

Python prototype (for reference only):

empty() -> retval
@spec getDefaultName(t()) :: binary() | {:error, String.t()}

getDefaultName

Positional Arguments
  • self: Evision.BRISK.t()
Return

Python prototype (for reference only):

getDefaultName() -> retval
@spec getOctaves(t()) :: integer() | {:error, String.t()}

getOctaves

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

Python prototype (for reference only):

getOctaves() -> retval
@spec getPatternScale(t()) :: number() | {:error, String.t()}

getPatternScale

Positional Arguments
  • self: Evision.BRISK.t()
Return
  • retval: float

Python prototype (for reference only):

getPatternScale() -> retval
@spec getThreshold(t()) :: integer() | {:error, String.t()}

getThreshold

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

Python prototype (for reference only):

getThreshold() -> retval
@spec read(t(), Evision.FileNode.t()) :: t() | {:error, String.t()}
@spec read(t(), binary()) :: t() | {:error, String.t()}

Variant 1:

read

Positional Arguments

Python prototype (for reference only):

read(arg1) -> None

Variant 2:

read

Positional Arguments
  • self: Evision.BRISK.t()
  • fileName: String

Python prototype (for reference only):

read(fileName) -> None
Link to this function

setOctaves(self, octaves)

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

Set detection octaves.

Positional Arguments
  • self: Evision.BRISK.t()

  • octaves: integer().

    detection octaves. Use 0 to do single scale.

Python prototype (for reference only):

setOctaves(octaves) -> None
Link to this function

setPatternScale(self, patternScale)

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

Set detection patternScale.

Positional Arguments
  • self: Evision.BRISK.t()

  • patternScale: float.

    apply this scale to the pattern used for sampling the neighbourhood of a keypoint.

Python prototype (for reference only):

setPatternScale(patternScale) -> None
Link to this function

setThreshold(self, threshold)

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

Set detection threshold.

Positional Arguments
  • self: Evision.BRISK.t()

  • threshold: integer().

    AGAST detection threshold score.

Python prototype (for reference only):

setThreshold(threshold) -> None
@spec write(t(), binary()) :: t() | {:error, String.t()}

write

Positional Arguments
  • self: Evision.BRISK.t()
  • fileName: String

Python prototype (for reference only):

write(fileName) -> None
@spec write(t(), Evision.FileStorage.t(), binary()) :: t() | {:error, String.t()}

write

Positional Arguments

Python prototype (for reference only):

write(fs, name) -> None