Package net.webpdf.wsclient.openapi

Class OperationImageOptimization

  • public class OperationImageOptimization
extends Object
    The optimization element allows to correct the images of the pages to optimize them for OCR. Except for the \"deskew\" parameter, none of the optimizations are actually visible in the generated documents. The other optimizations are only used to improve the text recognition.

    • Constructor Detail

      • OperationImageOptimization

        public OperationImageOptimization()

    • Method Detail

      • getDeskew

        @Nullable
public @Nullable Boolean getDeskew()
        Straight scans of pages can be created with a slight skew. If this value is set to true, an attempt is made to counter-rotate this skew and thus \"deskew\" the page. The results of this manipulation are visible in the resulting document.
        Returns:
        deskew

      • setDeskew

        public void setDeskew​(Boolean deskew)

      • getDespeckle

        @Nullable
public @Nullable Boolean getDespeckle()
        If this mode is set, impurities and stains are reduced. These are caused, for example, by dust or dirt on the pane of a scanner. It is recommended to activate this optimization.
        Returns:
        despeckle

      • setDespeckle

        public void setDespeckle​(Boolean despeckle)

      • getEdgeAccentuation

        @Nullable
public @Nullable OperationImageOptimization.EdgeAccentuationEnum getEdgeAccentuation()
        If this value is set, edge sharpening is applied to the image. This optimization usually leads to significantly better recognition results, but can also lead to information loss. * off = Do not apply this optimization * value = Select your own value * low = Apply optimization only with low intensity to avoid information loss. * medium = Perform optimization with medium intensity. * high = Perform optimization with strong intensity and accept possible information losses.
        Returns:
        edgeAccentuation

      • getEdgeAccentuationValue

        @Nullable
public @Nullable Integer getEdgeAccentuationValue()
        Allows in combination with the edgeAccentuation mode \"value\" the free choice of a value for this optimization. An integer percentage value indicates the intensity of the edge accentuation. The actual image is overlaid with a corresponding sharpening filter for the edge accentuation - this percentage value specifies how intensively this effect should be emphasized compared to the original image. The predefined values range between 100 (low) and 200 percent (high). minimum: 0
        Returns:
        edgeAccentuationValue

      • setEdgeAccentuationValue

        public void setEdgeAccentuationValue​(Integer edgeAccentuationValue)

      • getGammaCorrection

        @Nullable
public @Nullable OperationImageOptimization.GammaCorrectionEnum getGammaCorrection()
        If this value is set, edge sharpening is applied to the image. This optimization usually leads to significantly better recognition results, but can also lead to information loss. * off = Do not apply this optimization * value = Select your own value * low = Apply optimization only with low intensity to avoid information loss. * medium = Perform optimization with medium intensity. * high = Perform optimization with strong intensity and accept possible information losses.
        Returns:
        gammaCorrection

      • getGammaCorrectionValue

        @Nullable
public @Nullable Float getGammaCorrectionValue()
        Allows in combination with the gammaCorrection mode \"value\" the free choice of a value for this optimization. A comma value greater than 0 specifies the value to be applied to the image as gamma correction. The predefined values range between 1.5 (low) and 2.5 (high). minimum: 0.0
        Returns:
        gammaCorrectionValue

      • setGammaCorrectionValue

        public void setGammaCorrectionValue​(Float gammaCorrectionValue)

      • getIncreaseContrast

        @Nullable
public @Nullable OperationImageOptimization.IncreaseContrastEnum getIncreaseContrast()
        If this value is set, edge sharpening is applied to the image. This optimization usually leads to significantly better recognition results, but can also lead to information loss. * off = Do not apply this optimization * value = Select your own value * low = Apply optimization only with low intensity to avoid information loss. * medium = Perform optimization with medium intensity. * high = Perform optimization with strong intensity and accept possible information losses.
        Returns:
        increaseContrast

      • getIncreaseContrastValue

        @Nullable
