View Source Evision.RGBD.RgbdNormals (Evision v0.2.9)

Summary

Types

t()

Type that represents an RGBD.RgbdNormals struct.

Types

@type t() :: %Evision.RGBD.RgbdNormals{ref: reference()}

Type that represents an RGBD.RgbdNormals struct.

  • ref. reference()

    The underlying erlang resource variable.

Functions

@spec apply(Keyword.t()) :: any() | {:error, String.t()}
@spec apply(t(), Evision.Mat.maybe_mat_in()) :: Evision.Mat.t() | {:error, String.t()}

apply

Positional Arguments
  • self: Evision.RGBD.RgbdNormals.t()

  • points: Evision.Mat.

    a rows x cols x 3 matrix of CV_32F/CV64F or a rows x cols x 1 CV_U16S

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

    a rows x cols x 3 matrix

Given a set of 3d points in a depth image, compute the normals at each point.

Python prototype (for reference only):

apply(points[, normals]) -> normals
Link to this function

apply(self, points, opts)

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

apply

Positional Arguments
  • self: Evision.RGBD.RgbdNormals.t()

  • points: Evision.Mat.

    a rows x cols x 3 matrix of CV_32F/CV64F or a rows x cols x 1 CV_U16S

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

    a rows x cols x 3 matrix

Given a set of 3d points in a depth image, compute the normals at each point.

Python prototype (for reference only):

apply(points[, normals]) -> normals
@spec clear(Keyword.t()) :: any() | {:error, String.t()}
@spec clear(t()) :: t() | {:error, String.t()}

Clears the algorithm state

Positional Arguments
  • self: Evision.RGBD.RgbdNormals.t()

Python prototype (for reference only):

