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

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

Clears the algorithm state

Positional Arguments

• self: Evision.StereoMatcher.t()

Python prototype (for reference only):

clear() -> None

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

Computes disparity map for the specified stereo pair

Positional Arguments

• self: Evision.StereoMatcher.t()

• left: Evision.Mat.

  Left 8-bit single-channel image.

• right: Evision.Mat.

  Right image of the same size and the same type as the left one.

Return

• disparity: Evision.Mat.t().

  Output disparity map. It has the same size as the input images. Some algorithms, like StereoBM or StereoSGBM compute 16-bit fixed-point disparity map (where each disparity value has 4 fractional bits), whereas other algorithms output 32-bit floating-point disparity map.

Python prototype (for reference only):

compute(left, right[, disparity]) -> disparity

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

Computes disparity map for the specified stereo pair

Positional Arguments

• self: Evision.StereoMatcher.t()

• left: Evision.Mat.

  Left 8-bit single-channel image.

• right: Evision.Mat.

  Right image of the same size and the same type as the left one.

Return

• disparity: Evision.Mat.t().

  Output disparity map. It has the same size as the input images. Some algorithms, like StereoBM or StereoSGBM compute 16-bit fixed-point disparity map (where each disparity value has 4 fractional bits), whereas other algorithms output 32-bit floating-point disparity map.

Python prototype (for reference only):

compute(left, right[, disparity]) -> disparity

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

Return

• retval: bool

Python prototype (for reference only):

empty() -> retval

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

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

getBlockSize

Positional Arguments

• self: Evision.StereoMatcher.t()

Return

• retval: integer()

Python prototype (for reference only):

getBlockSize() -> retval

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

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

getDefaultName

Positional Arguments

• self: Evision.StereoMatcher.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 getDisp12MaxDiff(Keyword.t()) :: any() | {:error, String.t()}

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

getDisp12MaxDiff

Positional Arguments

• self: Evision.StereoMatcher.t()

Return

• retval: integer()

Python prototype (for reference only):

getDisp12MaxDiff() -> retval

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

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

getMinDisparity

Positional Arguments

• self: Evision.StereoMatcher.t()

Return

• retval: integer()

Python prototype (for reference only):

getMinDisparity() -> retval

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

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

getNumDisparities

Positional Arguments

• self: Evision.StereoMatcher.t()

Return

• retval: integer()

Python prototype (for reference only):

getNumDisparities() -> retval

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

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

getSpeckleRange

Positional Arguments

• self: Evision.StereoMatcher.t()

Return

• retval: integer()

Python prototype (for reference only):

getSpeckleRange() -> retval

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

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

getSpeckleWindowSize

Positional Arguments

• self: Evision.StereoMatcher.t()

Return

• retval: integer()

Python prototype (for reference only):

getSpeckleWindowSize() -> retval

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

Reads algorithm parameters from a file storage

Positional Arguments

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

setBlockSize

Positional Arguments

• self: Evision.StereoMatcher.t()
• blockSize: integer()

Python prototype (for reference only):

setBlockSize(blockSize) -> None

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

setDisp12MaxDiff

Positional Arguments

• self: Evision.StereoMatcher.t()
• disp12MaxDiff: integer()

Python prototype (for reference only):

setDisp12MaxDiff(disp12MaxDiff) -> None

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

setMinDisparity

Positional Arguments

• self: Evision.StereoMatcher.t()
• minDisparity: integer()

Python prototype (for reference only):

setMinDisparity(minDisparity) -> None

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

setNumDisparities

Positional Arguments

• self: Evision.StereoMatcher.t()
• numDisparities: integer()

Python prototype (for reference only):

setNumDisparities(numDisparities) -> None

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

setSpeckleRange

Positional Arguments

• self: Evision.StereoMatcher.t()
• speckleRange: integer()

Python prototype (for reference only):

setSpeckleRange(speckleRange) -> None

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

setSpeckleWindowSize

Positional Arguments

• self: Evision.StereoMatcher.t()
• speckleWindowSize: integer()

Python prototype (for reference only):

setSpeckleWindowSize(speckleWindowSize) -> None

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

Stores algorithm parameters in a file storage

Positional Arguments

• self: Evision.StereoMatcher.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.StereoMatcher.t()
• fs: Evision.FileStorage
• name: String

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None