@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.SURF.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.SURF.t()

• image: Evision.Mat.

  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 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.SURF.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.SURF.t()

• image: Evision.Mat.

  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

• hessianThreshold: double.

  Threshold for hessian keypoint detector used in SURF.

• nOctaves: integer().

  Number of pyramid octaves the keypoint detector will use.

• nOctaveLayers: integer().

  Number of octave layers within each octave.

• extended: bool.

  Extended descriptor flag (true - use extended 128-element descriptors; false - use 64-element descriptors).

• upright: bool.

  Up-right or rotated features flag (true - do not compute orientation of features; false - compute orientation).

Return

• retval: SURF

Python prototype (for reference only):

create([, hessianThreshold[, nOctaves[, nOctaveLayers[, extended[, upright]]]]]) -> retval

@spec create(Keyword.t()) :: any() | {:error, String.t()}

@spec create(
  [
    extended: term(),
    hessianThreshold: term(),
    nOctaveLayers: term(),
    nOctaves: term(),
    upright: term()
  ]
  | nil
) :: t() | {:error, String.t()}

create

Keyword Arguments

• hessianThreshold: double.

  Threshold for hessian keypoint detector used in SURF.

• nOctaves: integer().

  Number of pyramid octaves the keypoint detector will use.

• nOctaveLayers: integer().

  Number of octave layers within each octave.

• extended: bool.

  Extended descriptor flag (true - use extended 128-element descriptors; false - use 64-element descriptors).

• upright: bool.

  Up-right or rotated features flag (true - do not compute orientation of features; false - compute orientation).

Return

• retval: SURF

Python prototype (for reference only):

create([, hessianThreshold[, nOctaves[, nOctaveLayers[, extended[, upright]]]]]) -> retval

@spec defaultNorm(Keyword.t()) :: any() | {:error, String.t()}

@spec defaultNorm(t()) :: integer() | {:error, String.t()}

defaultNorm

Positional Arguments

• self: Evision.XFeatures2D.SURF.t()

Return

• retval: integer()

Python prototype (for reference only):

defaultNorm() -> retval

@spec descriptorSize(Keyword.t()) :: any() | {:error, String.t()}

@spec descriptorSize(t()) :: integer() | {:error, String.t()}

descriptorSize

Positional Arguments

• self: Evision.XFeatures2D.SURF.t()

Return

• retval: integer()

Python prototype (for reference only):

descriptorSize() -> retval

@spec descriptorType(Keyword.t()) :: any() | {:error, String.t()}

@spec descriptorType(t()) :: integer() | {:error, String.t()}

descriptorType

Positional Arguments

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

• image: Evision.Mat.

  Image.

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

@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.XFeatures2D.SURF.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.SURF.t()

• image: Evision.Mat.

  Image.

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

@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.SURF.t()
• image: Evision.Mat
• mask: Evision.Mat

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 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

• self: Evision.XFeatures2D.SURF.t()
• image: Evision.Mat
• mask: Evision.Mat

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(Keyword.t()) :: any() | {:error, String.t()}

@spec empty(t()) :: boolean() | {:error, String.t()}

empty

Positional Arguments

• self: Evision.XFeatures2D.SURF.t()

Return

• retval: bool

Python prototype (for reference only):

empty() -> retval

@spec getDefaultName(Keyword.t()) :: any() | {:error, String.t()}

@spec getDefaultName(t()) :: binary() | {:error, String.t()}

getDefaultName

Positional Arguments

• self: Evision.XFeatures2D.SURF.t()

Return

• retval: String

Python prototype (for reference only):

getDefaultName() -> retval

@spec getExtended(Keyword.t()) :: any() | {:error, String.t()}

@spec getExtended(t()) :: boolean() | {:error, String.t()}

getExtended

Positional Arguments

• self: Evision.XFeatures2D.SURF.t()

Return

• retval: bool

Python prototype (for reference only):

getExtended() -> retval

@spec getHessianThreshold(Keyword.t()) :: any() | {:error, String.t()}

@spec getHessianThreshold(t()) :: number() | {:error, String.t()}

getHessianThreshold

Positional Arguments

• self: Evision.XFeatures2D.SURF.t()

Return

• retval: double

Python prototype (for reference only):

getHessianThreshold() -> retval

@spec getNOctaveLayers(Keyword.t()) :: any() | {:error, String.t()}

@spec getNOctaveLayers(t()) :: integer() | {:error, String.t()}

getNOctaveLayers

Positional Arguments

• self: Evision.XFeatures2D.SURF.t()

Return

• retval: integer()

Python prototype (for reference only):

getNOctaveLayers() -> retval

@spec getNOctaves(Keyword.t()) :: any() | {:error, String.t()}

@spec getNOctaves(t()) :: integer() | {:error, String.t()}

getNOctaves

Positional Arguments

• self: Evision.XFeatures2D.SURF.t()

Return

• retval: integer()

Python prototype (for reference only):

getNOctaves() -> retval

@spec getUpright(Keyword.t()) :: any() | {:error, String.t()}

@spec getUpright(t()) :: boolean() | {:error, String.t()}

getUpright

Positional Arguments

• self: Evision.XFeatures2D.SURF.t()

Return

• retval: bool

Python prototype (for reference only):

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

Python prototype (for reference only):

read(arg1) -> None

Variant 2:

read

Positional Arguments

• self: Evision.XFeatures2D.SURF.t()
• fileName: String

Python prototype (for reference only):

read(fileName) -> None

@spec setExtended(t(), boolean()) :: t() | {:error, String.t()}

setExtended

Positional Arguments

• self: Evision.XFeatures2D.SURF.t()
• extended: bool

Python prototype (for reference only):

setExtended(extended) -> None

@spec setHessianThreshold(t(), number()) :: t() | {:error, String.t()}

setHessianThreshold

Positional Arguments

• self: Evision.XFeatures2D.SURF.t()
• hessianThreshold: double

Python prototype (for reference only):

setHessianThreshold(hessianThreshold) -> None

@spec setNOctaveLayers(t(), integer()) :: t() | {:error, String.t()}

setNOctaveLayers

Positional Arguments

• self: Evision.XFeatures2D.SURF.t()
• nOctaveLayers: integer()

Python prototype (for reference only):

setNOctaveLayers(nOctaveLayers) -> None

@spec setNOctaves(t(), integer()) :: t() | {:error, String.t()}

setNOctaves

Positional Arguments

• self: Evision.XFeatures2D.SURF.t()
• nOctaves: integer()

Python prototype (for reference only):

setNOctaves(nOctaves) -> None

@spec setUpright(t(), boolean()) :: t() | {:error, String.t()}

setUpright

Positional Arguments

• self: Evision.XFeatures2D.SURF.t()
• upright: bool

Python prototype (for reference only):

setUpright(upright) -> None

@spec write(t(), binary()) :: t() | {:error, String.t()}

write

Positional Arguments

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

Python prototype (for reference only):

write(fs, name) -> None