com.aspose.imaging.imagefilters.filteroptions

Class AdaptiveWhiteStretchFilterOptions

java.lang.Object

com.aspose.imaging.imagefilters.filteroptions.FilterOptionsBase

com.aspose.imaging.imagefilters.filteroptions.AdaptiveWhiteStretchFilterOptions

public class AdaptiveWhiteStretchFilterOptions
extends FilterOptionsBase

Provides options for configuring the Adaptive White Stretch filter. Allows customization of histogram stretch parameters to enhance the white level and improve the readability of faint-text or low-contrast document images.

Constructor Summary

Constructors

Constructor and Description
AdaptiveWhiteStretchFilterOptions()
AdaptiveWhiteStretchFilterOptions(boolean isGrayscale)
AdaptiveWhiteStretchFilterOptions(boolean isGrayscale, int lowPercentile)
AdaptiveWhiteStretchFilterOptions(boolean isGrayscale, int lowPercentile, int highPercentile)
AdaptiveWhiteStretchFilterOptions(boolean isGrayscale, int lowPercentile, int highPercentile, int targetWhite)
AdaptiveWhiteStretchFilterOptions(boolean isGrayscale, int lowPercentile, int highPercentile, int targetWhite, float maxScale) Initializes a new instance of the AdaptiveWhiteStretchFilter class.

Method Summary

Modifier and Type	Method and Description
int	getHighPercentile() Gets the upper percentile for white point calculation.
int	getLowPercentile() Gets the lower percentile for black point calculation.
float	getMaxScale() Gets the maximum allowed brightness scale.
int	getTargetWhite() Gets the target white value the stretch aims to achieve.
boolean	isGrayscale() Gets a value indicating whether the filter operates in grayscale mode.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdaptiveWhiteStretchFilterOptions

public AdaptiveWhiteStretchFilterOptions()

AdaptiveWhiteStretchFilterOptions

public AdaptiveWhiteStretchFilterOptions(boolean isGrayscale)

AdaptiveWhiteStretchFilterOptions

public AdaptiveWhiteStretchFilterOptions(boolean isGrayscale,
                                         int lowPercentile)

AdaptiveWhiteStretchFilterOptions

public AdaptiveWhiteStretchFilterOptions(boolean isGrayscale,
                                         int lowPercentile,
                                         int highPercentile)

AdaptiveWhiteStretchFilterOptions

public AdaptiveWhiteStretchFilterOptions(boolean isGrayscale,
                                         int lowPercentile,
                                         int highPercentile,
                                         int targetWhite)

AdaptiveWhiteStretchFilterOptions

public AdaptiveWhiteStretchFilterOptions(boolean isGrayscale,
                                         int lowPercentile,
                                         int highPercentile,
                                         int targetWhite,
                                         float maxScale)

Initializes a new instance of the AdaptiveWhiteStretchFilter class.

Parameters:

isGrayscale - Indicates whether the filter should operate in grayscale mode.

lowPercentile - Lower percentile for black point (e.g. 10).

highPercentile - Upper percentile for white point (e.g. 90).

targetWhite - Target white value (e.g. 240).

maxScale - Maximum allowed brightness scale (e.g. 1.7).

The algorithm stretches the histogram so that the white percentile approaches targetWhite, but without exceeding maxScale to avoid over-brightening.

Method Detail

isGrayscale

public final boolean isGrayscale()

Gets a value indicating whether the filter operates in grayscale mode.

Returns:

a value indicating whether the filter operates in grayscale mode.

getLowPercentile

public final int getLowPercentile()

Gets the lower percentile for black point calculation. Pixel values below this percentile are considered as black during stretching.

Returns:

the lower percentile for black point calculation.

getHighPercentile

public final int getHighPercentile()

Gets the upper percentile for white point calculation. Pixel values above this percentile are considered as white during stretching.

Returns:

the upper percentile for white point calculation.

getTargetWhite

public final int getTargetWhite()

Gets the target white value the stretch aims to achieve.

Returns:

the target white value the stretch aims to achieve.

getMaxScale

public final float getMaxScale()

Gets the maximum allowed brightness scale. The actual stretching will not exceed this factor, to avoid over-brightening.

Returns:

the maximum allowed brightness scale.