Android Scanbot SDK API reference/io.scanbot.sdk.imagefilters/GrayscaleFilter

GrayscaleFilter

data class GrayscaleFilter(var borderWidthFraction: Double = 0.06, var blackOutliersFraction: Double = 0.0, var whiteOutliersFraction: Double = 0.02) : ParametricFilter, Parcelable

Converts color images to grayscale and applies autocontrast.

Constructors

GrayscaleFilter

constructor(source: Map<String, Any?>)

constructor(json: JSONObject)

constructor(borderWidthFraction: Double = 0.06, blackOutliersFraction: Double = 0.0, whiteOutliersFraction: Double = 0.02)

Types

Companion

object Companion

Properties

_type

open override val _type: String

blackOutliersFraction

var blackOutliersFraction: Double

Clip this fraction of the darkest pixels in operations such as autocontrast. Increasing the range of middle gray levels at the expense of the brightest and darkest levels may improve the overall contrast and quality of the result. Sum of blackOutliersFraction and whiteOutliersFraction must be less than 1 but usually good values for the parameters do not exceed 0.05;.

borderWidthFraction

var borderWidthFraction: Double

Ignore this fraction of pixels at the edge of the image when calculating statistics. Pixels at the edge of the image typically have poor statistics. Ignoring them and using only the inner pixels when calculating certain statistics can substantially improve the quality of the result. The value must be less than 0.5 but usually good values are between 0 and 0.15.

whiteOutliersFraction

var whiteOutliersFraction: Double

Clip this fraction of the brightest pixels in operations such as autocontrast. Increasing the range of middle gray levels at the expense of the brightest and darkest levels may improve the overall contrast and quality of the result. Sum of blackOutliersFraction and whiteOutliersFraction must be less than 1 but usually good values for the parameters do not exceed 0.05;.

Functions

clone

open override fun clone(): GrayscaleFilter

toJson

open override fun toJson(config: ToJsonConfiguration): JSONObject