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
format
FingerImageRecordFormatin Finger image record format to export the finger image object to.compression_algorithm
FingerImageCompressionAlgorithmin 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
floatin Compression level. Range and default value depends on the compression algorithm, see CompressionAlgorithm enumeration for more details.path
strin 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
format
FingerImageRecordFormatin Finger image record format to export the finger image object to.compressionAlgorithm
FingerImageCompressionAlgorithmin 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
doublein Compression level. Range and default value depends on the compression algorithm, see CompressionAlgorithm enumeration for more details.path
Stringin 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
format
FingerImageRecordFormatin Finger image record format to export the finger image object to.compressionAlgorithm
FingerImageCompressionAlgorithmin 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
floatin Compression level. Range and default value depends on the compression algorithm, see CompressionAlgorithm enumeration for more details.path
stringin 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
format
FingerImageRecordFormatin Finger image record format to export the finger image object to.compressionAlgorithm
FingerImageCompressionAlgorithmin 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
floatin Compression level. Range and default value depends on the compression algorithm, see CompressionAlgorithm enumeration for more details.path
Stringin 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
format
FingerImageRecordFormatin Finger image record format to export the finger image object to.compressionAlgorithm
FingerImageCompressionAlgorithmin 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
Floatin Compression level. Range and default value depends on the compression algorithm, see CompressionAlgorithm enumeration for more details.path
Stringin 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_RECORDin Handle to the FingerImageRecord object.eFormat
id3FingerImageRecordFormatin Finger image record format to export the finger image object to.eCompressionAlgorithm
id3FingerImageCompressionAlgorithmin 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
floatin 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