Package io.scanbot.sdk.documentqualityanalyzer

Class ProcessByTileConfiguration

java.lang.Object

io.scanbot.sdk.documentqualityanalyzer.ProcessByTileConfiguration

public class ProcessByTileConfiguration
extends Object

Configuration for processing image by tiles. This can be used to make the document quality analyzer processing faster with lower memory consumption, but prediction can be less accurate.

Constructor Summary

Constructors

Constructor	Description
ProcessByTileConfiguration()	Constructs ProcessByTileConfiguration with default parameters.
ProcessByTileConfiguration(boolean enabled, double minProcessedFraction, double maxProcessedFraction, int minNumberOfRequiredSymbols, int tileSize)	Constructs ProcessByTileConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
boolean	getEnabled()	Getter for enabled field.
double	getMaxProcessedFraction()	Getter for maxProcessedFraction field.
int	getMinNumberOfRequiredSymbols()	Getter for minNumberOfRequiredSymbols field.
double	getMinProcessedFraction()	Getter for minProcessedFraction field.
int	getTileSize()	Getter for tileSize field.
void	setEnabled(boolean enabled)	Setter for enabled field.
void	setMaxProcessedFraction(double maxProcessedFraction)	Setter for maxProcessedFraction field.
void	setMinNumberOfRequiredSymbols(int minNumberOfRequiredSymbols)	Setter for minNumberOfRequiredSymbols field.
void	setMinProcessedFraction(double minProcessedFraction)	Setter for minProcessedFraction field.
void	setTileSize(int tileSize)	Setter for tileSize field.

Methods inherited from class java.lang.Object

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

Constructor Details

ProcessByTileConfiguration

public ProcessByTileConfiguration(boolean enabled,
 double minProcessedFraction,
 double maxProcessedFraction,
 int minNumberOfRequiredSymbols,
 int tileSize)

Constructs ProcessByTileConfiguration with the given params.

Parameters:

enabled - Enable processing by tiles. Default is `false`.

minProcessedFraction - At least this fraction of the image will be processed, range is from 0 to 1. Decreasing this value below 1.0 can lead to faster processing but may result in less accurate prediction, as only a subset of the image tiles will be analyzed. Default is `1`.

maxProcessedFraction - At most this fraction of the image will be processed, range is from 0 to 1. Decreasing this value below 1.0 can lead to faster processing but may result in less accurate prediction, as only a subset of the image tiles will be analyzed. Default is `1`.

minNumberOfRequiredSymbols - If this number of symbols is found and minProcessedFraction of the image is processed, the processing stops. Default is `100`.

tileSize - Image will be processed in tiles of this size; will be ignored if image is small. Default is `300`.

ProcessByTileConfiguration

public ProcessByTileConfiguration()

Constructs ProcessByTileConfiguration with default parameters.

Method Details

getEnabled

public boolean getEnabled()

Getter for enabled field. See constructor documentation for more information about the field.

Returns:

enabled

setEnabled

public void setEnabled(boolean enabled)

Setter for enabled field. See constructor documentation for more information about the field.

Parameters:

enabled - Value to set.

getMinProcessedFraction

public double getMinProcessedFraction()

Getter for minProcessedFraction field. See constructor documentation for more information about the field.

Returns:

minProcessedFraction

setMinProcessedFraction

public void setMinProcessedFraction(double minProcessedFraction)

Setter for minProcessedFraction field. See constructor documentation for more information about the field.

Parameters:

minProcessedFraction - Value to set.

getMaxProcessedFraction

public double getMaxProcessedFraction()

Getter for maxProcessedFraction field. See constructor documentation for more information about the field.

Returns:

maxProcessedFraction

setMaxProcessedFraction

public void setMaxProcessedFraction(double maxProcessedFraction)

Setter for maxProcessedFraction field. See constructor documentation for more information about the field.

Parameters:

maxProcessedFraction - Value to set.

getMinNumberOfRequiredSymbols

public int getMinNumberOfRequiredSymbols()

Getter for minNumberOfRequiredSymbols field. See constructor documentation for more information about the field.

Returns:

minNumberOfRequiredSymbols

setMinNumberOfRequiredSymbols

public void setMinNumberOfRequiredSymbols(int minNumberOfRequiredSymbols)

Setter for minNumberOfRequiredSymbols field. See constructor documentation for more information about the field.

Parameters:

minNumberOfRequiredSymbols - Value to set.

getTileSize

public int getTileSize()

Getter for tileSize field. See constructor documentation for more information about the field.

Returns:

tileSize

setTileSize

public void setTileSize(int tileSize)

Setter for tileSize field. See constructor documentation for more information about the field.

Parameters:

tileSize - Value to set.