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

  Source image of type CV_8UC1 or CV_16UC1.

Return

• dst: Evision.Mat.t().

  Destination image.

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

  Source image of type CV_8UC1 or CV_16UC1.

Return

• dst: Evision.Mat.t().

  Destination image.

Python prototype (for reference only):

apply(src[, dst]) -> dst

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

Clears the algorithm state

Positional Arguments

• self: Evision.CLAHE.t()

Python prototype (for reference only):

clear() -> None

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

collectGarbage

Positional Arguments

• self: Evision.CLAHE.t()

Python prototype (for reference only):

collectGarbage() -> 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.CLAHE.t()

Return

• retval: bool

Python prototype (for reference only):

empty() -> retval

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

getDefaultName

Positional Arguments

• self: Evision.CLAHE.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 getTilesGridSize(t()) :: {number(), number()} | {:error, String.t()}

getTilesGridSize

Positional Arguments

• self: Evision.CLAHE.t()

Return

• retval: Size

Python prototype (for reference only):

getTilesGridSize() -> retval

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

Reads algorithm parameters from a file storage

Positional Arguments

• self: Evision.CLAHE.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.CLAHE.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 setClipLimit(t(), number()) :: t() | {: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

@spec setTilesGridSize(
  t(),
  {number(), number()}
) :: t() | {: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

@spec write(t(), Evision.FileStorage.t()) :: t() | {:error, String.t()}

Stores algorithm parameters in a file storage

Positional Arguments

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

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None