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

Calculates an optical flow.

Positional Arguments

• self: Evision.DenseOpticalFlow.t()

• i0: Evision.Mat.t().

  first 8-bit single-channel input image.

• i1: Evision.Mat.t().

  second input image of the same size and the same type as prev.

Return

• flow: Evision.Mat.t().

  computed flow image that has the same size as prev and type CV_32FC2.

Python prototype (for reference only):

calc(I0, I1, flow) -> flow

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

Clears the algorithm state

Positional Arguments

• self: Evision.DenseOpticalFlow.t()

Python prototype (for reference only):

clear() -> None

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

Releases all inner buffers.

Positional Arguments

• self: Evision.DenseOpticalFlow.t()

Python prototype (for reference only):

collectGarbage() -> None

@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.DenseOpticalFlow.t()

Return

• retval: bool

Python prototype (for reference only):

empty() -> retval

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

getDefaultName

Positional Arguments

• self: Evision.DenseOpticalFlow.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 read(t(), Evision.FileNode.t()) :: t() | {:error, String.t()}

Reads algorithm parameters from a file storage

Positional Arguments

• self: Evision.DenseOpticalFlow.t()
• fn_: Evision.FileNode.t()

Python prototype (for reference only):

read(fn_) -> None

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

save

Positional Arguments

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

Stores algorithm parameters in a file storage

Positional Arguments

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

Python prototype (for reference only):

write(fs) -> None

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

write

Positional Arguments

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

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None