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

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

Clears the algorithm state

Positional Arguments

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

Creates StereoBM object

Keyword Arguments

• numDisparities: integer().

  the disparity search range. For each pixel algorithm will find the best disparity from 0 (default minimum disparity) to numDisparities. The search range can then be shifted by changing the minimum disparity.

• blockSize: integer().

  the linear size of the blocks compared by the algorithm. The size should be odd (as the block is centered at the current pixel). Larger block size implies smoother, though less accurate disparity map. Smaller block size gives more detailed disparity map, but there is higher chance for algorithm to find a wrong correspondence.

Return

• retval: Evision.StereoBM.t()

The function create StereoBM object. You can then call StereoBM::compute() to compute disparity for a specific stereo pair.

Python prototype (for reference only):

create([, numDisparities[, blockSize]]) -> retval

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

@spec create([blockSize: term(), numDisparities: term()] | nil) ::
  t() | {:error, String.t()}

Creates StereoBM object

Keyword Arguments

• numDisparities: integer().

  the disparity search range. For each pixel algorithm will find the best disparity from 0 (default minimum disparity) to numDisparities. The search range can then be shifted by changing the minimum disparity.

• blockSize: integer().

  the linear size of the blocks compared by the algorithm. The size should be odd (as the block is centered at the current pixel). Larger block size implies smoother, though less accurate disparity map. Smaller block size gives more detailed disparity map, but there is higher chance for algorithm to find a wrong correspondence.

Return

• retval: Evision.StereoBM.t()

The function create StereoBM object. You can then call StereoBM::compute() to compute disparity for a specific stereo pair.

Python prototype (for reference only):

create([, numDisparities[, blockSize]]) -> 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.StereoBM.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.StereoBM.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.StereoBM.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.StereoBM.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.StereoBM.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.StereoBM.t()

Return

• retval: integer()

Python prototype (for reference only):

getNumDisparities() -> retval

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

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

getPreFilterCap

Positional Arguments

• self: Evision.StereoBM.t()

Return

• retval: integer()

Python prototype (for reference only):

getPreFilterCap() -> retval

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

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

getPreFilterSize

Positional Arguments

• self: Evision.StereoBM.t()

Return

• retval: integer()

Python prototype (for reference only):

getPreFilterSize() -> retval

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

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

getPreFilterType

Positional Arguments

• self: Evision.StereoBM.t()

Return

• retval: integer()

Python prototype (for reference only):

getPreFilterType() -> retval

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

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

getROI1

Positional Arguments

• self: Evision.StereoBM.t()

Return

• retval: Rect

Python prototype (for reference only):

getROI1() -> retval

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

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

getROI2

Positional Arguments

• self: Evision.StereoBM.t()

Return

• retval: Rect

Python prototype (for reference only):

getROI2() -> retval

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

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

getSmallerBlockSize

Positional Arguments

• self: Evision.StereoBM.t()

Return

• retval: integer()

Python prototype (for reference only):

getSmallerBlockSize() -> retval

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

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

getSpeckleRange

Positional Arguments

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

Return

• retval: integer()

Python prototype (for reference only):

getSpeckleWindowSize() -> retval

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

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

getTextureThreshold

Positional Arguments

• self: Evision.StereoBM.t()

Return

• retval: integer()

Python prototype (for reference only):

getTextureThreshold() -> retval

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

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

getUniquenessRatio

Positional Arguments

• self: Evision.StereoBM.t()

Return

• retval: integer()

Python prototype (for reference only):

getUniquenessRatio() -> retval

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

Reads algorithm parameters from a file storage

Positional Arguments

• self: Evision.StereoBM.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.StereoBM.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.StereoBM.t()
• blockSize: integer()

Python prototype (for reference only):

setBlockSize(blockSize) -> None

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

setDisp12MaxDiff

Positional Arguments

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

Python prototype (for reference only):

setDisp12MaxDiff(disp12MaxDiff) -> None

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

setMinDisparity

Positional Arguments

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

Python prototype (for reference only):

setMinDisparity(minDisparity) -> None

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

setNumDisparities

Positional Arguments

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

Python prototype (for reference only):

setNumDisparities(numDisparities) -> None

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

setPreFilterCap

Positional Arguments

• self: Evision.StereoBM.t()
• preFilterCap: integer()

Python prototype (for reference only):

setPreFilterCap(preFilterCap) -> None

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

setPreFilterSize

Positional Arguments

• self: Evision.StereoBM.t()
• preFilterSize: integer()

Python prototype (for reference only):

setPreFilterSize(preFilterSize) -> None

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

setPreFilterType

Positional Arguments

• self: Evision.StereoBM.t()
• preFilterType: integer()

Python prototype (for reference only):

setPreFilterType(preFilterType) -> None

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

setROI1

Positional Arguments

• self: Evision.StereoBM.t()
• roi1: Rect

Python prototype (for reference only):

setROI1(roi1) -> None

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

setROI2

Positional Arguments

• self: Evision.StereoBM.t()
• roi2: Rect

Python prototype (for reference only):

setROI2(roi2) -> None

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

setSmallerBlockSize

Positional Arguments

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

Python prototype (for reference only):

setSmallerBlockSize(blockSize) -> None

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

setSpeckleRange

Positional Arguments

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

Python prototype (for reference only):

setSpeckleRange(speckleRange) -> None

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

setSpeckleWindowSize

Positional Arguments

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

Python prototype (for reference only):

setSpeckleWindowSize(speckleWindowSize) -> None

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

setTextureThreshold

Positional Arguments

• self: Evision.StereoBM.t()
• textureThreshold: integer()

Python prototype (for reference only):

setTextureThreshold(textureThreshold) -> None

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

setUniquenessRatio

Positional Arguments

• self: Evision.StereoBM.t()
• uniquenessRatio: integer()

Python prototype (for reference only):

setUniquenessRatio(uniquenessRatio) -> None

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

Stores algorithm parameters in a file storage

Positional Arguments

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

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None