BrightnessFilter

java.lang.Object

io.scanbot.sdk.imageprocessing.ParametricFilter

io.scanbot.sdk.imageprocessing.BrightnessFilter

public class BrightnessFilter extends ParametricFilter

Brightness adjustment filter.

Constructor Summary

Constructors

Constructor

Description

BrightnessFilter()

Constructs BrightnessFilter with default parameters.

BrightnessFilter(double brightness)

Constructs BrightnessFilter with the given params.
Method Summary

Modifier and Type

Method

Description

double

getBrightness()

Getter for brightness field.

void

setBrightness(double brightness)

Setter for brightness field.

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

Constructor Details
- BrightnessFilter
  
  public BrightnessFilter(double brightness)
  
  Constructs BrightnessFilter with the given params.
  
  Parameters:
  
  brightness - Brightness adjustment value in the range from -1 to 1. Negative values will make the image darker, positive values will make it brighter. Default is `0.0`.
- BrightnessFilter
  
  public BrightnessFilter()
  
  Constructs BrightnessFilter with default parameters.
Method Details
- getBrightness
  
  public double getBrightness()
  
  Getter for brightness field. See constructor documentation for more information about the field.
  
  Returns:
  
  brightness
- setBrightness
  
  public void setBrightness(double brightness)
  
  Setter for brightness field. See constructor documentation for more information about the field.
  
  Parameters:
  
  brightness - Value to set.