Package io.scanbot.sdk.tiffgeneration

Class TiffGeneratorParameters

java.lang.Object

io.scanbot.sdk.tiffgeneration.TiffGeneratorParameters

public class TiffGeneratorParameters
extends Object

TIFF generator parameters.

Field Summary

Fields

Modifier and Type	Field	Description
static final CompressionMode	binaryDocumentOptimizedCompression	Compression mode typically producing the smallest file sizes for binary (1-bit) document images.
static final CompressionMode	defaultCompression	Default compression.

Constructor Summary

Constructors

Constructor	Description
TiffGeneratorParameters()	Constructs TiffGeneratorParameters with default parameters.
TiffGeneratorParameters(CompressionMode compression, int jpegQuality, int zipCompressionLevel, int dpi, List<UserField> userFields, ParametricFilter binarizationFilter)	Constructs TiffGeneratorParameters with the given params.

Method Summary

Modifier and Type	Method	Description
ParametricFilter	getBinarizationFilter()	Getter for binarizationFilter field.
CompressionMode	getCompression()	Getter for compression field.
int	getDpi()	Getter for dpi field.
int	getJpegQuality()	Getter for jpegQuality field.
List<UserField>	getUserFields()	Getter for userFields field.
int	getZipCompressionLevel()	Getter for zipCompressionLevel field.
void	setBinarizationFilter(ParametricFilter binarizationFilter)	Setter for binarizationFilter field.
void	setCompression(CompressionMode compression)	Setter for compression field.
void	setDpi(int dpi)	Setter for dpi field.
void	setJpegQuality(int jpegQuality)	Setter for jpegQuality field.
void	setUserFields(List<UserField> userFields)	Setter for userFields field.
void	setZipCompressionLevel(int zipCompressionLevel)	Setter for zipCompressionLevel field.

Methods inherited from class java.lang.Object

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

Field Details

defaultCompression

public static final CompressionMode defaultCompression

Default compression. Default is `LZW`.

binaryDocumentOptimizedCompression

public static final CompressionMode binaryDocumentOptimizedCompression

Compression mode typically producing the smallest file sizes for binary (1-bit) document images. Default is `CCITT_T6`.

Constructor Details

TiffGeneratorParameters

public TiffGeneratorParameters(CompressionMode compression,
 int jpegQuality,
 int zipCompressionLevel,
 int dpi,
 List<UserField> userFields,
 ParametricFilter binarizationFilter)

Constructs TiffGeneratorParameters with the given params.

Parameters:

compression - Compression. Default is `LZW`.

jpegQuality - JPEG quality (TIFFTAG_JPEGQUALITY). Values range from 0 to 100. Default is `80`.

zipCompressionLevel - ZIP/Deflate compression level (TIFFTAG_ZIPQUALITY). Values range from 1 to 9. Default is `6`.

dpi - DPI value. Default is `72`.

userFields - User-defined fields.

binarizationFilter - Filter to apply to the input image when adding pages with binarization. If set, the filter is applied to the input image and the resulting image is stored as a 1-bit TIFF. When storing documents it's typically best to use the BINARY_DOCUMENT_OPTIMIZED_COMPRESSION compression mode (CCITT_T6) instead of the default, as it tends to produce the smallest file sizes. If not set, simple thresholding is applied to the image, instead.

TiffGeneratorParameters

public TiffGeneratorParameters()

Constructs TiffGeneratorParameters with default parameters.

Method Details

getCompression

public CompressionMode getCompression()

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

Returns:

compression

setCompression

public void setCompression(CompressionMode compression)

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

Parameters:

compression - Value to set.

getJpegQuality

public int getJpegQuality()

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

Returns:

jpegQuality

setJpegQuality

public void setJpegQuality(int jpegQuality)

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

Parameters:

jpegQuality - Value to set.

getZipCompressionLevel

public int getZipCompressionLevel()

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

Returns:

zipCompressionLevel

setZipCompressionLevel

public void setZipCompressionLevel(int zipCompressionLevel)

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

Parameters:

zipCompressionLevel - Value to set.

getDpi

public int getDpi()

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

Returns:

dpi

setDpi

public void setDpi(int dpi)

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

Parameters:

dpi - Value to set.

getUserFields

public List<UserField> getUserFields()

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

Returns:

userFields

setUserFields

public void setUserFields(List<UserField> userFields)

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

Parameters:

userFields - Value to set.

getBinarizationFilter

public ParametricFilter getBinarizationFilter()

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

Returns:

binarizationFilter

setBinarizationFilter

public void setBinarizationFilter(ParametricFilter binarizationFilter)

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

Parameters:

binarizationFilter - Value to set.