io.scanbot.sdk.tiff.model

Class TIFFImageWriterParameters

io.scanbot.sdk.tiff.model.TIFFImageWriterParameters

public class TIFFImageWriterParameters

Class used to define parameters for TIFF format writer.

Field Detail

Companion

public static io.scanbot.sdk.tiff.model.TIFFImageWriterParameters.Companion Companion

Constructor Detail

TIFFImageWriterParameters

public TIFFImageWriterParameters(@Nullable
                                 io.scanbot.sdk.process.ImageFilterType binarizationFilter,
                                 int dpi,
                                 @NotNull
                                 TIFFImageWriterCompressionOptions compression,
                                 @NotNull
                                 java.util.List<io.scanbot.sdk.tiff.model.TIFFImageWriterUserDefinedField> userDefinedFields)

Class used to define parameters for TIFF format writer.

Parameters:

dpi - Defines target document DPI.

compression - Defines target document compression algorithm.

userDefinedFields - Array that contains user-defined TIFF tags that should be written into result TIFF document.

Method Detail

getFilter

@NotNull
public io.scanbot.sdk.process.ImageFilterType getFilter()

Defines if target document should be binarized.

getDpi

public int getDpi()

Defines target document DPI.

getCompression

@NotNull
public TIFFImageWriterCompressionOptions getCompression()

Defines target document compression algorithm.

getUserDefinedFields

@NotNull
public java.util.List<io.scanbot.sdk.tiff.model.TIFFImageWriterUserDefinedField> getUserDefinedFields()

Array that contains user-defined TIFF tags that should be written into result TIFF document.

defaultParameters

@JvmStatic
 @NotNull
public static TIFFImageWriterParameters defaultParameters()

Generates default parameters set for coloured images.

Returns:

generated class TIFFImageWriterParameters instance.

defaultParametersForBinaryImages

@JvmStatic
 @NotNull
public static TIFFImageWriterParameters defaultParametersForBinaryImages()

Generates default parameters set for binarized images.

Returns:

generated class TIFFImageWriterParameters instance.