View Source Evision.FarnebackOpticalFlow (Evision v0.2.9)

Summary

Types

t()

Type that represents an FarnebackOpticalFlow struct.

Types

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

Type that represents an FarnebackOpticalFlow struct.

  • ref. reference()

    The underlying erlang resource variable.

Functions

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

create

Keyword Arguments
  • numLevels: integer().
  • pyrScale: double.
  • fastPyramids: bool.
  • winSize: integer().
  • numIters: integer().
  • polyN: integer().
  • polySigma: double.
  • flags: integer().
Return
  • retval: Evision.FarnebackOpticalFlow.t()

Python prototype (for reference only):

create([, numLevels[, pyrScale[, fastPyramids[, winSize[, numIters[, polyN[, polySigma[, flags]]]]]]]]) -> retval
@spec create(Keyword.t()) :: any() | {:error, String.t()}
@spec create(
  [
    fastPyramids: term(),
    flags: term(),
    numIters: term(),
    numLevels: term(),
    polyN: term(),
    polySigma: term(),
    pyrScale: term(),
    winSize: term()
  ]
  | nil
) :: t() | {:error, String.t()}

create

Keyword Arguments
  • numLevels: integer().
  • pyrScale: double.
  • fastPyramids: bool.
  • winSize: integer().
  • numIters: integer().
  • polyN: integer().
  • polySigma: double.
  • flags: integer().
Return
  • retval: Evision.FarnebackOpticalFlow.t()

Python prototype (for reference only):

create([, numLevels[, pyrScale[, fastPyramids[, winSize[, numIters[, polyN[, polySigma[, flags]]]]]]]]) -> retval
Link to this function

getFastPyramids(named_args)

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

getFastPyramids

Positional Arguments
  • self: Evision.FarnebackOpticalFlow.t()
Return
  • retval: bool

Python prototype (for reference only):

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

getFlags

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

Python prototype (for reference only):

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

getNumIters

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

Python prototype (for reference only):

getNumIters() -> retval
Link to this function

getNumLevels(named_args)

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

getNumLevels

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

Python prototype (for reference only):

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

getPolyN

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

Python prototype (for reference only):

getPolyN() -> retval
Link to this function

getPolySigma(named_args)

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

getPolySigma

Positional Arguments
  • self: Evision.FarnebackOpticalFlow.t()
Return
  • retval: double

Python prototype (for reference only):

getPolySigma() -> retval
@spec getPyrScale(Keyword.t()) :: any() | {:error, String.t()}
@spec getPyrScale(t()) :: number() | {:error, String.t()}

getPyrScale

Positional Arguments
  • self: Evision.FarnebackOpticalFlow.t()
Return
  • retval: double

Python prototype (for reference only):

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

getWinSize

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

Python prototype (for reference only):

getWinSize() -> retval
Link to this function

setFastPyramids(named_args)

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

setFastPyramids(self, fastPyramids)

View Source
@spec setFastPyramids(t(), boolean()) :: t() | {:error, String.t()}

setFastPyramids

Positional Arguments
  • self: Evision.FarnebackOpticalFlow.t()
  • fastPyramids: bool

Python prototype (for reference only):

setFastPyramids(fastPyramids) -> None
@spec setFlags(Keyword.t()) :: any() | {:error, String.t()}
@spec setFlags(t(), integer()) :: t() | {:error, String.t()}

setFlags

Positional Arguments
  • self: Evision.FarnebackOpticalFlow.t()
  • flags: integer()

Python prototype (for reference only):

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

setNumIters(self, numIters)

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

setNumIters

Positional Arguments
  • self: Evision.FarnebackOpticalFlow.t()
  • numIters: integer()

Python prototype (for reference only):

setNumIters(numIters) -> None
Link to this function

setNumLevels(named_args)

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

setNumLevels(self, numLevels)

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

setNumLevels

Positional Arguments
  • self: Evision.FarnebackOpticalFlow.t()
  • numLevels: integer()

Python prototype (for reference only):

setNumLevels(numLevels) -> None
@spec setPolyN(Keyword.t()) :: any() | {:error, String.t()}
@spec setPolyN(t(), integer()) :: t() | {:error, String.t()}

setPolyN

Positional Arguments
  • self: Evision.FarnebackOpticalFlow.t()
  • polyN: integer()

Python prototype (for reference only):

setPolyN(polyN) -> None
Link to this function

setPolySigma(named_args)

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

setPolySigma(self, polySigma)

View Source
@spec setPolySigma(t(), number()) :: t() | {:error, String.t()}

setPolySigma

Positional Arguments
  • self: Evision.FarnebackOpticalFlow.t()
  • polySigma: double

Python prototype (for reference only):

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

setPyrScale(self, pyrScale)

View Source
@spec setPyrScale(t(), number()) :: t() | {:error, String.t()}

setPyrScale

Positional Arguments
  • self: Evision.FarnebackOpticalFlow.t()
  • pyrScale: double

Python prototype (for reference only):

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

setWinSize(self, winSize)

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

setWinSize

Positional Arguments
  • self: Evision.FarnebackOpticalFlow.t()
  • winSize: integer()

Python prototype (for reference only):

setWinSize(winSize) -> None