Class GrayscaleFilter

Converts color images to grayscale and applies autocontrast.

Hierarchy

  • PartiallyConstructible
    • GrayscaleFilter

Constructors

constructor

Properties

_type blackOutliersFraction borderWidthFraction whiteOutliersFraction

Constructors

constructor

  • new GrayscaleFilter(source?): GrayscaleFilter

  • Parameters

    • Optional source: {
          _type?: "GrayscaleFilter";
          blackOutliersFraction?: number;
          borderWidthFraction?: number;
          whiteOutliersFraction?: number;
      }
      • Optional _type?: "GrayscaleFilter"
      • Optional blackOutliersFraction?: number

        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;

        Default Value

        0.0;
      • Optional borderWidthFraction?: number

        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.

        Default Value

        0.06;
      • Optional whiteOutliersFraction?: number

        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;

        Default Value

        0.02;

    Returns GrayscaleFilter

Properties

_type

_type: "GrayscaleFilter"

blackOutliersFraction

blackOutliersFraction: number

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;

Default Value

0.0;

borderWidthFraction

borderWidthFraction: number

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.

Default Value

0.06;

whiteOutliersFraction

whiteOutliersFraction: number

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;

Default Value

0.02;

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc