View Source Evision.StereoBM (Evision v0.1.34)
Summary
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
save
setBlockSize
setDisp12MaxDiff
setMinDisparity
setNumDisparities
setPreFilterCap
setPreFilterSize
setPreFilterType
setROI1
setROI2
setSmallerBlockSize
setSpeckleRange
setSpeckleWindowSize
setTextureThreshold
setUniquenessRatio
Stores algorithm parameters in a file storage
write
Types
@type t() :: %Evision.StereoBM{ref: reference()}
Type that represents an StereoBM
struct.
ref.
reference()
The underlying erlang resource variable.
Functions
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.t()
.Left 8-bit single-channel image.
right:
Evision.Mat.t()
.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.t()
.Left 8-bit single-channel image.
right:
Evision.Mat.t()
.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
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
- 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
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
- 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
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
getBlockSize
Positional Arguments
- self:
Evision.StereoBM.t()
Return
- retval:
int
Python prototype (for reference only):
getBlockSize() -> retval
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
getDisp12MaxDiff
Positional Arguments
- self:
Evision.StereoBM.t()
Return
- retval:
int
Python prototype (for reference only):
getDisp12MaxDiff() -> retval
getMinDisparity
Positional Arguments
- self:
Evision.StereoBM.t()
Return
- retval:
int
Python prototype (for reference only):
getMinDisparity() -> retval
getNumDisparities
Positional Arguments
- self:
Evision.StereoBM.t()
Return
- retval:
int
Python prototype (for reference only):
getNumDisparities() -> retval
getPreFilterCap
Positional Arguments
- self:
Evision.StereoBM.t()
Return
- retval:
int
Python prototype (for reference only):
getPreFilterCap() -> retval
getPreFilterSize
Positional Arguments
- self:
Evision.StereoBM.t()
Return
- retval:
int
Python prototype (for reference only):
getPreFilterSize() -> retval
getPreFilterType
Positional Arguments
- self:
Evision.StereoBM.t()
Return
- retval:
int
Python prototype (for reference only):
getPreFilterType() -> retval
getROI1
Positional Arguments
- self:
Evision.StereoBM.t()
Return
- retval:
Rect
Python prototype (for reference only):
getROI1() -> retval
getROI2
Positional Arguments
- self:
Evision.StereoBM.t()
Return
- retval:
Rect
Python prototype (for reference only):
getROI2() -> retval
getSmallerBlockSize
Positional Arguments
- self:
Evision.StereoBM.t()
Return
- retval:
int
Python prototype (for reference only):
getSmallerBlockSize() -> retval
getSpeckleRange
Positional Arguments
- self:
Evision.StereoBM.t()
Return
- retval:
int
Python prototype (for reference only):
getSpeckleRange() -> retval
getSpeckleWindowSize
Positional Arguments
- self:
Evision.StereoBM.t()
Return
- retval:
int
Python prototype (for reference only):
getSpeckleWindowSize() -> retval
getTextureThreshold
Positional Arguments
- self:
Evision.StereoBM.t()
Return
- retval:
int
Python prototype (for reference only):
getTextureThreshold() -> retval
getUniquenessRatio
Positional Arguments
- self:
Evision.StereoBM.t()
Return
- retval:
int
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()
- fn_:
Evision.FileNode.t()
Python prototype (for reference only):
read(fn_) -> None
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
setBlockSize
Positional Arguments
- self:
Evision.StereoBM.t()
- blockSize:
int
Python prototype (for reference only):
setBlockSize(blockSize) -> None
setDisp12MaxDiff
Positional Arguments
- self:
Evision.StereoBM.t()
- disp12MaxDiff:
int
Python prototype (for reference only):
setDisp12MaxDiff(disp12MaxDiff) -> None
setMinDisparity
Positional Arguments
- self:
Evision.StereoBM.t()
- minDisparity:
int
Python prototype (for reference only):
setMinDisparity(minDisparity) -> None
setNumDisparities
Positional Arguments
- self:
Evision.StereoBM.t()
- numDisparities:
int
Python prototype (for reference only):
setNumDisparities(numDisparities) -> None
setPreFilterCap
Positional Arguments
- self:
Evision.StereoBM.t()
- preFilterCap:
int
Python prototype (for reference only):
setPreFilterCap(preFilterCap) -> None
setPreFilterSize
Positional Arguments
- self:
Evision.StereoBM.t()
- preFilterSize:
int
Python prototype (for reference only):
setPreFilterSize(preFilterSize) -> None
setPreFilterType
Positional Arguments
- self:
Evision.StereoBM.t()
- preFilterType:
int
Python prototype (for reference only):
setPreFilterType(preFilterType) -> None
setROI1
Positional Arguments
- self:
Evision.StereoBM.t()
- roi1:
Rect
Python prototype (for reference only):
setROI1(roi1) -> None
setROI2
Positional Arguments
- self:
Evision.StereoBM.t()
- roi2:
Rect
Python prototype (for reference only):
setROI2(roi2) -> None
setSmallerBlockSize
Positional Arguments
- self:
Evision.StereoBM.t()
- blockSize:
int
Python prototype (for reference only):
setSmallerBlockSize(blockSize) -> None
setSpeckleRange
Positional Arguments
- self:
Evision.StereoBM.t()
- speckleRange:
int
Python prototype (for reference only):
setSpeckleRange(speckleRange) -> None
setSpeckleWindowSize
Positional Arguments
- self:
Evision.StereoBM.t()
- speckleWindowSize:
int
Python prototype (for reference only):
setSpeckleWindowSize(speckleWindowSize) -> None
setTextureThreshold
Positional Arguments
- self:
Evision.StereoBM.t()
- textureThreshold:
int
Python prototype (for reference only):
setTextureThreshold(textureThreshold) -> None
setUniquenessRatio
Positional Arguments
- self:
Evision.StereoBM.t()
- uniquenessRatio:
int
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.t()
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.t()
- name:
String
Has overloading in C++
Python prototype (for reference only):
write(fs, name) -> None