View Source Evision.XImgProc.DisparityFilter (Evision v0.1.28)

Link to this section Summary

Types

t()

Type that represents an XImgProc.DisparityFilter struct.

Functions

Clears the algorithm state

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

Apply filtering to the disparity map.

Apply filtering to the disparity map.

getDefaultName

Reads algorithm parameters from a file storage

Stores algorithm parameters in a file storage

Link to this section Types

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

Type that represents an XImgProc.DisparityFilter struct.

  • ref. reference()

    The underlying erlang resource variable.

Link to this section Functions

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

Clears the algorithm state

Positional Arguments
  • self: Evision.XImgProc.DisparityFilter.t()

Python prototype (for reference only):

clear() -> None
@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.XImgProc.DisparityFilter.t()
Return
  • retval: bool

Python prototype (for reference only):

empty() -> retval
Link to this function

filter(self, disparity_map_left, left_view)

View Source
@spec filter(t(), Evision.Mat.maybe_mat_in(), Evision.Mat.maybe_mat_in()) ::
  Evision.Mat.t() | {:error, String.t()}

Apply filtering to the disparity map.

Positional Arguments
  • self: Evision.XImgProc.DisparityFilter.t()

  • disparity_map_left: Evision.Mat.t().

    disparity map of the left view, 1 channel, CV_16S type. Implicitly assumes that disparity values are scaled by 16 (one-pixel disparity corresponds to the value of 16 in the disparity map). Disparity map can have any resolution, it will be automatically resized to fit left_view resolution.

  • left_view: Evision.Mat.t().

    left view of the original stereo-pair to guide the filtering process, 8-bit single-channel or three-channel image.

Keyword Arguments
  • disparity_map_right: Evision.Mat.t().

    optional argument, some implementations might also use the disparity map of the right view to compute confidence maps, for instance.

  • rOI: Rect.

    region of the disparity map to filter. Optional, usually it should be set automatically.

  • right_view: Evision.Mat.t().

    optional argument, some implementations might also use the right view of the original stereo-pair.

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

    output disparity map.

Python prototype (for reference only):

filter(disparity_map_left, left_view[, filtered_disparity_map[, disparity_map_right[, ROI[, right_view]]]]) -> filtered_disparity_map
Link to this function

filter(self, disparity_map_left, left_view, opts)

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

Apply filtering to the disparity map.

Positional Arguments
  • self: Evision.XImgProc.DisparityFilter.t()

  • disparity_map_left: Evision.Mat.t().

    disparity map of the left view, 1 channel, CV_16S type. Implicitly assumes that disparity values are scaled by 16 (one-pixel disparity corresponds to the value of 16 in the disparity map). Disparity map can have any resolution, it will be automatically resized to fit left_view resolution.

  • left_view: Evision.Mat.t().

    left view of the original stereo-pair to guide the filtering process, 8-bit single-channel or three-channel image.

Keyword Arguments
  • disparity_map_right: Evision.Mat.t().

    optional argument, some implementations might also use the disparity map of the right view to compute confidence maps, for instance.

  • rOI: Rect.

    region of the disparity map to filter. Optional, usually it should be set automatically.

  • right_view: Evision.Mat.t().

    optional argument, some implementations might also use the right view of the original stereo-pair.

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

    output disparity map.

Python prototype (for reference only):

filter(disparity_map_left, left_view[, filtered_disparity_map[, disparity_map_right[, ROI[, right_view]]]]) -> filtered_disparity_map
@spec getDefaultName(t()) :: binary() | {:error, String.t()}

getDefaultName

Positional Arguments
  • self: Evision.XImgProc.DisparityFilter.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 read(t(), Evision.FileNode.t()) :: t() | {:error, String.t()}

Reads algorithm parameters from a file storage

Positional Arguments
  • self: Evision.XImgProc.DisparityFilter.t()
  • fn_: Evision.FileNode.t()

Python prototype (for reference only):

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

save

Positional Arguments
  • self: Evision.XImgProc.DisparityFilter.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 write(t(), Evision.FileStorage.t()) :: t() | {:error, String.t()}

Stores algorithm parameters in a file storage

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

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None