View Source Evision.XImgProc.GuidedFilter (Evision v0.2.9)

Summary

Types

t()

Type that represents an XImgProc.GuidedFilter struct.

Functions

Clears the algorithm state

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

Apply (Fast) Guided Filter to the filtering image.

Apply (Fast) Guided Filter to the filtering image.

Reads algorithm parameters from a file storage

Stores algorithm parameters in a file storage

Types

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

Type that represents an XImgProc.GuidedFilter 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.XImgProc.GuidedFilter.t()

Python prototype (for reference only):

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

Python prototype (for reference only):

empty() -> retval
@spec filter(Keyword.t()) :: any() | {:error, String.t()}
@spec filter(t(), Evision.Mat.maybe_mat_in()) ::
  Evision.Mat.t() | {:error, String.t()}

Apply (Fast) Guided Filter to the filtering image.

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

  • src: Evision.Mat.

    filtering image with any numbers of channels.

Keyword Arguments
  • dDepth: integer().

    optional depth of the output image. dDepth can be set to -1, which will be equivalent to src.depth().

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

    output image.

Python prototype (for reference only):

filter(src[, dst[, dDepth]]) -> dst
@spec filter(t(), Evision.Mat.maybe_mat_in(), [{:dDepth, term()}] | nil) ::
  Evision.Mat.t() | {:error, String.t()}

Apply (Fast) Guided Filter to the filtering image.

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

  • src: Evision.Mat.

    filtering image with any numbers of channels.

Keyword Arguments
  • dDepth: integer().

    optional depth of the output image. dDepth can be set to -1, which will be equivalent to src.depth().

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

    output image.

Python prototype (for reference only):

filter(src[, dst[, dDepth]]) -> dst
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.XImgProc.GuidedFilter.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(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.XImgProc.GuidedFilter.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(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