View Source Evision.GFTTDetector (Evision v0.1.38)

Summary

Types

t()

Type that represents an GFTTDetector struct.

Types

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

Type that represents an GFTTDetector 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.GFTTDetector.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.GFTTDetector.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.GFTTDetector.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.GFTTDetector.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
  • maxCorners: int.
  • qualityLevel: double.
  • minDistance: double.
  • blockSize: int.
  • useHarrisDetector: bool.
  • k: double.
Return
  • retval: Evision.GFTTDetector.t()

Python prototype (for reference only):

create([, maxCorners[, qualityLevel[, minDistance[, blockSize[, useHarrisDetector[, k]]]]]]) -> retval
@spec create([{atom(), term()}, ...] | nil) :: t() | {:error, String.t()}

create

Keyword Arguments
  • maxCorners: int.
  • qualityLevel: double.
  • minDistance: double.
  • blockSize: int.
  • useHarrisDetector: bool.
  • k: double.
Return
  • retval: Evision.GFTTDetector.t()

Python prototype (for reference only):

create([, maxCorners[, qualityLevel[, minDistance[, blockSize[, useHarrisDetector[, k]]]]]]) -> retval
Link to this function

create(maxCorners, qualityLevel, minDistance, blockSize, gradiantSize)

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

create

Positional Arguments
  • maxCorners: int
  • qualityLevel: double
  • minDistance: double
  • blockSize: int
  • gradiantSize: int
Keyword Arguments
  • useHarrisDetector: bool.
  • k: double.
Return
  • retval: Evision.GFTTDetector.t()

Python prototype (for reference only):

create(maxCorners, qualityLevel, minDistance, blockSize, gradiantSize[, useHarrisDetector[, k]]) -> retval
Link to this function

create(maxCorners, qualityLevel, minDistance, blockSize, gradiantSize, opts)

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

create

Positional Arguments
  • maxCorners: int
  • qualityLevel: double
  • minDistance: double
  • blockSize: int
  • gradiantSize: int
Keyword Arguments
  • useHarrisDetector: bool.
  • k: double.
Return
  • retval: Evision.GFTTDetector.t()

Python prototype (for reference only):

create(maxCorners, qualityLevel, minDistance, blockSize, gradiantSize[, useHarrisDetector[, k]]) -> retval
@spec defaultNorm(t()) :: integer() | {:error, String.t()}

defaultNorm

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

Python prototype (for reference only):

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

descriptorSize

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

Python prototype (for reference only):

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

descriptorType

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

Python prototype (for reference only):

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

getBlockSize

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

Python prototype (for reference only):

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

getDefaultName

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

Python prototype (for reference only):

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

getGradientSize

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

Python prototype (for reference only):

getGradientSize() -> retval
@spec getHarrisDetector(t()) :: boolean() | {:error, String.t()}

getHarrisDetector

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

Python prototype (for reference only):

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

getK

Positional Arguments
  • self: Evision.GFTTDetector.t()
Return
  • retval: double

Python prototype (for reference only):

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

getMaxFeatures

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

Python prototype (for reference only):

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

getMinDistance

Positional Arguments
  • self: Evision.GFTTDetector.t()
Return
  • retval: double

Python prototype (for reference only):

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

getQualityLevel

Positional Arguments
  • self: Evision.GFTTDetector.t()
Return
  • retval: double

Python prototype (for reference only):

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

Python prototype (for reference only):

read(arg1) -> None

Variant 2:

read

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

Python prototype (for reference only):

read(fileName) -> None
Link to this function

setBlockSize(self, blockSize)

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

setBlockSize

Positional Arguments
  • self: Evision.GFTTDetector.t()
  • blockSize: int

Python prototype (for reference only):

setBlockSize(blockSize) -> None
Link to this function

setGradientSize(self, gradientSize_)

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

setGradientSize

Positional Arguments
  • self: Evision.GFTTDetector.t()
  • gradientSize_: int

Python prototype (for reference only):

setGradientSize(gradientSize_) -> None
Link to this function

setHarrisDetector(self, val)

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

setHarrisDetector

Positional Arguments
  • self: Evision.GFTTDetector.t()
  • val: bool

Python prototype (for reference only):

setHarrisDetector(val) -> None
@spec setK(t(), number()) :: t() | {:error, String.t()}

setK

Positional Arguments
  • self: Evision.GFTTDetector.t()
  • k: double

Python prototype (for reference only):

setK(k) -> None
Link to this function

setMaxFeatures(self, maxFeatures)

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

setMaxFeatures

Positional Arguments
  • self: Evision.GFTTDetector.t()
  • maxFeatures: int

Python prototype (for reference only):

setMaxFeatures(maxFeatures) -> None
Link to this function

setMinDistance(self, minDistance)

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

setMinDistance

Positional Arguments
  • self: Evision.GFTTDetector.t()
  • minDistance: double

Python prototype (for reference only):

setMinDistance(minDistance) -> None
Link to this function

setQualityLevel(self, qlevel)

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

setQualityLevel

Positional Arguments
  • self: Evision.GFTTDetector.t()
  • qlevel: double

Python prototype (for reference only):

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

write

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

Python prototype (for reference only):

write(fs, name) -> None