Package io.scanbot.sdk.imageprocessing

Class WhiteBlackPointFilter

  • public class WhiteBlackPointFilter
extends ParametricFilter
    Maps image value channel so that all the pixels darker than the black point are set to 0, all the pixels brighter than the white point are set to 255, and the pixels in between are linearly scaled.

    • Constructor Summary

      Constructors 
      Constructor Description
      WhiteBlackPointFilter()
      Constructs WhiteBlackPointFilter with default parameters.
      WhiteBlackPointFilter​(double blackPoint, double whitePoint)
      Constructs WhiteBlackPointFilter with the given params.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      double getBlackPoint()
      Getter for blackPoint field.
      double getWhitePoint()
      Getter for whitePoint field.
      void setBlackPoint​(double blackPoint)
      Setter for blackPoint field.
      void setWhitePoint​(double whitePoint)
      Setter for whitePoint field.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • WhiteBlackPointFilter

        public WhiteBlackPointFilter​(double blackPoint,
                             double whitePoint)
        Constructs WhiteBlackPointFilter with the given params.
        Parameters:
        blackPoint - Fraction of the value channel range that is set to 0. The value should be in the range from 0 to 1. Default is 0.0
        whitePoint - Fraction of the value channel range that is not set to 255. The value should be in the range from 0 to 1. Default is 1.0

      • WhiteBlackPointFilter

        public WhiteBlackPointFilter()
        Constructs WhiteBlackPointFilter with default parameters.

    • Method Detail

      • getBlackPoint

        public double getBlackPoint()
        Getter for blackPoint field. See constructor documentation for more information about the field.
        Returns:
        blackPoint

      • setBlackPoint

        public void setBlackPoint​(double blackPoint)
        Setter for blackPoint field. See constructor documentation for more information about the field.
        Parameters:
        blackPoint - Value to set.

      • getWhitePoint

        public double getWhitePoint()
        Getter for whitePoint field. See constructor documentation for more information about the field.
        Returns:
        whitePoint

      • setWhitePoint

        public void setWhitePoint​(double whitePoint)
        Setter for whitePoint field. See constructor documentation for more information about the field.
        Parameters:
        whitePoint - Value to set.