View Source Evision.StereoBM (Evision v0.1.14)

Link to this section Summary

Types

t()

Type that represents an Evision.StereoBM struct.

Functions

Computes disparity map for the specified stereo pair

Computes disparity map for the specified stereo pair

Creates StereoBM object

Creates StereoBM object

Return
  • retval: int

Python prototype (for reference):

Return
  • retval: int

Python prototype (for reference):

Return
  • retval: int

Python prototype (for reference):

Return
  • retval: int

Python prototype (for reference):

Return
  • retval: int

Python prototype (for reference):

Return
  • retval: int

Python prototype (for reference):

Return
  • retval: int

Python prototype (for reference):

Return
  • retval: Rect

Python prototype (for reference):

Return
  • retval: Rect

Python prototype (for reference):

Return
  • retval: int

Python prototype (for reference):

Return
  • retval: int

Python prototype (for reference):

Return
  • retval: int

Python prototype (for reference):

Return
  • retval: int

Python prototype (for reference):

Return
  • retval: int

Python prototype (for reference):

Positional Arguments
  • blockSize: int

Python prototype (for reference):

Positional Arguments
  • disp12MaxDiff: int

Python prototype (for reference):

Positional Arguments
  • minDisparity: int

Python prototype (for reference):

Positional Arguments
  • numDisparities: int

Python prototype (for reference):

Positional Arguments
  • preFilterCap: int

Python prototype (for reference):

Positional Arguments
  • preFilterSize: int

Python prototype (for reference):

Positional Arguments
  • preFilterType: int

Python prototype (for reference):

Positional Arguments
  • roi1: Rect

Python prototype (for reference):

Positional Arguments
  • roi2: Rect

Python prototype (for reference):

Positional Arguments
  • blockSize: int

Python prototype (for reference):

Positional Arguments
  • speckleRange: int

Python prototype (for reference):

Positional Arguments
  • speckleWindowSize: int

Python prototype (for reference):

Positional Arguments
  • textureThreshold: int

Python prototype (for reference):

Positional Arguments
  • uniquenessRatio: int

Python prototype (for reference):

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

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
  • 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):

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
  • 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):

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):

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):

create([, numDisparities[, blockSize]]) -> retval
@spec getBlockSize(t()) :: integer() | {:error, String.t()}
Return
  • retval: int

Python prototype (for reference):

getBlockSize() -> retval
@spec getDisp12MaxDiff(t()) :: integer() | {:error, String.t()}
Return
  • retval: int

Python prototype (for reference):

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

Python prototype (for reference):

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

Python prototype (for reference):

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

Python prototype (for reference):

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

Python prototype (for reference):

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

Python prototype (for reference):

getPreFilterType() -> retval
@spec getROI1(t()) :: {number(), number(), number(), number()} | {:error, String.t()}
Return
  • retval: Rect

Python prototype (for reference):

getROI1() -> retval
@spec getROI2(t()) :: {number(), number(), number(), number()} | {:error, String.t()}
Return
  • retval: Rect

Python prototype (for reference):

getROI2() -> retval
Link to this function

getSmallerBlockSize(self)

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

Python prototype (for reference):

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

Python prototype (for reference):

getSpeckleRange() -> retval
Link to this function

getSpeckleWindowSize(self)

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

Python prototype (for reference):

getSpeckleWindowSize() -> retval
Link to this function

getTextureThreshold(self)

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

Python prototype (for reference):

getTextureThreshold() -> retval
Link to this function

getUniquenessRatio(self)

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

Python prototype (for reference):

getUniquenessRatio() -> retval
Link to this function

setBlockSize(self, blockSize)

View Source
@spec setBlockSize(t(), integer()) :: :ok | {:error, String.t()}
Positional Arguments
  • blockSize: int

Python prototype (for reference):

setBlockSize(blockSize) -> None
Link to this function

setDisp12MaxDiff(self, disp12MaxDiff)

View Source
@spec setDisp12MaxDiff(t(), integer()) :: :ok | {:error, String.t()}
Positional Arguments
  • disp12MaxDiff: int

Python prototype (for reference):

setDisp12MaxDiff(disp12MaxDiff) -> None
Link to this function

setMinDisparity(self, minDisparity)

View Source
@spec setMinDisparity(t(), integer()) :: :ok | {:error, String.t()}
Positional Arguments
  • minDisparity: int

Python prototype (for reference):

setMinDisparity(minDisparity) -> None
Link to this function

setNumDisparities(self, numDisparities)

View Source
@spec setNumDisparities(t(), integer()) :: :ok | {:error, String.t()}
Positional Arguments
  • numDisparities: int

Python prototype (for reference):

setNumDisparities(numDisparities) -> None
Link to this function

setPreFilterCap(self, preFilterCap)

View Source
@spec setPreFilterCap(t(), integer()) :: :ok | {:error, String.t()}
Positional Arguments
  • preFilterCap: int

Python prototype (for reference):

setPreFilterCap(preFilterCap) -> None
Link to this function

setPreFilterSize(self, preFilterSize)

View Source
@spec setPreFilterSize(t(), integer()) :: :ok | {:error, String.t()}
Positional Arguments
  • preFilterSize: int

Python prototype (for reference):

setPreFilterSize(preFilterSize) -> None
Link to this function

setPreFilterType(self, preFilterType)

View Source
@spec setPreFilterType(t(), integer()) :: :ok | {:error, String.t()}
Positional Arguments
  • preFilterType: int

Python prototype (for reference):

setPreFilterType(preFilterType) -> None
@spec setROI1(t(), {number(), number(), number(), number()}) ::
  :ok | {:error, String.t()}
Positional Arguments
  • roi1: Rect

Python prototype (for reference):

setROI1(roi1) -> None
@spec setROI2(t(), {number(), number(), number(), number()}) ::
  :ok | {:error, String.t()}
Positional Arguments
  • roi2: Rect

Python prototype (for reference):

setROI2(roi2) -> None
Link to this function

setSmallerBlockSize(self, blockSize)

View Source
@spec setSmallerBlockSize(t(), integer()) :: :ok | {:error, String.t()}
Positional Arguments
  • blockSize: int

Python prototype (for reference):

setSmallerBlockSize(blockSize) -> None
Link to this function

setSpeckleRange(self, speckleRange)

View Source
@spec setSpeckleRange(t(), integer()) :: :ok | {:error, String.t()}
Positional Arguments
  • speckleRange: int

Python prototype (for reference):

setSpeckleRange(speckleRange) -> None
Link to this function

setSpeckleWindowSize(self, speckleWindowSize)

View Source
@spec setSpeckleWindowSize(t(), integer()) :: :ok | {:error, String.t()}
Positional Arguments
  • speckleWindowSize: int

Python prototype (for reference):

setSpeckleWindowSize(speckleWindowSize) -> None
Link to this function

setTextureThreshold(self, textureThreshold)

View Source
@spec setTextureThreshold(t(), integer()) :: :ok | {:error, String.t()}
Positional Arguments
  • textureThreshold: int

Python prototype (for reference):

setTextureThreshold(textureThreshold) -> None
Link to this function

setUniquenessRatio(self, uniquenessRatio)

View Source
@spec setUniquenessRatio(t(), integer()) :: :ok | {:error, String.t()}
Positional Arguments
  • uniquenessRatio: int

Python prototype (for reference):

setUniquenessRatio(uniquenessRatio) -> None