View Source Evision.XFeatures2D.MSDDetector (Evision v0.1.28)

Link to this section Summary

Types

t()

Type that represents an XFeatures2D.MSDDetector struct.

Link to this section Types

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

Type that represents an XFeatures2D.MSDDetector struct.

  • ref. reference()

    The underlying erlang resource variable.

Link to this section 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.XFeatures2D.MSDDetector.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
  • self: Evision.XFeatures2D.MSDDetector.t()

  • image: Evision.Mat.t().

    Image.

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.XFeatures2D.MSDDetector.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
  • self: Evision.XFeatures2D.MSDDetector.t()

  • image: Evision.Mat.t().

    Image.

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()}

create

Keyword Arguments
  • m_patch_radius: int.
  • m_search_area_radius: int.
  • m_nms_radius: int.
  • m_nms_scale_radius: int.
  • m_th_saliency: float.
  • m_kNN: int.
  • m_scale_factor: float.
  • m_n_scales: int.
  • m_compute_orientation: bool.
Return
  • retval: MSDDetector

Python prototype (for reference only):

create([, m_patch_radius[, m_search_area_radius[, m_nms_radius[, m_nms_scale_radius[, m_th_saliency[, m_kNN[, m_scale_factor[, m_n_scales[, m_compute_orientation]]]]]]]]]) -> retval
@spec create([{atom(), term()}, ...] | nil) :: t() | {:error, String.t()}

create

Keyword Arguments
  • m_patch_radius: int.
  • m_search_area_radius: int.
  • m_nms_radius: int.
  • m_nms_scale_radius: int.
  • m_th_saliency: float.
  • m_kNN: int.
  • m_scale_factor: float.
  • m_n_scales: int.
  • m_compute_orientation: bool.
Return
  • retval: MSDDetector

Python prototype (for reference only):

create([, m_patch_radius[, m_search_area_radius[, m_nms_radius[, m_nms_scale_radius[, m_th_saliency[, m_kNN[, m_scale_factor[, m_n_scales[, m_compute_orientation]]]]]]]]]) -> retval
@spec defaultNorm(t()) :: integer() | {:error, String.t()}

defaultNorm

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
Return
  • retval: int

Python prototype (for reference only):

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

descriptorSize

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
Return
  • retval: int

Python prototype (for reference only):

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

descriptorType

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
Return
  • retval: int

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.XFeatures2D.MSDDetector.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
  • self: Evision.XFeatures2D.MSDDetector.t()

  • image: Evision.Mat.t().

    Image.

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

    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()], [{atom(), term()}, ...] | nil) ::
  [[Evision.KeyPoint.t()]] | {:error, String.t()}
@spec detect(t(), Evision.Mat.maybe_mat_in(), [{atom(), term()}, ...] | nil) ::
  [Evision.KeyPoint.t()] | {:error, String.t()}

Variant 1:

detect

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.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
  • self: Evision.XFeatures2D.MSDDetector.t()

  • image: Evision.Mat.t().

    Image.

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

    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
  • self: Evision.XFeatures2D.MSDDetector.t()
  • image: Evision.Mat.t()
  • mask: Evision.Mat.t()
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(),
  [{atom(), term()}, ...] | nil
) :: {[Evision.KeyPoint.t()], Evision.Mat.t()} | {:error, String.t()}

detectAndCompute

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
  • image: Evision.Mat.t()
  • mask: Evision.Mat.t()
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.XFeatures2D.MSDDetector.t()
Return
  • retval: bool

Python prototype (for reference only):

empty() -> retval
Link to this function

getComputeOrientation(self)

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

getComputeOrientation

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

Python prototype (for reference only):

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

getDefaultName

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
Return

Python prototype (for reference only):

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

getKNN

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
Return
  • retval: int

Python prototype (for reference only):

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

getNmsRadius

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
Return
  • retval: int

Python prototype (for reference only):

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

getNmsScaleRadius

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
Return
  • retval: int

Python prototype (for reference only):

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

getNScales

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
Return
  • retval: int

Python prototype (for reference only):

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

getPatchRadius

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
Return
  • retval: int

Python prototype (for reference only):

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

getScaleFactor

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

Python prototype (for reference only):

getScaleFactor() -> retval
Link to this function

getSearchAreaRadius(self)

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

getSearchAreaRadius

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
Return
  • retval: int

Python prototype (for reference only):

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

getThSaliency

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

Python prototype (for reference only):

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

Variant 1:

read

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
  • arg1: Evision.FileNode.t()

Python prototype (for reference only):

read(arg1) -> None

Variant 2:

read

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

Python prototype (for reference only):

read(fileName) -> None
Link to this function

setComputeOrientation(self, compute_orientation)

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

setComputeOrientation

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
  • compute_orientation: bool

Python prototype (for reference only):

setComputeOrientation(compute_orientation) -> None
@spec setKNN(t(), integer()) :: t() | {:error, String.t()}

setKNN

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
  • kNN: int

Python prototype (for reference only):

setKNN(kNN) -> None
Link to this function

setNmsRadius(self, nms_radius)

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

setNmsRadius

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
  • nms_radius: int

Python prototype (for reference only):

setNmsRadius(nms_radius) -> None
Link to this function

setNmsScaleRadius(self, nms_scale_radius)

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

setNmsScaleRadius

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
  • nms_scale_radius: int

Python prototype (for reference only):

setNmsScaleRadius(nms_scale_radius) -> None
Link to this function

setNScales(self, use_orientation)

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

setNScales

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
  • use_orientation: int

Python prototype (for reference only):

setNScales(use_orientation) -> None
Link to this function

setPatchRadius(self, patch_radius)

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

setPatchRadius

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
  • patch_radius: int

Python prototype (for reference only):

setPatchRadius(patch_radius) -> None
Link to this function

setScaleFactor(self, scale_factor)

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

setScaleFactor

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
  • scale_factor: float

Python prototype (for reference only):

setScaleFactor(scale_factor) -> None
Link to this function

setSearchAreaRadius(self, use_orientation)

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

setSearchAreaRadius

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
  • use_orientation: int

Python prototype (for reference only):

setSearchAreaRadius(use_orientation) -> None
Link to this function

setThSaliency(self, th_saliency)

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

setThSaliency

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.t()
  • th_saliency: float

Python prototype (for reference only):

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

write

Positional Arguments
  • self: Evision.XFeatures2D.MSDDetector.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
  • self: Evision.XFeatures2D.MSDDetector.t()
  • fs: Evision.FileStorage.t()
  • name: String

Python prototype (for reference only):

write(fs, name) -> None