View Source Evision.CLAHE (Evision v0.1.17)

Link to this section Summary

Types

t()

Type that represents an Evision.CLAHE struct.

Functions

Equalizes the histogram of a grayscale image using Contrast Limited Adaptive Histogram Equalization.

Equalizes the histogram of a grayscale image using Contrast Limited Adaptive Histogram Equalization.

collectGarbage

getClipLimit

getTilesGridSize

Sets threshold for contrast limiting.

Sets size of grid for histogram equalization. Input image will be divided into equally sized rectangular tiles.

Link to this section Types

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

Type that represents an Evision.CLAHE struct.

  • ref. reference()

    The underlying erlang resource variable.

Link to this section Functions

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

Equalizes the histogram of a grayscale image using Contrast Limited Adaptive Histogram Equalization.

Positional Arguments
  • self: Evision.CLAHE.t()

  • src: Evision.Mat.

    Source image of type CV_8UC1 or CV_16UC1.

Return

Python prototype (for reference only):

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

Equalizes the histogram of a grayscale image using Contrast Limited Adaptive Histogram Equalization.

Positional Arguments
  • self: Evision.CLAHE.t()

  • src: Evision.Mat.

    Source image of type CV_8UC1 or CV_16UC1.

Return

Python prototype (for reference only):

apply(src[, dst]) -> dst
@spec collectGarbage(t()) :: :ok | {:error, String.t()}

collectGarbage

Positional Arguments
  • self: Evision.CLAHE.t()

Python prototype (for reference only):

collectGarbage() -> None
@spec getClipLimit(t()) :: number() | {:error, String.t()}

getClipLimit

Positional Arguments
  • self: Evision.CLAHE.t()
Return
  • retval: double

Python prototype (for reference only):

getClipLimit() -> retval
@spec getTilesGridSize(t()) :: {number(), number()} | {:error, String.t()}

getTilesGridSize

Positional Arguments
  • self: Evision.CLAHE.t()
Return
  • retval: Size

Python prototype (for reference only):

getTilesGridSize() -> retval
Link to this function

setClipLimit(self, clipLimit)

View Source
@spec setClipLimit(t(), number()) :: :ok | {:error, String.t()}

Sets threshold for contrast limiting.

Positional Arguments
  • self: Evision.CLAHE.t()

  • clipLimit: double.

    threshold value.

Python prototype (for reference only):

setClipLimit(clipLimit) -> None
Link to this function

setTilesGridSize(self, tileGridSize)

View Source
@spec setTilesGridSize(
  t(),
  {number(), number()}
) :: :ok | {:error, String.t()}

Sets size of grid for histogram equalization. Input image will be divided into equally sized rectangular tiles.

Positional Arguments
  • self: Evision.CLAHE.t()

  • tileGridSize: Size.

    defines the number of tiles in row and column.

Python prototype (for reference only):

setTilesGridSize(tileGridSize) -> None