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

Calculates a sparse optical flow.

Positional Arguments

• self: Evision.SparsePyrLKOpticalFlow.t()

• prevImg: Evision.Mat.

  First input image.

• nextImg: Evision.Mat.

  Second input image of the same size and the same type as prevImg.

• prevPts: Evision.Mat.

  Vector of 2D points for which the flow needs to be found.

Return

• nextPts: Evision.Mat.t().

  Output vector of 2D points containing the calculated new positions of input features in the second image.

• status: Evision.Mat.t().

  Output status vector. Each element of the vector is set to 1 if the flow for the corresponding features has been found. Otherwise, it is set to 0.

• err: Evision.Mat.t().

  Optional output vector that contains error response for each point (inverse confidence).

Python prototype (for reference only):

calc(prevImg, nextImg, prevPts, nextPts[, status[, err]]) -> nextPts, status, err

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

Calculates a sparse optical flow.

Positional Arguments

• self: Evision.SparsePyrLKOpticalFlow.t()

• prevImg: Evision.Mat.

  First input image.

• nextImg: Evision.Mat.

  Second input image of the same size and the same type as prevImg.

• prevPts: Evision.Mat.

  Vector of 2D points for which the flow needs to be found.

Return

• nextPts: Evision.Mat.t().

  Output vector of 2D points containing the calculated new positions of input features in the second image.

• status: Evision.Mat.t().

  Output status vector. Each element of the vector is set to 1 if the flow for the corresponding features has been found. Otherwise, it is set to 0.

• err: Evision.Mat.t().

  Optional output vector that contains error response for each point (inverse confidence).

Python prototype (for reference only):

calc(prevImg, nextImg, prevPts, nextPts[, status[, err]]) -> nextPts, status, err

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

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

Clears the algorithm state

Positional Arguments

• self: Evision.SparsePyrLKOpticalFlow.t()

Python prototype (for reference only):

clear() -> None

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

create

Keyword Arguments

• winSize: Size.
• maxLevel: integer().
• crit: TermCriteria.
• flags: integer().
• minEigThreshold: double.

Return

• retval: Evision.SparsePyrLKOpticalFlow.t()

Python prototype (for reference only):

create([, winSize[, maxLevel[, crit[, flags[, minEigThreshold]]]]]) -> retval

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

@spec create(
  [
    crit: term(),
    flags: term(),
    maxLevel: term(),
    minEigThreshold: term(),
    winSize: term()
  ]
  | nil
) :: t() | {:error, String.t()}

create

Keyword Arguments

• winSize: Size.
• maxLevel: integer().
• crit: TermCriteria.
• flags: integer().
• minEigThreshold: double.

Return

• retval: Evision.SparsePyrLKOpticalFlow.t()

Python prototype (for reference only):

create([, winSize[, maxLevel[, crit[, flags[, minEigThreshold]]]]]) -> 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.SparsePyrLKOpticalFlow.t()

Return

• retval: bool

Python prototype (for reference only):

empty() -> retval

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

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

getDefaultName

Positional Arguments

• self: Evision.SparsePyrLKOpticalFlow.t()

Return

• retval: String

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

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

getFlags

Positional Arguments

• self: Evision.SparsePyrLKOpticalFlow.t()

Return

• retval: integer()

Python prototype (for reference only):

getFlags() -> retval

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

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

getMaxLevel

Positional Arguments

• self: Evision.SparsePyrLKOpticalFlow.t()

Return

• retval: integer()

Python prototype (for reference only):

getMaxLevel() -> retval

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

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

getMinEigThreshold

Positional Arguments

• self: Evision.SparsePyrLKOpticalFlow.t()

Return

• retval: double

Python prototype (for reference only):

getMinEigThreshold() -> retval

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

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

getTermCriteria

Positional Arguments

• self: Evision.SparsePyrLKOpticalFlow.t()

Return

• retval: TermCriteria

Python prototype (for reference only):

getTermCriteria() -> retval

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

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

getWinSize

Positional Arguments

• self: Evision.SparsePyrLKOpticalFlow.t()

Return

• retval: Size

Python prototype (for reference only):

getWinSize() -> retval

@spec read(t(), Evision.FileNode.t()) :: t() | {:error, String.t()}

Reads algorithm parameters from a file storage

Positional Arguments

• self: Evision.SparsePyrLKOpticalFlow.t()
• func: Evision.FileNode

Python prototype (for reference only):

read(fn) -> None

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

save

Positional Arguments

• self: Evision.SparsePyrLKOpticalFlow.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 setFlags(t(), integer()) :: t() | {:error, String.t()}

setFlags

Positional Arguments

• self: Evision.SparsePyrLKOpticalFlow.t()
• flags: integer()

Python prototype (for reference only):

setFlags(flags) -> None

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

setMaxLevel

Positional Arguments

• self: Evision.SparsePyrLKOpticalFlow.t()
• maxLevel: integer()

Python prototype (for reference only):

setMaxLevel(maxLevel) -> None

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

setMinEigThreshold

Positional Arguments

• self: Evision.SparsePyrLKOpticalFlow.t()
• minEigThreshold: double

Python prototype (for reference only):

setMinEigThreshold(minEigThreshold) -> None

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

setTermCriteria

Positional Arguments

• self: Evision.SparsePyrLKOpticalFlow.t()
• crit: TermCriteria

Python prototype (for reference only):

setTermCriteria(crit) -> None

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

setWinSize

Positional Arguments

• self: Evision.SparsePyrLKOpticalFlow.t()
• winSize: Size

Python prototype (for reference only):

setWinSize(winSize) -> None

@spec write(t(), Evision.FileStorage.t()) :: t() | {:error, String.t()}

Stores algorithm parameters in a file storage

Positional Arguments

• self: Evision.SparsePyrLKOpticalFlow.t()
• fs: Evision.FileStorage

Python prototype (for reference only):

write(fs) -> None

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

write

Positional Arguments

• self: Evision.SparsePyrLKOpticalFlow.t()
• fs: Evision.FileStorage
• name: String

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None