View Source Evision.SparseOpticalFlow (Evision v0.2.9)

Summary

Types

t()

Type that represents an SparseOpticalFlow struct.

Functions

Calculates a sparse optical flow.

Calculates a sparse optical flow.

Clears the algorithm state

Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read

Reads algorithm parameters from a file storage

Stores algorithm parameters in a file storage

Types

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

Type that represents an SparseOpticalFlow struct.

  • ref. reference()

    The underlying erlang resource variable.

Functions

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

calc(self, prevImg, nextImg, prevPts, nextPts)

View Source

Calculates a sparse optical flow.

Positional Arguments
  • self: Evision.SparseOpticalFlow.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
Link to this function

calc(self, prevImg, nextImg, prevPts, nextPts, opts)

View Source

Calculates a sparse optical flow.

Positional Arguments
  • self: Evision.SparseOpticalFlow.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.SparseOpticalFlow.t()

Python prototype (for reference only):

clear() -> None
@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.SparseOpticalFlow.t()
Return
  • retval: bool

Python prototype (for reference only):

empty() -> retval
Link to this function

getDefaultName(named_args)

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

getDefaultName

Positional Arguments
  • self: Evision.SparseOpticalFlow.t()
Return

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

Reads algorithm parameters from a file storage

Positional Arguments

Python prototype (for reference only):

read(fn) -> None
@spec save(Keyword.t()) :: any() | {:error, String.t()}
@spec save(t(), binary()) :: t() | {:error, String.t()}

save

Positional Arguments
  • self: Evision.SparseOpticalFlow.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 write(Keyword.t()) :: any() | {:error, String.t()}
@spec write(t(), Evision.FileStorage.t()) :: t() | {:error, String.t()}

Stores algorithm parameters in a file storage

Positional Arguments

Python prototype (for reference only):

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

write

Positional Arguments

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None