View Source Evision.CUDA.StereoBeliefPropagation (Evision v0.2.7)

Summary

Types

t()

Type that represents an CUDA.StereoBeliefPropagation struct.

Functions

Clears the algorithm state

Variant 1:

Enables the stereo correspondence operator that finds the disparity for the specified data cost.

Variant 1:

Enables the stereo correspondence operator that finds the disparity for the specified data cost.

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

Uses a heuristic method to compute the recommended parameters ( ndisp, iters and levels ) for the specified image size ( width and height ).

getDiscSingleJump

getDisp12MaxDiff

getMinDisparity

getNumDisparities

getSpeckleRange

getSpeckleWindowSize

Reads algorithm parameters from a file storage

Stores algorithm parameters in a file storage

Types

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

Type that represents an CUDA.StereoBeliefPropagation struct.

  • ref. reference()

    The underlying erlang resource variable.

Functions

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

Clears the algorithm state

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()

Python prototype (for reference only):

clear() -> None
@spec compute(Keyword.t()) :: any() | {:error, String.t()}
@spec compute(t(), Evision.Mat.maybe_mat_in()) ::
  Evision.Mat.t() | {:error, String.t()}
@spec compute(t(), Evision.CUDA.GpuMat.t()) ::
  Evision.CUDA.GpuMat.t() | {:error, String.t()}

Variant 1:

Enables the stereo correspondence operator that finds the disparity for the specified data cost.

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()

  • data: Evision.Mat.

    User-specified data cost, a matrix of msg_type type and Size(\<image columns>*ndisp, \<image rows>) size.

Keyword Arguments
  • stream: Evision.CUDA.Stream.t().

    Stream for the asynchronous version.

Return
  • disparity: Evision.Mat.t().

    Output disparity map. If disparity is empty, the output type is CV_16SC1 . Otherwise, the type is retained. In 16-bit signed format, the disparity values do not have fractional bits.

Python prototype (for reference only):

compute(data[, disparity[, stream]]) -> disparity

Variant 2:

Enables the stereo correspondence operator that finds the disparity for the specified data cost.

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()

  • data: Evision.CUDA.GpuMat.t().

    User-specified data cost, a matrix of msg_type type and Size(\<image columns>*ndisp, \<image rows>) size.

Keyword Arguments
  • stream: Evision.CUDA.Stream.t().

    Stream for the asynchronous version.

Return
  • disparity: Evision.CUDA.GpuMat.t().

    Output disparity map. If disparity is empty, the output type is CV_16SC1 . Otherwise, the type is retained. In 16-bit signed format, the disparity values do not have fractional bits.

Python prototype (for reference only):

compute(data[, disparity[, stream]]) -> disparity
Link to this function

compute(self, data, opts)

View Source
@spec compute(t(), Evision.Mat.maybe_mat_in(), [{:stream, term()}] | nil) ::
  Evision.Mat.t() | {:error, String.t()}
@spec compute(t(), Evision.CUDA.GpuMat.t(), [{:stream, term()}] | nil) ::
  Evision.CUDA.GpuMat.t() | {:error, String.t()}

Variant 1:

Enables the stereo correspondence operator that finds the disparity for the specified data cost.

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()

  • data: Evision.Mat.

    User-specified data cost, a matrix of msg_type type and Size(\<image columns>*ndisp, \<image rows>) size.

Keyword Arguments
  • stream: Evision.CUDA.Stream.t().

    Stream for the asynchronous version.

Return
  • disparity: Evision.Mat.t().

    Output disparity map. If disparity is empty, the output type is CV_16SC1 . Otherwise, the type is retained. In 16-bit signed format, the disparity values do not have fractional bits.

Python prototype (for reference only):

compute(data[, disparity[, stream]]) -> disparity

Variant 2:

Enables the stereo correspondence operator that finds the disparity for the specified data cost.

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()

  • data: Evision.CUDA.GpuMat.t().

    User-specified data cost, a matrix of msg_type type and Size(\<image columns>*ndisp, \<image rows>) size.

Keyword Arguments
  • stream: Evision.CUDA.Stream.t().

    Stream for the asynchronous version.

Return
  • disparity: Evision.CUDA.GpuMat.t().

    Output disparity map. If disparity is empty, the output type is CV_16SC1 . Otherwise, the type is retained. In 16-bit signed format, the disparity values do not have fractional bits.

Python prototype (for reference only):

compute(data[, disparity[, stream]]) -> disparity
Link to this function

compute(self, left, right, stream)

View Source

Variant 1:

compute

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
  • left: Evision.Mat
  • right: Evision.Mat
  • stream: Evision.CUDA.Stream.t()
