View Source Evision.StereoBM (Evision v0.1.21)

Link to this section Summary

Types

t()

Type that represents an Evision.StereoBM struct.

Functions

Clears the algorithm state

Computes disparity map for the specified stereo pair

Computes disparity map for the specified stereo pair

Creates StereoBM object

Creates StereoBM object

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

getBlockSize

getDefaultName

getDisp12MaxDiff

getMinDisparity

getNumDisparities

getPreFilterCap

getPreFilterSize

getPreFilterType

getROI1

getROI2

getSmallerBlockSize

getSpeckleRange

getSpeckleWindowSize

getTextureThreshold

getUniquenessRatio

Reads algorithm parameters from a file storage

simplified API for language bindings

simplified API for language bindings

Link to this section Types

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

Type that represents an Evision.StereoBM struct.

  • ref. reference()

    The underlying erlang resource variable.

Link to this section Functions

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

Clears the algorithm state

Positional Arguments
  • self: Evision.StereoBM.t()

Python prototype (for reference only):

clear() -> None
Link to this function

compute(self, left, right)

View Source
@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.

    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
Link to this function

compute(self, left, right, opts)

View Source
@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.

    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: int.

    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: int.

    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

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([{atom(), term()}, ...] | nil) :: t() | {:error, String.t()}

Creates StereoBM object

Keyword Arguments
  • numDisparities: int.

    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: int.

    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

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

getBlockSize

Positional Arguments
  • self: Evision.StereoBM.t()
Return
  • retval: int

Python prototype (for reference only):

getBlockSize() -> retval
@spec getDefaultName(t()) :: binary() | {:error, String.t()}

getDefaultName

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

getDisp12MaxDiff

Positional Arguments
  • self: Evision.StereoBM.t()
Return
  • retval: int

Python prototype (for reference only):

getDisp12MaxDiff() -> retval
@spec getMinDisparity(t()) :: integer() | {:error, String.t()}

getMinDisparity

Positional Arguments
  • self: Evision.StereoBM.t()
Return
  • retval: int

Python prototype (for reference only):

getMinDisparity() -> retval
@spec getNumDisparities(t()) :: integer() | {:error, String.t()}

getNumDisparities

Positional Arguments
  • self: Evision.StereoBM.t()
Return
  • retval: int

Python prototype (for reference only):

getNumDisparities() -> retval
@spec getPreFilterCap(t()) :: integer() | {:error, String.t()}

getPreFilterCap

Positional Arguments
  • self: Evision.StereoBM.t()
Return
  • retval: int

Python prototype (for reference only):

getPreFilterCap() -> retval
@spec getPreFilterSize(t()) :: integer() | {:error, String.t()}

getPreFilterSize

Positional Arguments
  • self: Evision.StereoBM.t()
Return
  • retval: int

Python prototype (for reference only):

getPreFilterSize() -> retval
@spec getPreFilterType(t()) :: integer() | {:error, String.t()}

getPreFilterType

Positional Arguments
  • self: Evision.StereoBM.t()
Return
  • retval: int

Python prototype (for reference only):

