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

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

Clears the algorithm state

Positional Arguments

• self: Evision.LineDescriptor.BinaryDescriptor.t()

Python prototype (for reference only):

clear() -> None

@spec compute(t(), Evision.Mat.maybe_mat_in(), [Evision.LineDescriptor.KeyLine.t()]) ::
  {[Evision.LineDescriptor.KeyLine.t()], Evision.Mat.t()} | {:error, String.t()}

Requires descriptors computation

Positional Arguments

• self: Evision.LineDescriptor.BinaryDescriptor.t()

• image: Evision.Mat.

  input image

Keyword Arguments

• returnFloatDescr: bool.

  flag (when set to true, original non-binary descriptors are returned)

Return

• keylines: [Evision.LineDescriptor.KeyLine].

  vector containing lines for which descriptors must be computed

• descriptors: Evision.Mat.t().

Python prototype (for reference only):

compute(image, keylines[, descriptors[, returnFloatDescr]]) -> keylines, descriptors

@spec compute(
  t(),
  Evision.Mat.maybe_mat_in(),
  [Evision.LineDescriptor.KeyLine.t()],
  [{:returnFloatDescr, term()}] | nil
) ::
  {[Evision.LineDescriptor.KeyLine.t()], Evision.Mat.t()} | {:error, String.t()}

Requires descriptors computation

Positional Arguments

• self: Evision.LineDescriptor.BinaryDescriptor.t()

• image: Evision.Mat.

  input image

Keyword Arguments

• returnFloatDescr: bool.

  flag (when set to true, original non-binary descriptors are returned)

Return

• keylines: [Evision.LineDescriptor.KeyLine].

  vector containing lines for which descriptors must be computed

• descriptors: Evision.Mat.t().

Python prototype (for reference only):

compute(image, keylines[, descriptors[, returnFloatDescr]]) -> keylines, descriptors

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

Create a BinaryDescriptor object with default parameters (or with the ones provided) and return a smart pointer to it

Return

• retval: Evision.LineDescriptor.BinaryDescriptor.t()

Python prototype (for reference only):

createBinaryDescriptor() -> retval

@spec detect(t(), Evision.Mat.maybe_mat_in()) ::
  [Evision.LineDescriptor.KeyLine.t()] | {:error, String.t()}

Requires line detection

Positional Arguments

• self: Evision.LineDescriptor.BinaryDescriptor.t()

• image: Evision.Mat.

  input image

Keyword Arguments

• mask: Evision.Mat.

  mask matrix to detect only KeyLines of interest

Return

• keypoints: [Evision.LineDescriptor.KeyLine].

  vector that will store extracted lines for one or more images

Python prototype (for reference only):

detect(image[, mask]) -> keypoints

@spec detect(t(), Evision.Mat.maybe_mat_in(), [{:mask, term()}] | nil) ::
  [Evision.LineDescriptor.KeyLine.t()] | {:error, String.t()}

Requires line detection

Positional Arguments

• self: Evision.LineDescriptor.BinaryDescriptor.t()

• image: Evision.Mat.

  input image

Keyword Arguments

• mask: Evision.Mat.

  mask matrix to detect only KeyLines of interest

Return

• keypoints: [Evision.LineDescriptor.KeyLine].

  vector that will store extracted lines for one or more images

Python prototype (for reference only):

detect(image[, mask]) -> keypoints

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

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

Get current number of octaves

Positional Arguments

• self: Evision.LineDescriptor.BinaryDescriptor.t()

Return

• retval: integer()

Python prototype (for reference only):

getNumOfOctaves() -> retval

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

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

Get current reduction ratio (used in Gaussian pyramids)

Positional Arguments

• self: Evision.LineDescriptor.BinaryDescriptor.t()

Return

• retval: integer()

Python prototype (for reference only):

getReductionRatio() -> retval

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

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

Get current width of bands

Positional Arguments

• self: Evision.LineDescriptor.BinaryDescriptor.t()

Return

• retval: integer()

Python prototype (for reference only):

getWidthOfBand() -> retval

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

Reads algorithm parameters from a file storage

Positional Arguments

• self: Evision.LineDescriptor.BinaryDescriptor.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.LineDescriptor.BinaryDescriptor.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 setNumOfOctaves(t(), integer()) :: t() | {:error, String.t()}

Set number of octaves

Positional Arguments

• self: Evision.LineDescriptor.BinaryDescriptor.t()

• octaves: integer().

  number of octaves

Python prototype (for reference only):

setNumOfOctaves(octaves) -> None

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

Set reduction ratio (used in Gaussian pyramids)

Positional Arguments

• self: Evision.LineDescriptor.BinaryDescriptor.t()

• rRatio: integer().

  reduction ratio

Python prototype (for reference only):

setReductionRatio(rRatio) -> None

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

Set width of bands

Positional Arguments

• self: Evision.LineDescriptor.BinaryDescriptor.t()

• width: integer().

  width of bands

Python prototype (for reference only):

setWidthOfBand(width) -> None

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

Stores algorithm parameters in a file storage

Positional Arguments

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

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None