FingerImageRecord.toFile Method

Module: FingerImageRecord

Definition

Exports the FingerImageRecord to a file.

Important

For ANSI/NIST-ITL 1-2011 (AN2K) transaction export, all images will be exported in WSQ in type 14 records, NIEM-XML encoding mode is not supported.

to_file(self, format: FingerImageRecordFormat, compression_algorithm: FingerImageCompressionAlgorithm, compression_level: float, path: str) -> None

Parameters

in Finger image record format to export the finger image object to.

compression_algorithm FingerImageCompressionAlgorithm
in Compression algorithm used to compress the images in a record. Note: this value is not prioritary versus the value in an image object, but if the image does not have a compression algorithm, then the one passed here is used.

compression_level float
in Compression level. Range and default value depends on the compression algorithm, see CompressionAlgorithm enumeration for more details.

path str
in Path to the file to export the finger image record object to.

Exceptions

An error has occurred during Finger Library execution.
void toFile(FingerImageRecordFormat format, FingerImageCompressionAlgorithm compressionAlgorithm, double compressionLevel, String? path)

Parameters

in Finger image record format to export the finger image object to.

compressionAlgorithm FingerImageCompressionAlgorithm
in Compression algorithm used to compress the images in a record. Note: this value is not prioritary versus the value in an image object, but if the image does not have a compression algorithm, then the one passed here is used.

compressionLevel double
in Compression level. Range and default value depends on the compression algorithm, see CompressionAlgorithm enumeration for more details.

path String
in Path to the file to export the finger image record object to.

Exceptions

An error has occurred during Finger Library execution.
public void ToFile(FingerImageRecordFormat format, FingerImageCompressionAlgorithm compressionAlgorithm, float compressionLevel, string path)

Parameters

in Finger image record format to export the finger image object to.

compressionAlgorithm FingerImageCompressionAlgorithm
in Compression algorithm used to compress the images in a record. Note: this value is not prioritary versus the value in an image object, but if the image does not have a compression algorithm, then the one passed here is used.

compressionLevel float
in Compression level. Range and default value depends on the compression algorithm, see CompressionAlgorithm enumeration for more details.

path string
in Path to the file to export the finger image record object to.

Exceptions

An error has occurred during Finger Library execution.
public void toFile(FingerImageRecordFormat format, FingerImageCompressionAlgorithm compressionAlgorithm, float compressionLevel, String path) throws FingerException

Parameters

in Finger image record format to export the finger image object to.

compressionAlgorithm FingerImageCompressionAlgorithm
in Compression algorithm used to compress the images in a record. Note: this value is not prioritary versus the value in an image object, but if the image does not have a compression algorithm, then the one passed here is used.

compressionLevel float
in Compression level. Range and default value depends on the compression algorithm, see CompressionAlgorithm enumeration for more details.

path String
in Path to the file to export the finger image record object to.

Exceptions

An error has occurred during Finger Library execution.
public func toFile(format: FingerImageRecordFormat, compressionAlgorithm: FingerImageCompressionAlgorithm, compressionLevel: Float, path: String) throws

Parameters

in Finger image record format to export the finger image object to.

compressionAlgorithm FingerImageCompressionAlgorithm
in Compression algorithm used to compress the images in a record. Note: this value is not prioritary versus the value in an image object, but if the image does not have a compression algorithm, then the one passed here is used.

compressionLevel Float
in Compression level. Range and default value depends on the compression algorithm, see CompressionAlgorithm enumeration for more details.

path String
in Path to the file to export the finger image record object to.

Exceptions

An error has occurred during Finger Library execution.
int id3FingerImageRecord_ToFile (
    ID3_FINGER_IMAGE_RECORD hFingerImageRecord,
    id3FingerImageRecordFormat eFormat,
    id3FingerImageCompressionAlgorithm eCompressionAlgorithm,
    float compressionLevel,
    const char * path)

Parameters

hFingerImageRecord ID3_FINGER_IMAGE_RECORD
in Handle to the FingerImageRecord object.

in Finger image record format to export the finger image object to.

in Compression algorithm used to compress the images in a record. Note: this value is not prioritary versus the value in an image object, but if the image does not have a compression algorithm, then the one passed here is used.

compressionLevel float
in Compression level. Range and default value depends on the compression algorithm, see CompressionAlgorithm enumeration for more details.

path const char *
in Path to the file to export the finger image record object to.

Returns

int
An error code.
See id3FingerError file for the list of possible error codes.