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

Link to this section Summary

Types

t()

Type that represents an XFeatures2D.StarDetector struct.

Link to this section Types

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

Type that represents an XFeatures2D.StarDetector 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.StarDetector.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.StarDetector.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.StarDetector.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.StarDetector.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
  • maxSize: int.
  • responseThreshold: int.
  • lineThresholdProjected: int.
  • lineThresholdBinarized: int.
  • suppressNonmaxSize: int.
Return
  • retval: StarDetector

Python prototype (for reference only):

create([, maxSize[, responseThreshold[, lineThresholdProjected[, lineThresholdBinarized[, suppressNonmaxSize]]]]]) -> retval
@spec create([{atom(), term()}, ...] | nil) :: t() | {:error, String.t()}

create

Keyword Arguments
  • maxSize: int.
  • responseThreshold: int.
  • lineThresholdProjected: int.
  • lineThresholdBinarized: int.
  • suppressNonmaxSize: int.
Return
  • retval: StarDetector

Python prototype (for reference only):

create([, maxSize[, responseThreshold[, lineThresholdProjected[, lineThresholdBinarized[, suppressNonmaxSize]]]]]) -> retval
@spec defaultNorm(t()) :: integer() | {:error, String.t()}

defaultNorm

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

Python prototype (for reference only):

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

descriptorSize

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

Python prototype (for reference only):

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

descriptorType

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

Python prototype (for reference only):

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

getDefaultName

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

Python prototype (for reference only):

getDefaultName() -> retval
Link to this function

getLineThresholdBinarized(self)

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

getLineThresholdBinarized

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

Python prototype (for reference only):

getLineThresholdBinarized() -> retval
Link to this function

getLineThresholdProjected(self)

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

getLineThresholdProjected

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

Python prototype (for reference only):

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

getMaxSize

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

Python prototype (for reference only):

getMaxSize() -> retval
Link to this function

getResponseThreshold(self)

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

getResponseThreshold

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

Python prototype (for reference only):

getResponseThreshold() -> retval
Link to this function

getSuppressNonmaxSize(self)

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

getSuppressNonmaxSize

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

Python prototype (for reference only):

getSuppressNonmaxSize() -> 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.StarDetector.t()
  • arg1: Evision.FileNode.t()

Python prototype (for reference only):

read(arg1) -> None

Variant 2:

read

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

Python prototype (for reference only):

read(fileName) -> None
Link to this function

setLineThresholdBinarized(self, lineThresholdBinarized)

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

setLineThresholdBinarized

Positional Arguments
  • self: Evision.XFeatures2D.StarDetector.t()
  • lineThresholdBinarized: int

Python prototype (for reference only):

setLineThresholdBinarized(_lineThresholdBinarized) -> None
Link to this function

setLineThresholdProjected(self, lineThresholdProjected)

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

setLineThresholdProjected

Positional Arguments
  • self: Evision.XFeatures2D.StarDetector.t()
  • lineThresholdProjected: int

Python prototype (for reference only):

setLineThresholdProjected(_lineThresholdProjected) -> None
Link to this function

setMaxSize(self, maxSize)

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

setMaxSize

Positional Arguments
  • self: Evision.XFeatures2D.StarDetector.t()
  • maxSize: int

Python prototype (for reference only):

setMaxSize(_maxSize) -> None
Link to this function

setResponseThreshold(self, responseThreshold)

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

setResponseThreshold

Positional Arguments
  • self: Evision.XFeatures2D.StarDetector.t()
  • responseThreshold: int

Python prototype (for reference only):

setResponseThreshold(_responseThreshold) -> None
Link to this function

setSuppressNonmaxSize(self, suppressNonmaxSize)

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

setSuppressNonmaxSize

Positional Arguments
  • self: Evision.XFeatures2D.StarDetector.t()
  • suppressNonmaxSize: int

Python prototype (for reference only):

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

write

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

Python prototype (for reference only):

write(fs, name) -> None