Return
  • disparity: Evision.Mat.t().

Has overloading in C++

Python prototype (for reference only):

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

Variant 2:

compute

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
  • left: Evision.CUDA.GpuMat.t()
  • right: Evision.CUDA.GpuMat.t()
  • stream: Evision.CUDA.Stream.t()
Return
  • disparity: Evision.CUDA.GpuMat.t().

Has overloading in C++

Python prototype (for reference only):

compute(left, right, stream[, disparity]) -> disparity
Link to this function

compute(self, left, right, stream, opts)

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

Variant 1:

compute

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
  • left: Evision.Mat
  • right: Evision.Mat
  • stream: Evision.CUDA.Stream.t()
Return
  • disparity: Evision.Mat.t().

Has overloading in C++

Python prototype (for reference only):

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

Variant 2:

compute

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
  • left: Evision.CUDA.GpuMat.t()
  • right: Evision.CUDA.GpuMat.t()
  • stream: Evision.CUDA.Stream.t()
Return
  • disparity: Evision.CUDA.GpuMat.t().

Has overloading in C++

Python prototype (for reference only):

compute(left, right, stream[, 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.CUDA.StereoBeliefPropagation.t()
Return
  • retval: bool

Python prototype (for reference only):

empty() -> retval
Link to this function

estimateRecommendedParams(named_args)

View Source
@spec estimateRecommendedParams(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

estimateRecommendedParams(width, height, ndisp, iters, levels)

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

Uses a heuristic method to compute the recommended parameters ( ndisp, iters and levels ) for the specified image size ( width and height ).

Positional Arguments
  • width: integer()
  • height: integer()
  • ndisp: integer()
  • iters: integer()
  • levels: integer()

Python prototype (for reference only):

estimateRecommendedParams(width, height, ndisp, iters, levels) -> None
Link to this function

getBlockSize(named_args)

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

getBlockSize

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
Return
  • retval: integer()

Python prototype (for reference only):

getBlockSize() -> retval
Link to this function

getDataWeight(named_args)

View Source
@spec getDataWeight(Keyword.t()) :: any() | {:error, String.t()}
@spec getDataWeight(t()) :: number() | {:error, String.t()}

getDataWeight

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
Return
  • retval: double

Python prototype (for reference only):

getDataWeight() -> retval
Link to this function

getDefaultName(named_args)

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

getDefaultName

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.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
Link to this function

getDiscSingleJump(named_args)

View Source
@spec getDiscSingleJump(Keyword.t()) :: any() | {:error, String.t()}
@spec getDiscSingleJump(t()) :: number() | {:error, String.t()}

getDiscSingleJump

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
Return
  • retval: double

Python prototype (for reference only):

getDiscSingleJump() -> retval
Link to this function

getDisp12MaxDiff(named_args)

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

getDisp12MaxDiff

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
Return
  • retval: integer()

Python prototype (for reference only):

getDisp12MaxDiff() -> retval
Link to this function

getMaxDataTerm(named_args)

View Source
@spec getMaxDataTerm(Keyword.t()) :: any() | {:error, String.t()}
@spec getMaxDataTerm(t()) :: number() | {:error, String.t()}

getMaxDataTerm

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
Return
  • retval: double

Python prototype (for reference only):

getMaxDataTerm() -> retval
Link to this function

getMaxDiscTerm(named_args)

View Source
@spec getMaxDiscTerm(Keyword.t()) :: any() | {:error, String.t()}
@spec getMaxDiscTerm(t()) :: number() | {:error, String.t()}

getMaxDiscTerm

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
Return
  • retval: double

Python prototype (for reference only):

getMaxDiscTerm() -> retval
Link to this function

getMinDisparity(named_args)

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

getMinDisparity

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
Return
  • retval: integer()

Python prototype (for reference only):

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

getMsgType

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
Return
  • retval: integer()

Python prototype (for reference only):

getMsgType() -> retval
Link to this function

getNumDisparities(named_args)

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

getNumDisparities

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
Return
  • retval: integer()

Python prototype (for reference only):

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

getNumIters

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
Return
  • retval: integer()

Python prototype (for reference only):

getNumIters() -> retval
Link to this function

getNumLevels(named_args)

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

getNumLevels

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
Return
  • retval: integer()

Python prototype (for reference only):

getNumLevels() -> retval
Link to this function

getSpeckleRange(named_args)

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

getSpeckleRange

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
Return
  • retval: integer()

Python prototype (for reference only):

getSpeckleRange() -> retval
Link to this function

getSpeckleWindowSize(named_args)

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

getSpeckleWindowSize

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
Return
  • retval: integer()

Python prototype (for reference only):

getSpeckleWindowSize() -> retval
@spec read(Keyword.t()) :: any() | {:error, String.t()}
@spec read(t(), Evision.FileNode.t()) :: t() | {:error, String.t()}

Reads algorithm parameters from a file storage

Positional Arguments

Python prototype (for reference only):

read(fn) -> None
@spec save(Keyword.t()) :: any() | {:error, String.t()}
@spec save(t(), binary()) :: t() | {:error, String.t()}

save

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.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(named_args)

View Source
@spec setBlockSize(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setBlockSize(self, blockSize)

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

setBlockSize

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
  • blockSize: integer()

Python prototype (for reference only):

setBlockSize(blockSize) -> None
Link to this function

setDataWeight(named_args)

View Source
@spec setDataWeight(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setDataWeight(self, data_weight)

View Source
@spec setDataWeight(t(), number()) :: t() | {:error, String.t()}

setDataWeight

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
  • data_weight: double

Python prototype (for reference only):

setDataWeight(data_weight) -> None
Link to this function

setDiscSingleJump(named_args)

View Source
@spec setDiscSingleJump(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setDiscSingleJump(self, disc_single_jump)

View Source
@spec setDiscSingleJump(t(), number()) :: t() | {:error, String.t()}

setDiscSingleJump

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
  • disc_single_jump: double

Python prototype (for reference only):

setDiscSingleJump(disc_single_jump) -> None
Link to this function

setDisp12MaxDiff(named_args)

View Source
@spec setDisp12MaxDiff(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setDisp12MaxDiff(self, disp12MaxDiff)

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

setDisp12MaxDiff

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
  • disp12MaxDiff: integer()

Python prototype (for reference only):

setDisp12MaxDiff(disp12MaxDiff) -> None
Link to this function

setMaxDataTerm(named_args)

View Source
@spec setMaxDataTerm(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setMaxDataTerm(self, max_data_term)

View Source
@spec setMaxDataTerm(t(), number()) :: t() | {:error, String.t()}

setMaxDataTerm

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
  • max_data_term: double

Python prototype (for reference only):

setMaxDataTerm(max_data_term) -> None
Link to this function

setMaxDiscTerm(named_args)

View Source
@spec setMaxDiscTerm(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setMaxDiscTerm(self, max_disc_term)

View Source
@spec setMaxDiscTerm(t(), number()) :: t() | {:error, String.t()}

setMaxDiscTerm

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
  • max_disc_term: double

Python prototype (for reference only):

setMaxDiscTerm(max_disc_term) -> None
Link to this function

setMinDisparity(named_args)

View Source
@spec setMinDisparity(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setMinDisparity(self, minDisparity)

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

setMinDisparity

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
  • minDisparity: integer()

Python prototype (for reference only):

setMinDisparity(minDisparity) -> None
@spec setMsgType(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setMsgType(self, msg_type)

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

setMsgType

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
  • msg_type: integer()

Python prototype (for reference only):

setMsgType(msg_type) -> None
Link to this function

setNumDisparities(named_args)

View Source
@spec setNumDisparities(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setNumDisparities(self, numDisparities)

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

setNumDisparities

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
  • numDisparities: integer()

Python prototype (for reference only):

setNumDisparities(numDisparities) -> None
@spec setNumIters(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setNumIters(self, iters)

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

setNumIters

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
  • iters: integer()

Python prototype (for reference only):

setNumIters(iters) -> None
Link to this function

setNumLevels(named_args)

View Source
@spec setNumLevels(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setNumLevels(self, levels)

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

setNumLevels

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
  • levels: integer()

Python prototype (for reference only):

setNumLevels(levels) -> None
Link to this function

setSpeckleRange(named_args)

View Source
@spec setSpeckleRange(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setSpeckleRange(self, speckleRange)

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

setSpeckleRange

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
  • speckleRange: integer()

Python prototype (for reference only):

setSpeckleRange(speckleRange) -> None
Link to this function

setSpeckleWindowSize(named_args)

View Source
@spec setSpeckleWindowSize(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setSpeckleWindowSize(self, speckleWindowSize)

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

setSpeckleWindowSize

Positional Arguments
  • self: Evision.CUDA.StereoBeliefPropagation.t()
  • speckleWindowSize: integer()

Python prototype (for reference only):

setSpeckleWindowSize(speckleWindowSize) -> None
@spec write(Keyword.t()) :: any() | {:error, String.t()}
@spec write(t(), Evision.FileStorage.t()) :: t() | {:error, String.t()}

Stores algorithm parameters in a file storage

Positional Arguments

Python prototype (for reference only):

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

write

Positional Arguments

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None