Clahe

Documentation of 'Catalano.Imaging.Filters.Clahe' Java class Clahe

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- Catalano.Imaging.Filters.Clahe

All Implemented Interfaces:

IApplyInPlace
```
public class Clahe
extends java.lang.Object
implements IApplyInPlace
```
Contrast Limited Adaptive Histogram Equalization.
This feature can also be applied to global histogram equalization, giving rise to contrast limited histogram equalization (CLHE) which is rarely used in practice.

References: http://en.wikipedia.org/wiki/Adaptive_histogram_equalization#Contrast_Limited_AHE
Supported types: Grayscale, RGB.
Coordinate System: Matrix.

Constructor Summary

Constructors
Constructor and Description
`Clahe()` Initialize a new instance of the CLAHE class.
`Clahe(int blockRadius, int bins)` Initialize a new instance of the CLAHE class.
`Clahe(int blockRadius, int bins, float slope)` Initialize a new instance of the CLAHE class.
`Clahe(int blockRadius, int bins, float slope, Grayscale.Algorithm algorithm)` Initialize a new instance of the CLAHE class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyInPlace(FastBitmap fastBitmap)` Apply filter to an image.
`Grayscale.Algorithm`	`getAlgorithm()` Get Grayscale algorithm.
`int`	`getBins()` Get the number of histogram bins used for histogram equalization.
`int`	`getBlockRadius()` Get Block radius.
`float`	`getSlope()` Get Slope.
`void`	`setAlgorithm(Grayscale.Algorithm algorithm)` Set Grayscale algorithm.
`void`	`setBins(int bins)` Set the number of histogram bins used for histogram equalization.
`void`	`setBlockRadius(int blockRadius)` Set Block radius.
`void`	`setSlope(float slope)` Set Slope.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Clahe
```
public Clahe()
```
    Initialize a new instance of the CLAHE class.
    
    Block radius: 63.
    Bins: 255.
    Slope: 3.
  - Clahe
```
public Clahe(int blockRadius,
             int bins)
```
    Initialize a new instance of the CLAHE class.
    
    Parameters:
    
    blockRadius - Block radius.
    
    bins - Bins.
  - Clahe
```
public Clahe(int blockRadius,
             int bins,
             float slope)
```
    Initialize a new instance of the CLAHE class.
    
    Parameters:
    
    blockRadius - Block radius.
    
    bins - Bins.
    
    slope - Slope.
  - Clahe
```
public Clahe(int blockRadius,
             int bins,
             float slope,
             Grayscale.Algorithm algorithm)
```
    Initialize a new instance of the CLAHE class.
    
    Parameters:
    
    blockRadius - Block radius.
    
    bins - Bins.
    
    slope - Slope.
    
    algorithm - Grayscale algorithm.
- Method Detail
  - getBlockRadius
```
public int getBlockRadius()
```
    Get Block radius. The size of the local region around a pixel for which the histogram is equalized. This size should be larger than the size of features to be preserved.
    
    Returns:
    
    Size of block radius.
  - setBlockRadius
```
public void setBlockRadius(int blockRadius)
```
    Set Block radius. The size of the local region around a pixel for which the histogram is equalized. This size should be larger than the size of features to be preserved.
    
    Parameters:
    
    blockRadius - Size of block radius.
  - getBins
```
public int getBins()
```
    Get the number of histogram bins used for histogram equalization.
    
    Returns:
    
    Number of histogram bins.
  - setBins
```
public void setBins(int bins)
```
    Set the number of histogram bins used for histogram equalization.
    
    Parameters:
    
    bins - Number of histogram bins.
  - getSlope
```
public float getSlope()
```
    Get Slope. Limits the contrast stretch in the intensity transfer function. Very large values will let the histogram equalization do whatever it wants to do, that is result in maximal local contrast. The value 1 will result in the original image.
    
    Returns:
    
    Slope.
  - setSlope
```
public void setSlope(float slope)
```
    Set Slope. Limits the contrast stretch in the intensity transfer function. Very large values will let the histogram equalization do whatever it wants to do, that is result in maximal local contrast. The value 1 will result in the original image.
    
    Parameters:
    
    slope - Slope.
  - getAlgorithm
```
public Grayscale.Algorithm getAlgorithm()
```
    Get Grayscale algorithm.
    
    Returns:
    
    Grayscale algorithm.
  - setAlgorithm
```
public void setAlgorithm(Grayscale.Algorithm algorithm)
```
    Set Grayscale algorithm.
    
    Parameters:
    
    algorithm - Grayscale algorithm.
  - applyInPlace
```
public void applyInPlace(FastBitmap fastBitmap)
```
    Description copied from interface: IApplyInPlace
    
    Apply filter to an image.
    
    Specified by:
    
    applyInPlace in interface IApplyInPlace
    
    Parameters:
    
    fastBitmap - Image to be processed.

Class Clahe

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Clahe

Clahe

Clahe

Clahe

Method Detail

getBlockRadius

setBlockRadius

getBins

setBins

getSlope

setSlope

getAlgorithm

setAlgorithm

applyInPlace