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

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

Clears the algorithm state

Positional Arguments

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

Python prototype (for reference only):

clear() -> None

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

Create pointer to the Ridge detection filter.

Keyword Arguments

• ddepth: integer().

  Specifies output image depth. Defualt is CV_32FC1

• dx: integer().

  Order of derivative x, default is 1

• dy: integer().

  Order of derivative y, default is 1

• ksize: integer().

  Sobel kernel size , default is 3

• out_dtype: integer().

  Converted format for output, default is CV_8UC1

• scale: double.

  Optional scale value for derivative values, default is 1

• delta: double.

  Optional bias added to output, default is 0

• borderType: integer().

  Pixel extrapolation method, default is BORDER_DEFAULT

Return

• retval: RidgeDetectionFilter

@see Sobel, threshold, getStructuringElement, morphologyEx.( for additional refinement)

Python prototype (for reference only):

create([, ddepth[, dx[, dy[, ksize[, out_dtype[, scale[, delta[, borderType]]]]]]]]) -> retval

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

@spec create(
  [
    borderType: term(),
    ddepth: term(),
    delta: term(),
    dx: term(),
    dy: term(),
    ksize: term(),
    out_dtype: term(),
    scale: term()
  ]
  | nil
) :: t() | {:error, String.t()}

Create pointer to the Ridge detection filter.

Keyword Arguments

• ddepth: integer().

  Specifies output image depth. Defualt is CV_32FC1

• dx: integer().

  Order of derivative x, default is 1

• dy: integer().

  Order of derivative y, default is 1

• ksize: integer().

  Sobel kernel size , default is 3

• out_dtype: integer().

  Converted format for output, default is CV_8UC1

• scale: double.

  Optional scale value for derivative values, default is 1

• delta: double.

  Optional bias added to output, default is 0

• borderType: integer().

  Pixel extrapolation method, default is BORDER_DEFAULT

Return

• retval: RidgeDetectionFilter

@see Sobel, threshold, getStructuringElement, morphologyEx.( for additional refinement)

Python prototype (for reference only):

create([, ddepth[, dx[, dy[, ksize[, out_dtype[, scale[, delta[, borderType]]]]]]]]) -> retval

@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.RidgeDetectionFilter.t()

Return

• retval: bool

Python prototype (for reference only):

empty() -> retval

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

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

getDefaultName

Positional Arguments

• self: Evision.XImgProc.RidgeDetectionFilter.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 getRidgeFilteredImage(t(), Evision.Mat.maybe_mat_in()) ::
  Evision.Mat.t() | {:error, String.t()}

Apply Ridge detection filter on input image.

Positional Arguments

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

• img: Evision.Mat.

  InputArray as supported by Sobel. img can be 1-Channel or 3-Channels.

Return

• out: Evision.Mat.t().

  OutputAray of structure as RidgeDetectionFilter::ddepth. Output image with ridges.

Python prototype (for reference only):

getRidgeFilteredImage(_img[, out]) -> out

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

Apply Ridge detection filter on input image.

Positional Arguments

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

• img: Evision.Mat.

  InputArray as supported by Sobel. img can be 1-Channel or 3-Channels.

Return

• out: Evision.Mat.t().

  OutputAray of structure as RidgeDetectionFilter::ddepth. Output image with ridges.

Python prototype (for reference only):

getRidgeFilteredImage(_img[, out]) -> out

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

Reads algorithm parameters from a file storage

Positional Arguments

• self: Evision.XImgProc.RidgeDetectionFilter.t()
• func: Evision.FileNode

Python prototype (for reference only):

read(fn) -> None

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

save

Positional Arguments

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

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

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None