OpenCV for Unity 3.0.4
Enox Software / Please refer to OpenCV official document ( http://docs.opencv.org/5.0/index.html ) for the details of the argument of the method.
Loading...
Searching...
No Matches
OpenCVForUnity.ImgprocModule.CLAHE Class Reference

Base class for Contrast Limited Adaptive Histogram Equalization. More...

Public Member Functions

void apply (Mat src, Mat dst)
 Equalizes the histogram of a grayscale image using Contrast Limited Adaptive Histogram Equalization.
 
void collectGarbage ()
 
int getBitShift ()
 Returns the bit shift parameter for histogram bins.
 
double getClipLimit ()
 
Size getTilesGridSize ()
 
double double height getTilesGridSizeAsValueTuple ()
 
Vec2d getTilesGridSizeAsVec2d ()
 
void setBitShift (int bitShift)
 Sets bit shift parameter for histogram bins.
 
void setClipLimit (double clipLimit)
 Sets threshold for contrast limiting.
 
void setTilesGridSize (in Vec2d tileGridSize)
 Sets size of grid for histogram equalization. Input image will be divided into equally sized rectangular tiles.
 
void setTilesGridSize (in(double width, double height) tileGridSize)
 Sets size of grid for histogram equalization. Input image will be divided into equally sized rectangular tiles.
 
void setTilesGridSize (Size tileGridSize)
 Sets size of grid for histogram equalization. Input image will be divided into equally sized rectangular tiles.
 
- Public Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
virtual void clear ()
 Clears the algorithm state.
 
virtual bool empty ()
 Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read.
 
virtual string getDefaultName ()
 
IntPtr getNativeObjAddr ()
 
void save (string filename)
 
- Public Member Functions inherited from OpenCVForUnity.DisposableObject
void Dispose ()
 Releases resources used by this object.
 
void ThrowIfDisposed ()
 Throws ObjectDisposedException if this object has been disposed.
 

Static Public Member Functions

static new CLAHE __fromPtr__ (IntPtr addr)
 
- Static Public Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
static Algorithm __fromPtr__ (IntPtr addr)
 
- Static Public Member Functions inherited from OpenCVForUnity.DisposableObject
static IntPtr ThrowIfNullIntPtr (IntPtr ptr)
 Returns the native pointer, or throws CoreModule.CvException if it is zero.
 

Public Attributes

double width
 

Protected Member Functions

override void Dispose (bool disposing)
 
- Protected Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
- Protected Member Functions inherited from OpenCVForUnity.DisposableOpenCVObject
 DisposableOpenCVObject ()
 Initializes a new instance with a zero native pointer and dispose enabled.
 
 DisposableOpenCVObject (bool isEnabledDispose)
 Initializes a new instance with a zero native pointer.
 
 DisposableOpenCVObject (IntPtr ptr)
 Initializes a new instance with the specified native pointer and dispose enabled.
 
 DisposableOpenCVObject (IntPtr ptr, bool isEnabledDispose)
 Initializes a new instance with the specified native pointer.
 
override void Dispose (bool disposing)
 
- Protected Member Functions inherited from OpenCVForUnity.DisposableObject
 DisposableObject ()
 Initializes a new instance with dispose enabled.
 
 DisposableObject (bool isEnabledDispose)
 Initializes a new instance.
 

Additional Inherited Members

- Package Functions inherited from OpenCVForUnity.CoreModule.Algorithm
- Package Attributes inherited from OpenCVForUnity.DisposableOpenCVObject
- Properties inherited from OpenCVForUnity.DisposableObject
bool IsDisposed [get, protected set]
 
bool IsEnabledDispose [get, set]
 

Detailed Description

Base class for Contrast Limited Adaptive Histogram Equalization.

Member Function Documentation

◆ __fromPtr__()

static new CLAHE OpenCVForUnity.ImgprocModule.CLAHE.__fromPtr__ ( IntPtr addr)
static

◆ apply()

void OpenCVForUnity.ImgprocModule.CLAHE.apply ( Mat src,
Mat dst )

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

Parameters
srcSource image of type CV_8UC1 or CV_16UC1.
dstDestination image.

◆ collectGarbage()

void OpenCVForUnity.ImgprocModule.CLAHE.collectGarbage ( )

◆ Dispose()

override void OpenCVForUnity.ImgprocModule.CLAHE.Dispose ( bool disposing)
protectedvirtual

◆ getBitShift()

int OpenCVForUnity.ImgprocModule.CLAHE.getBitShift ( )

Returns the bit shift parameter for histogram bins.

Returns
current bit shift value.

◆ getClipLimit()

double OpenCVForUnity.ImgprocModule.CLAHE.getClipLimit ( )

◆ getTilesGridSize()

Size OpenCVForUnity.ImgprocModule.CLAHE.getTilesGridSize ( )

◆ getTilesGridSizeAsValueTuple()

double double height OpenCVForUnity.ImgprocModule.CLAHE.getTilesGridSizeAsValueTuple ( )

◆ getTilesGridSizeAsVec2d()

Vec2d OpenCVForUnity.ImgprocModule.CLAHE.getTilesGridSizeAsVec2d ( )

◆ setBitShift()

void OpenCVForUnity.ImgprocModule.CLAHE.setBitShift ( int bitShift)

Sets bit shift parameter for histogram bins.

Parameters
bitShiftbit shift value (default is 0).

◆ setClipLimit()

void OpenCVForUnity.ImgprocModule.CLAHE.setClipLimit ( double clipLimit)

Sets threshold for contrast limiting.

Parameters
clipLimitthreshold value.

◆ setTilesGridSize() [1/3]

void OpenCVForUnity.ImgprocModule.CLAHE.setTilesGridSize ( in Vec2d tileGridSize)

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

Parameters
tileGridSizedefines the number of tiles in row and column.

◆ setTilesGridSize() [2/3]

void OpenCVForUnity.ImgprocModule.CLAHE.setTilesGridSize ( in(double width, double height) tileGridSize)

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

Parameters
tileGridSizedefines the number of tiles in row and column.

◆ setTilesGridSize() [3/3]

void OpenCVForUnity.ImgprocModule.CLAHE.setTilesGridSize ( Size tileGridSize)

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

Parameters
tileGridSizedefines the number of tiles in row and column.

Member Data Documentation

◆ width

double OpenCVForUnity.ImgprocModule.CLAHE.width

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