View Source Evision.Face.BIF (Evision v0.1.34)

Summary

Types

t()

Type that represents an Face.BIF struct.

Functions

Clears the algorithm state

create

create

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

getDefaultName

getNumBands

getNumRotations

Reads algorithm parameters from a file storage

Stores algorithm parameters in a file storage

Types

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

Type that represents an Face.BIF struct.

  • ref. reference()

    The underlying erlang resource variable.

Functions

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

Clears the algorithm state

Positional Arguments
  • self: Evision.Face.BIF.t()

Python prototype (for reference only):

clear() -> None
@spec compute(t(), Evision.Mat.maybe_mat_in()) ::
  Evision.Mat.t() | {:error, String.t()}

compute

Positional Arguments
  • self: Evision.Face.BIF.t()

  • image: Evision.Mat.t().

    Input image (CV_32FC1).

Return
  • features: Evision.Mat.t().

    Feature vector (CV_32FC1).

Computes features sby input image.

Python prototype (for reference only):

compute(image[, features]) -> features
Link to this function

compute(self, image, opts)

View Source
@spec compute(t(), Evision.Mat.maybe_mat_in(), [{atom(), term()}, ...] | nil) ::
  Evision.Mat.t() | {:error, String.t()}

compute

Positional Arguments
  • self: Evision.Face.BIF.t()

  • image: Evision.Mat.t().

    Input image (CV_32FC1).

Return
  • features: Evision.Mat.t().

    Feature vector (CV_32FC1).

Computes features sby input image.

Python prototype (for reference only):

compute(image[, features]) -> features
@spec create() :: t() | {:error, String.t()}

create

Keyword Arguments
  • num_bands: int.

    The number of filter bands (<=8) used for computing BIF.

  • num_rotations: int.

    The number of image rotations for computing BIF.

Return
  • retval: BIF

@returns Object for computing BIF.

Python prototype (for reference only):

create([, num_bands[, num_rotations]]) -> retval
@spec create([{atom(), term()}, ...] | nil) :: t() | {:error, String.t()}

create

Keyword Arguments
  • num_bands: int.

    The number of filter bands (<=8) used for computing BIF.

  • num_rotations: int.

    The number of image rotations for computing BIF.

Return
  • retval: BIF

@returns Object for computing BIF.

Python prototype (for reference only):

create([, num_bands[, num_rotations]]) -> retval
@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.Face.BIF.t()
Return
  • retval: bool

Python prototype (for reference only):

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

getDefaultName

Positional Arguments
  • self: Evision.Face.BIF.t()
Return

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

getNumBands

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

@returns The number of filter bands used for computing BIF.

Python prototype (for reference only):

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

getNumRotations

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

@returns The number of image rotations.

Python prototype (for reference only):

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

Reads algorithm parameters from a file storage

Positional Arguments
  • self: Evision.Face.BIF.t()
  • fn_: Evision.FileNode.t()

Python prototype (for reference only):

read(fn_) -> None
@spec save(t(), binary()) :: t() | {:error, String.t()}

save

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

Python prototype (for reference only):

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

write

Positional Arguments
  • self: Evision.Face.BIF.t()
  • fs: Evision.FileStorage.t()
  • name: String

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None