View Source Evision.MCC.CCheckerDraw (Evision v0.2.9)

Summary

Types

t()

Type that represents an MCC.CCheckerDraw struct.

Functions

create(named_args)

create

create(pChecker, opts)

create

draw(named_args)

draw(self, img)

draw

Types

t()

@type t() :: %Evision.MCC.CCheckerDraw{ref: reference()}

Type that represents an MCC.CCheckerDraw struct.

ref. reference()
The underlying erlang resource variable.

Functions

create(named_args)

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

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

create

Positional Arguments

pChecker: CChecker

Keyword Arguments

color: Evision.scalar().
thickness: integer().

Return

retval: CCheckerDraw

\brief Create a new CCheckerDraw object. \param pChecker The checker which will be drawn by this object. \param color The color by with which the squares of the checker

          will be drawn

\param thickness The thickness with which the sqaures will be

              drawn

\return A pointer to the implementation of the CCheckerDraw

Python prototype (for reference only):

create(pChecker[, color[, thickness]]) -> retval

create(pChecker, opts)

@spec create(Evision.MCC.CChecker.t(), [color: term(), thickness: term()] | nil) ::
  t() | {:error, String.t()}

create

Positional Arguments

pChecker: CChecker

Keyword Arguments

color: Evision.scalar().
thickness: integer().

Return

retval: CCheckerDraw

\brief Create a new CCheckerDraw object. \param pChecker The checker which will be drawn by this object. \param color The color by with which the squares of the checker

          will be drawn

\param thickness The thickness with which the sqaures will be

              drawn

\return A pointer to the implementation of the CCheckerDraw

Python prototype (for reference only):

create(pChecker[, color[, thickness]]) -> retval

draw(named_args)

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

draw(self, img)

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

draw

Positional Arguments

self: Evision.MCC.CCheckerDraw.t()

Return

img: Evision.Mat.t()

\brief Draws the checker to the given image. \param img image in color space BGR

Python prototype (for reference only):

draw(img) -> img