Class cv::CLAHE#

Base class for Contrast Limited Adaptive Histogram Equalization.

#include <opencv2/imgproc.hpp>

Collaboration diagram for cv::CLAHE:

Public Member Functions#

Public Member Functions inherited from cv::Algorithm

Return	Name	Description
	`Algorithm()`
	`~Algorithm()`
`void`	`clear()`	Clears the algorithm state.
`bool`	`empty()`	Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read.
`String`	`getDefaultName()`
`void`	`read(const FileNode & fn)`	Reads algorithm parameters from a file storage.
`void`	`save(const String & filename)`
`void`	`write(` `const Ptr< FileStorage > & fs,` `const String & name = String() )`
`void`	`write(FileStorage & fs)`	Stores algorithm parameters in a file storage.
`void`	`write(` `FileStorage & fs,` `const String & name )`

Static Public Member Functions#

Static Public Member Functions inherited from cv::Algorithm

Return	Name	Description
`static Ptr< _Tp >`	`load(` `const String & filename,` `const String & objname = String() )`	Loads algorithm from the file.
`static Ptr< _Tp >`	`loadFromString(` `const String & strModel,` `const String & objname = String() )`	Loads algorithm from a String.
`static Ptr< _Tp >`	`read(const FileNode & fn)`	Reads algorithm from the file node.

Additional Inherited Members#

Detailed Description#

Base class for Contrast Limited Adaptive Histogram Equalization.

Member Function Documentation#

apply()#

void cv::CLAHE::apply(
InputArray src,
OutputArray dst )

Python:

cv.CLAHE.apply(src[, dst]) -> dst

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

Parameters

src — Source image of type CV_8UC1 or CV_16UC1.
dst — Destination image.

collectGarbage()#

void cv::CLAHE::collectGarbage()

Python:

cv.CLAHE.collectGarbage()

getBitShift()#

int cv::CLAHE::getBitShift()

Python:

cv.CLAHE.getBitShift() -> retval

Returns the bit shift parameter for histogram bins.

Returns

current bit shift value.

getClipLimit()#

double cv::CLAHE::getClipLimit()

Python:

cv.CLAHE.getClipLimit() -> retval

Returns threshold value for contrast limiting.

getTilesGridSize()#

Size cv::CLAHE::getTilesGridSize()

Python:

cv.CLAHE.getTilesGridSize() -> retval

Returns Size defines the number of tiles in row and column.

setBitShift()#

void cv::CLAHE::setBitShift(int bitShift)

Python:

cv.CLAHE.setBitShift(bitShift)

Sets bit shift parameter for histogram bins.

Parameters

bitShift — bit shift value (default is 0).

setClipLimit()#

void cv::CLAHE::setClipLimit(double clipLimit)

Python:

cv.CLAHE.setClipLimit(clipLimit)

Sets threshold for contrast limiting.

Parameters

clipLimit — threshold value.

setTilesGridSize()#

void cv::CLAHE::setTilesGridSize(Size tileGridSize)

Python:

cv.CLAHE.setTilesGridSize(tileGridSize)

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

Parameters

tileGridSize — defines the number of tiles in row and column.

Source file#

The documentation for this class was generated from the following file:

opencv2/imgproc.hpp