View Source Evision.LineMod.Modality (Evision v0.2.9)

Summary

Types

t()

Type that represents an LineMod.Modality struct.

Types

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

Type that represents an LineMod.Modality struct.

  • ref. reference()

    The underlying erlang resource variable.

Functions

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

Variant 1:

create

Positional Arguments
Return
  • retval: Modality

\brief Load a modality from file.

Python prototype (for reference only):

create(fn) -> retval

Variant 2:

create

Positional Arguments
Return
  • retval: Modality

\brief Create modality by name. The following modality types are supported:

  • "ColorGradient"
  • "DepthNormal"

Python prototype (for reference only):

create(modality_type) -> retval
@spec name(Keyword.t()) :: any() | {:error, String.t()}
@spec name(t()) :: binary() | {:error, String.t()}

name

Positional Arguments
  • self: Evision.LineMod.Modality.t()
Return

Python prototype (for reference only):

name() -> retval
@spec process(Keyword.t()) :: any() | {:error, String.t()}

process

Positional Arguments
Keyword Arguments
Return
  • retval: QuantizedPyramid

\brief Form a quantized image pyramid from a source image. \param[in] src The source image. Type depends on the modality. \param[in] mask Optional mask. If not empty, unmasked pixels are set to zero

             in quantized image and cannot be extracted as features.

Python prototype (for reference only):

process(src[, mask]) -> retval
Link to this function

process(self, src, opts)

View Source
@spec process(t(), Evision.Mat.maybe_mat_in(), [{:mask, term()}] | nil) ::
  Evision.LineMod.QuantizedPyramid.t() | {:error, String.t()}

process

Positional Arguments
Keyword Arguments
Return
  • retval: QuantizedPyramid

\brief Form a quantized image pyramid from a source image. \param[in] src The source image. Type depends on the modality. \param[in] mask Optional mask. If not empty, unmasked pixels are set to zero

             in quantized image and cannot be extracted as features.

Python prototype (for reference only):

process(src[, mask]) -> retval
@spec read(Keyword.t()) :: any() | {:error, String.t()}
@spec read(t(), Evision.FileNode.t()) :: t() | {:error, String.t()}

read

Positional Arguments

Python prototype (for reference only):

read(fn) -> None