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

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

Positional Arguments

• self: Evision.VariationalRefinement.t()
• i0: Evision.Mat
• i1: Evision.Mat

Return

• flow_u: Evision.Mat.t()
• flow_v: Evision.Mat.t()

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

• retval: Evision.VariationalRefinement.t()

Python prototype (for reference only):

create() -> retval

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

@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(Keyword.t()) :: any() | {:error, String.t()}

@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

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

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

Norm value shift for robust penalizer

Positional Arguments

• self: Evision.VariationalRefinement.t()

Return

• retval: float

@see setEpsilon/2

Python prototype (for reference only):

getEpsilon() -> retval

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

@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: integer()

@see setFixedPointIterations/2

Python prototype (for reference only):

getFixedPointIterations() -> retval

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

@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(Keyword.t()) :: any() | {:error, String.t()}

@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(Keyword.t()) :: any() | {:error, String.t()}

@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: integer()

@see setSorIterations/2

Python prototype (for reference only):

getSorIterations() -> retval

@spec setAlpha(t(), number()) :: t() | {: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()) :: t() | {:error, String.t()}

setDelta

Positional Arguments

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

@see getDelta/1

Python prototype (for reference only):

setDelta(val) -> None

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

setEpsilon

Positional Arguments

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

@see getEpsilon/1

Python prototype (for reference only):

setEpsilon(val) -> None

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

setFixedPointIterations

Positional Arguments

• self: Evision.VariationalRefinement.t()
• val: integer()

@see getFixedPointIterations/1

Python prototype (for reference only):

setFixedPointIterations(val) -> None

@spec setGamma(t(), number()) :: t() | {: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()) :: t() | {:error, String.t()}

setOmega

Positional Arguments

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

@see getOmega/1

Python prototype (for reference only):

setOmega(val) -> None

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

setSorIterations

Positional Arguments

• self: Evision.VariationalRefinement.t()
• val: integer()

@see getSorIterations/1

Python prototype (for reference only):

setSorIterations(val) -> None