public @Nullable Integer getIncreaseContrastValue()
        Allows in combination with the increaseContrast mode \"value\" the free choice of a value for this optimization. An integer value between -100 and +100 specifies the intensity of the contrast enhancement. The predefined values range between 25 (low) and 75 (high). minimum: -100 maximum: 100
        Returns:
        increaseContrastValue

      • setIncreaseContrastValue

        public void setIncreaseContrastValue​(Integer increaseContrastValue)

      • getMedianFilter

        @Nullable
public @Nullable OperationImageOptimization.MedianFilterEnum getMedianFilter()
        If this value is set, edge sharpening is applied to the image. This optimization usually leads to significantly better recognition results, but can also lead to information loss. * off = Do not apply this optimization * value = Select your own value * low = Apply optimization only with low intensity to avoid information loss. * medium = Perform optimization with medium intensity. * high = Perform optimization with strong intensity and accept possible information losses.
        Returns:
        medianFilter

      • getMedianFilterValue

        @Nullable
public @Nullable Integer getMedianFilterValue()
        Allows, in combination with the medianFilter mode \"value\", the free choice of a value for this optimization. An integer value greater than 0 specifies the grid size with which the effect is to be applied to the image. The predefined values range between 1 (low) and 3 (high). minimum: 0
        Returns:
        medianFilterValue

      • setMedianFilterValue

        public void setMedianFilterValue​(Integer medianFilterValue)

      • getNoiseReduction

        @Nullable
public @Nullable OperationImageOptimization.NoiseReductionEnum getNoiseReduction()
        If this value is set, edge sharpening is applied to the image. This optimization usually leads to significantly better recognition results, but can also lead to information loss. * off = Do not apply this optimization * value = Select your own value * low = Apply optimization only with low intensity to avoid information loss. * medium = Perform optimization with medium intensity. * high = Perform optimization with strong intensity and accept possible information losses.
        Returns:
        noiseReduction

      • getNoiseReductionValue

        @Nullable
public @Nullable Float getNoiseReductionValue()
        Allows in combination with the noiseReduction mode \"value\" the free choice of a value for this optimization. A decimal value greater than 0 indicates the intensity with which the effect is to be applied to the image. The predefined values range between 1.0 (low) and 3.0 (high). minimum: 0.0
        Returns:
        noiseReductionValue

      • setNoiseReductionValue

        public void setNoiseReductionValue​(Float noiseReductionValue)

      • getReduceDithering

        @Nullable
public @Nullable Boolean getReduceDithering()
        In black and white images (including black and white scans), color values are often represented by a halftone according to their brightness (dithering / moiré effect). These halftones/hatchings translate a color value into a uniform sequence of black and white areas that visually appear to be a uniform area of the same color/brightness. Such patterns can be very difficult to delineate against actual text that may be in such a \"colored\" area. Setting this value to true will try to reduce such dithering patterns. This mode should only be set if absolutely necessary, as this process can be very lossy.
        Returns:
        reduceDithering

      • setReduceDithering

        public void setReduceDithering​(Boolean reduceDithering)

      • getSharpen

        @Nullable
public @Nullable OperationImageOptimization.SharpenEnum getSharpen()
        If this value is set, edge sharpening is applied to the image. This optimization usually leads to significantly better recognition results, but can also lead to information loss. * off = Do not apply this optimization * value = Select your own value * low = Apply optimization only with low intensity to avoid information loss. * medium = Perform optimization with medium intensity. * high = Perform optimization with strong intensity and accept possible information losses.
        Returns:
        sharpen

      • getSharpenValue

        @Nullable
public @Nullable Float getSharpenValue()
        Allows in combination with the sharpen mode \"value\" the free choice of a value for this optimization. A comma value greater than 0 indicates the intensity with which the effect is to be applied to the image. The predefined values range between 1.0 (low) and 3.0 (high). minimum: 0.0
        Returns:
        sharpenValue

      • setSharpenValue

        public void setSharpenValue​(Float sharpenValue)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object