View Source Evision.CLAHE (Evision v0.1.21)

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.

Clears the algorithm state

collectGarbage

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

getClipLimit

getDefaultName

getTilesGridSize

Reads algorithm parameters from a file storage

Sets threshold for contrast limiting.

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

simplified API for language bindings

simplified API for language bindings

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

Clears the algorithm state

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

Python prototype (for reference only):

clear() -> None
@spec collectGarbage(t()) :: :ok | {: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

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

Reads algorithm parameters from a file storage

Positional Arguments

Python prototype (for reference only):

read(fn_) -> None
@spec save(t(), binary()) :: :ok | {: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
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
@spec write(t(), Evision.FileStorage.t()) :: :ok | {:error, String.t()}

simplified API for language bindings

Positional Arguments
Keyword Arguments

Has overloading in C++

Python prototype (for reference only):

write(fs[, name]) -> None
@spec write(t(), Evision.FileStorage.t(), [{atom(), term()}, ...] | nil) ::
  :ok | {:error, String.t()}

simplified API for language bindings

Positional Arguments
Keyword Arguments

Has overloading in C++

Python prototype (for reference only):

write(fs[, name]) -> None