View Source Evision.VariationalRefinement (Evision v0.1.21)

Link to this section Summary

Types

t()

Type that represents an Evision.VariationalRefinement struct.

Functions

@ref calc function overload to handle separate horizontal (u) and vertical (v) flow components (to avoid extra splits/merges)

Creates an instance of VariationalRefinement

Weight of the smoothness term

Weight of the color constancy term

Number of outer (fixed-point) iterations in the minimization procedure.

Weight of the gradient constancy term

Relaxation factor in SOR

Number of inner successive over-relaxation (SOR) iterations in the minimization procedure to solve the respective linear system.

setFixedPointIterations

setSorIterations

Link to this section Types

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

Type that represents an Evision.VariationalRefinement struct.

  • ref. reference()

    The underlying erlang resource variable.

Link to this section Functions

Link to this function

calcUV(self, i0, i1, flow_u, flow_v)

View Source

@ref calc function overload to handle separate horizontal (u) and vertical (v) flow components (to avoid extra splits/merges)

Positional Arguments
Return

Python prototype (for reference only):

calcUV(I0, I1, flow_u, flow_v) -> flow_u, flow_v
@spec create() :: t() | {:error, String.t()}

Creates an instance of VariationalRefinement

Return

Python prototype (for reference only):

create() -> retval
@spec getAlpha(t()) :: number() | {:error, String.t()}

Weight of the smoothness term

Positional Arguments
  • self: Evision.VariationalRefinement.t()
Return
  • retval: float

@see setAlpha/2

Python prototype (for reference only):

getAlpha() -> retval
@spec getDelta(t()) :: number() | {:error, String.t()}

Weight of the color constancy term

Positional Arguments
  • self: Evision.VariationalRefinement.t()
Return
  • retval: float

@see setDelta/2

Python prototype (for reference only):

getDelta() -> retval
Link to this function

getFixedPointIterations(self)

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

Number of outer (fixed-point) iterations in the minimization procedure.

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

@see setFixedPointIterations/2

Python prototype (for reference only):

getFixedPointIterations() -> retval
@spec getGamma(t()) :: number() | {:error, String.t()}

Weight of the gradient constancy term

Positional Arguments
  • self: Evision.VariationalRefinement.t()
Return
  • retval: float

@see setGamma/2

Python prototype (for reference only):

getGamma() -> retval
@spec getOmega(t()) :: number() | {:error, String.t()}

Relaxation factor in SOR

Positional Arguments
  • self: Evision.VariationalRefinement.t()
Return
  • retval: float

@see setOmega/2

Python prototype (for reference only):

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

Number of inner successive over-relaxation (SOR) iterations in the minimization procedure to solve the respective linear system.

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

@see setSorIterations/2

Python prototype (for reference only):

getSorIterations() -> retval
@spec setAlpha(t(), number()) :: :ok | {:error, String.t()}

setAlpha

Positional Arguments
  • self: Evision.VariationalRefinement.t()
  • val: float

@see getAlpha/1

Python prototype (for reference only):

setAlpha(val) -> None
@spec setDelta(t(), number()) :: :ok | {:error, String.t()}

setDelta

Positional Arguments
  • self: Evision.VariationalRefinement.t()
  • val: float

@see getDelta/1

Python prototype (for reference only):

setDelta(val) -> None
Link to this function

setFixedPointIterations(self, val)

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

setFixedPointIterations

Positional Arguments
  • self: Evision.VariationalRefinement.t()
  • val: int

@see getFixedPointIterations/1

Python prototype (for reference only):

setFixedPointIterations(val) -> None
@spec setGamma(t(), number()) :: :ok | {:error, String.t()}

setGamma

Positional Arguments
  • self: Evision.VariationalRefinement.t()
  • val: float

@see getGamma/1

Python prototype (for reference only):

setGamma(val) -> None
@spec setOmega(t(), number()) :: :ok | {:error, String.t()}

setOmega

Positional Arguments
  • self: Evision.VariationalRefinement.t()
  • val: float

@see getOmega/1

Python prototype (for reference only):

setOmega(val) -> None
Link to this function

setSorIterations(self, val)

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

setSorIterations

Positional Arguments
  • self: Evision.VariationalRefinement.t()
  • val: int

@see getSorIterations/1

Python prototype (for reference only):

setSorIterations(val) -> None