getPreFilterType() -> retval
@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(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
Link to this function

getSmallerBlockSize(self)

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

getSmallerBlockSize

Positional Arguments
  • self: Evision.StereoBM.t()
Return
  • retval: int

Python prototype (for reference only):

getSmallerBlockSize() -> retval
@spec getSpeckleRange(t()) :: integer() | {:error, String.t()}

getSpeckleRange

Positional Arguments
  • self: Evision.StereoBM.t()
Return
  • retval: int

Python prototype (for reference only):

getSpeckleRange() -> retval
Link to this function

getSpeckleWindowSize(self)

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

getSpeckleWindowSize

Positional Arguments
  • self: Evision.StereoBM.t()
Return
  • retval: int

Python prototype (for reference only):

getSpeckleWindowSize() -> retval
Link to this function

getTextureThreshold(self)

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

getTextureThreshold

Positional Arguments
  • self: Evision.StereoBM.t()
Return
  • retval: int

Python prototype (for reference only):

getTextureThreshold() -> retval
Link to this function

getUniquenessRatio(self)

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

getUniquenessRatio

Positional Arguments
  • self: Evision.StereoBM.t()
Return
  • retval: int

Python prototype (for reference only):

getUniquenessRatio() -> retval
@spec read(t(), Evision.FileNode.t()) :: :ok | {:error, String.t()}

Reads algorithm parameters from a file storage

Positional Arguments

Python prototype (for reference only):

read(fn_) -> None
@spec save(t(), binary()) :: :ok | {: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
Link to this function

setBlockSize(self, blockSize)

View Source
@spec setBlockSize(t(), integer()) :: :ok | {:error, String.t()}

setBlockSize

Positional Arguments
  • self: Evision.StereoBM.t()
  • blockSize: int

Python prototype (for reference only):

setBlockSize(blockSize) -> None
Link to this function

setDisp12MaxDiff(self, disp12MaxDiff)

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

setDisp12MaxDiff

Positional Arguments
  • self: Evision.StereoBM.t()
  • disp12MaxDiff: int

Python prototype (for reference only):

setDisp12MaxDiff(disp12MaxDiff) -> None
Link to this function

setMinDisparity(self, minDisparity)

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

setMinDisparity

Positional Arguments
  • self: Evision.StereoBM.t()
  • minDisparity: int

Python prototype (for reference only):

setMinDisparity(minDisparity) -> None
Link to this function

setNumDisparities(self, numDisparities)

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

setNumDisparities

Positional Arguments
  • self: Evision.StereoBM.t()
  • numDisparities: int

Python prototype (for reference only):

setNumDisparities(numDisparities) -> None
Link to this function

setPreFilterCap(self, preFilterCap)

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

setPreFilterCap

Positional Arguments
  • self: Evision.StereoBM.t()
  • preFilterCap: int

Python prototype (for reference only):

setPreFilterCap(preFilterCap) -> None
Link to this function

setPreFilterSize(self, preFilterSize)

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

setPreFilterSize

Positional Arguments
  • self: Evision.StereoBM.t()
  • preFilterSize: int

Python prototype (for reference only):

setPreFilterSize(preFilterSize) -> None
Link to this function

setPreFilterType(self, preFilterType)

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

setPreFilterType

Positional Arguments
  • self: Evision.StereoBM.t()
  • preFilterType: int

Python prototype (for reference only):

setPreFilterType(preFilterType) -> None
@spec setROI1(t(), {number(), number(), number(), number()}) ::
  :ok | {: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()}) ::
  :ok | {:error, String.t()}

setROI2

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

Python prototype (for reference only):

setROI2(roi2) -> None
Link to this function

setSmallerBlockSize(self, blockSize)

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

setSmallerBlockSize

Positional Arguments
  • self: Evision.StereoBM.t()
  • blockSize: int

Python prototype (for reference only):

setSmallerBlockSize(blockSize) -> None
Link to this function

setSpeckleRange(self, speckleRange)

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

setSpeckleRange

Positional Arguments
  • self: Evision.StereoBM.t()
  • speckleRange: int

Python prototype (for reference only):

setSpeckleRange(speckleRange) -> None
Link to this function

setSpeckleWindowSize(self, speckleWindowSize)

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

setSpeckleWindowSize

Positional Arguments
  • self: Evision.StereoBM.t()
  • speckleWindowSize: int

Python prototype (for reference only):

setSpeckleWindowSize(speckleWindowSize) -> None
Link to this function

setTextureThreshold(self, textureThreshold)

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

setTextureThreshold

Positional Arguments
  • self: Evision.StereoBM.t()
  • textureThreshold: int

Python prototype (for reference only):

setTextureThreshold(textureThreshold) -> None
Link to this function

setUniquenessRatio(self, uniquenessRatio)

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

setUniquenessRatio

Positional Arguments
  • self: Evision.StereoBM.t()
  • uniquenessRatio: int

Python prototype (for reference only):

setUniquenessRatio(uniquenessRatio) -> None
@spec write(t(), Evision.FileStorage.t()) :: :ok | {:error, String.t()}

simplified API for language bindings

Positional Arguments
Keyword Arguments

Has overloading in C++

Python prototype (for reference only):

write(fs[, name]) -> None
@spec write(t(), Evision.FileStorage.t(), [{atom(), term()}, ...] | nil) ::
  :ok | {:error, String.t()}

simplified API for language bindings

Positional Arguments
Keyword Arguments

Has overloading in C++

Python prototype (for reference only):

write(fs[, name]) -> None