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

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

Clears the algorithm state

Positional Arguments

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

Python prototype (for reference only):

clear() -> None

@spec computeQuadraticFormDistance(
  t(),
  Evision.Mat.maybe_mat_in(),
  Evision.Mat.maybe_mat_in()
) ::
  number() | {:error, String.t()}

Computes Signature Quadratic Form Distance of two signatures.

Positional Arguments

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

• signature0: Evision.Mat.

  The first signature.

• signature1: Evision.Mat.

  The second signature.

Return

• retval: float

Python prototype (for reference only):

computeQuadraticFormDistance(_signature0, _signature1) -> retval

@spec computeQuadraticFormDistances(
  t(),
  Evision.Mat.maybe_mat_in(),
  [Evision.Mat.maybe_mat_in()],
  [
    number()
  ]
) :: t() | {:error, String.t()}

Computes Signature Quadratic Form Distance between the reference signature and each of the other image signatures.

Positional Arguments

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

• sourceSignature: Evision.Mat.

  The signature to measure distance of other signatures from.

• imageSignatures: [Evision.Mat].

  Vector of signatures to measure distance from the source signature.

• distances: [float].

  Output vector of measured distances.

Python prototype (for reference only):

computeQuadraticFormDistances(sourceSignature, imageSignatures, distances) -> None

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

Creates the algorithm instance using selected distance function, similarity function and similarity function parameter.

Keyword Arguments

• distanceFunction: integer().

  Distance function selector. Default: L2 Available: L0_25, L0_5, L1, L2, L2SQUARED, L5, L_INFINITY

• similarityFunction: integer().

  Similarity function selector. Default: HEURISTIC Available: MINUS, GAUSSIAN, HEURISTIC

• similarityParameter: float.

  Parameter of the similarity function.

Return

• retval: PCTSignaturesSQFD

Python prototype (for reference only):

create([, distanceFunction[, similarityFunction[, similarityParameter]]]) -> retval

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

@spec create(
  [
    distanceFunction: term(),
    similarityFunction: term(),
    similarityParameter: term()
  ]
  | nil
) ::
  t() | {:error, String.t()}

Creates the algorithm instance using selected distance function, similarity function and similarity function parameter.

Keyword Arguments

• distanceFunction: integer().

  Distance function selector. Default: L2 Available: L0_25, L0_5, L1, L2, L2SQUARED, L5, L_INFINITY

• similarityFunction: integer().

  Similarity function selector. Default: HEURISTIC Available: MINUS, GAUSSIAN, HEURISTIC

• similarityParameter: float.

  Parameter of the similarity function.

Return

• retval: PCTSignaturesSQFD

Python prototype (for reference only):

create([, distanceFunction[, similarityFunction[, similarityParameter]]]) -> retval

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

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

Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read

Positional Arguments

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

Return

• retval: String

Returns the algorithm string identifier. This string is used as top level xml/yml node tag when the object is saved to a file or string.

Python prototype (for reference only):

getDefaultName() -> retval

@spec read(t(), Evision.FileNode.t()) :: t() | {:error, String.t()}

Reads algorithm parameters from a file storage

Positional Arguments

• self: Evision.XFeatures2D.PCTSignaturesSQFD.t()
• func: Evision.FileNode

Python prototype (for reference only):

read(fn) -> None

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

save

Positional Arguments

• self: Evision.XFeatures2D.PCTSignaturesSQFD.t()
• filename: String

Saves the algorithm to a file. In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).

Python prototype (for reference only):

save(filename) -> None

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

Stores algorithm parameters in a file storage

Positional Arguments

• self: Evision.XFeatures2D.PCTSignaturesSQFD.t()
• fs: Evision.FileStorage

Python prototype (for reference only):

write(fs) -> None

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

write

Positional Arguments

• self: Evision.XFeatures2D.PCTSignaturesSQFD.t()
• fs: Evision.FileStorage
• name: String

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None