@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(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(t(), Evision.Mat.maybe_mat_in()) ::
  Evision.Mat.t() | {:error, String.t()}

Apply Guided Filter to the filtering image.

Positional Arguments

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

• src: Evision.Mat.t().

  filtering image with any numbers of channels.

Keyword Arguments

• dDepth: int.

  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(), [{atom(), term()}, ...] | nil) ::
  Evision.Mat.t() | {:error, String.t()}

Apply Guided Filter to the filtering image.

Positional Arguments

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

• src: Evision.Mat.t().

  filtering image with any numbers of channels.

Keyword Arguments

• dDepth: int.

  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 getDefaultName(t()) :: binary() | {:error, String.t()}

getDefaultName

Positional Arguments

• self: Evision.XImgProc.GuidedFilter.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

@spec read(t(), Evision.FileNode.t()) :: t() | {:error, String.t()}

Reads algorithm parameters from a file storage

Positional Arguments

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

Stores algorithm parameters in a file storage

Positional Arguments

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

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None