clear() -> None
@spec create(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

create(rows, cols, depth, k)

View Source
@spec create(integer(), integer(), integer(), Evision.Mat.maybe_mat_in()) ::
  t() | {:error, String.t()}

create

Positional Arguments
  • rows: integer().

    the number of rows of the depth image normals will be computed on

  • cols: integer().

    the number of cols of the depth image normals will be computed on

  • depth: integer().

    the depth of the normals (only CV_32F or CV_64F)

  • k: Evision.Mat.

    the calibration matrix to use

Keyword Arguments
  • window_size: integer().

    the window size to compute the normals: can only be 1,3,5 or 7

  • method: integer().

    one of the methods to use: RGBD_NORMALS_METHOD_SRI, RGBD_NORMALS_METHOD_FALS

Return
  • retval: RgbdNormals

Constructor

Python prototype (for reference only):

create(rows, cols, depth, K[, window_size[, method]]) -> retval
Link to this function

create(rows, cols, depth, k, opts)

View Source
@spec create(
  integer(),
  integer(),
  integer(),
  Evision.Mat.maybe_mat_in(),
  [method: term(), window_size: term()] | nil
) :: t() | {:error, String.t()}

create

Positional Arguments
  • rows: integer().

    the number of rows of the depth image normals will be computed on

  • cols: integer().

    the number of cols of the depth image normals will be computed on

  • depth: integer().

    the depth of the normals (only CV_32F or CV_64F)

  • k: Evision.Mat.

    the calibration matrix to use

Keyword Arguments
  • window_size: integer().

    the window size to compute the normals: can only be 1,3,5 or 7

  • method: integer().

    one of the methods to use: RGBD_NORMALS_METHOD_SRI, RGBD_NORMALS_METHOD_FALS

Return
  • retval: RgbdNormals

Constructor

Python prototype (for reference only):

create(rows, cols, depth, K[, window_size[, method]]) -> 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.RGBD.RgbdNormals.t()
Return
  • retval: bool

Python prototype (for reference only):

empty() -> retval
@spec getCols(Keyword.t()) :: any() | {:error, String.t()}
@spec getCols(t()) :: integer() | {:error, String.t()}

getCols

Positional Arguments
  • self: Evision.RGBD.RgbdNormals.t()
Return
  • retval: integer()

Python prototype (for reference only):

getCols() -> retval
Link to this function

getDefaultName(named_args)

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

getDefaultName

Positional Arguments
  • self: Evision.RGBD.RgbdNormals.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 getDepth(Keyword.t()) :: any() | {:error, String.t()}
@spec getDepth(t()) :: integer() | {:error, String.t()}

getDepth

Positional Arguments
  • self: Evision.RGBD.RgbdNormals.t()
Return
  • retval: integer()

Python prototype (for reference only):

getDepth() -> retval
@spec getK(Keyword.t()) :: any() | {:error, String.t()}
@spec getK(t()) :: Evision.Mat.t() | {:error, String.t()}

getK

Positional Arguments
  • self: Evision.RGBD.RgbdNormals.t()
Return
  • retval: Evision.Mat.t()

Python prototype (for reference only):

getK() -> retval
@spec getMethod(Keyword.t()) :: any() | {:error, String.t()}
@spec getMethod(t()) :: integer() | {:error, String.t()}

getMethod

Positional Arguments
  • self: Evision.RGBD.RgbdNormals.t()
Return
  • retval: integer()

Python prototype (for reference only):

getMethod() -> retval
@spec getRows(Keyword.t()) :: any() | {:error, String.t()}
@spec getRows(t()) :: integer() | {:error, String.t()}

getRows

Positional Arguments
  • self: Evision.RGBD.RgbdNormals.t()
Return
  • retval: integer()

Python prototype (for reference only):

getRows() -> retval
Link to this function

getWindowSize(named_args)

View Source
@spec getWindowSize(Keyword.t()) :: any() | {:error, String.t()}
@spec getWindowSize(t()) :: integer() | {:error, String.t()}

getWindowSize

Positional Arguments
  • self: Evision.RGBD.RgbdNormals.t()
Return
  • retval: integer()

Python prototype (for reference only):

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

initialize

Positional Arguments
  • self: Evision.RGBD.RgbdNormals.t()

Initializes some data that is cached for later computation If that function is not called, it will be called the first time normals are computed

Python prototype (for reference only):

initialize() -> None
@spec read(Keyword.t()) :: any() | {:error, String.t()}
@spec read(t(), Evision.FileNode.t()) :: t() | {:error, String.t()}

Reads algorithm parameters from a file storage

Positional Arguments

Python prototype (for reference only):

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

save

Positional Arguments
  • self: Evision.RGBD.RgbdNormals.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 setCols(Keyword.t()) :: any() | {:error, String.t()}
@spec setCols(t(), integer()) :: t() | {:error, String.t()}

setCols

Positional Arguments
  • self: Evision.RGBD.RgbdNormals.t()
  • val: integer()

Python prototype (for reference only):

setCols(val) -> None
@spec setDepth(Keyword.t()) :: any() | {:error, String.t()}
@spec setDepth(t(), integer()) :: t() | {:error, String.t()}

setDepth

Positional Arguments
  • self: Evision.RGBD.RgbdNormals.t()
  • val: integer()

Python prototype (for reference only):

setDepth(val) -> None
@spec setK(Keyword.t()) :: any() | {:error, String.t()}
@spec setK(t(), Evision.Mat.maybe_mat_in()) :: t() | {:error, String.t()}

setK

Positional Arguments

Python prototype (for reference only):

setK(val) -> None
@spec setMethod(Keyword.t()) :: any() | {:error, String.t()}
@spec setMethod(t(), integer()) :: t() | {:error, String.t()}

setMethod

Positional Arguments
  • self: Evision.RGBD.RgbdNormals.t()
  • val: integer()

Python prototype (for reference only):

setMethod(val) -> None
@spec setRows(Keyword.t()) :: any() | {:error, String.t()}
@spec setRows(t(), integer()) :: t() | {:error, String.t()}

setRows

Positional Arguments
  • self: Evision.RGBD.RgbdNormals.t()
  • val: integer()

Python prototype (for reference only):

setRows(val) -> None
Link to this function

setWindowSize(named_args)

View Source
@spec setWindowSize(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setWindowSize(self, val)

View Source
@spec setWindowSize(t(), integer()) :: t() | {:error, String.t()}

setWindowSize

Positional Arguments
  • self: Evision.RGBD.RgbdNormals.t()
  • val: integer()

Python prototype (for reference only):

setWindowSize(val) -> None
@spec write(Keyword.t()) :: any() | {:error, String.t()}
@spec write(t(), Evision.FileStorage.t()) :: t() | {:error, String.t()}

Stores algorithm parameters in a file storage

Positional Arguments

Python prototype (for reference only):

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

write

Positional Arguments

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None