public class FingerprintImage extends Object
FingerprintTemplate. It consists of pixel data and additional information in FingerprintImageOptions. Since SourceAFIS algorithm is not scale-invariant, all images should have DPI configured explicitly by calling FingerprintImageOptions.dpi(double).
Application should start fingerprint processing by constructing an instance of FingerprintImage and then passing it to FingerprintTemplate(FingerprintImage).
Fingerprint image can be either in one of the supported image formats (PNG, JPEG, ...), in which case constructor FingerprintImage(byte[], FingerprintImageOptions) is used, or it can be a raw grayscale image, for which constructor FingerprintImage(int, int, byte[], FingerprintImageOptions) is used.
FingerprintImageOptions, FingerprintTemplate
| Constructor and Description |
|---|
FingerprintImage()
Deprecated.
Use one of the constructors that fully initialize the object.
|
FingerprintImage(byte[] image)
Decodes fingerprint image in standard format using default options.
|
FingerprintImage(byte[] image, FingerprintImageOptions options)
Decodes fingerprint image in standard format.
|
FingerprintImage(int width, int height, byte[] pixels)
Reads raw grayscale fingerprint image from byte array using default options.
|
FingerprintImage(int width, int height, byte[] pixels, FingerprintImageOptions options)
Reads raw grayscale fingerprint image from byte array.
|
| Modifier and Type | Method and Description |
|---|---|
FingerprintImage |
decode(byte[] image)
Deprecated.
Use
FingerprintImage(byte[], FingerprintImageOptions) constructor to decode image in standard format.
|
FingerprintImage |
dpi(double dpi)
Deprecated.
Set DPI via
FingerprintImageOptions.dpi(double) instead.
|
FingerprintImage |
grayscale(int width, int height, byte[] pixels)
Deprecated.
Use
FingerprintImage(int, int, byte[], FingerprintImageOptions) constructor to read raw image.
|
public FingerprintImage(byte[] image,
FingerprintImageOptions options)
FingerprintImageOptions.dpi(double).
The image may be in any format commonly used to store fingerprint images, including PNG, JPEG, BMP, TIFF, or WSQ. SourceAFIS will try to decode the image using Java's ImageIO (PNG, JPEG, BMP, and on Java 9+ TIFF), JNBIS library (WSQ), and Android's Bitmap class (PNG, JPEG, BMP) in this order. Note that these libraries might not support all versions and variations of the mentioned formats.
image - fingerprint image in one of the supported formats
options - additional information about the image or null for default options
NullPointerException - if image is null
IllegalArgumentException - if the image format is unsupported or the image is corrupted
FingerprintImage(int, int, byte[], FingerprintImageOptions), FingerprintCompatibility.convert(byte[]), FingerprintTemplate(byte[])
public FingerprintImage(byte[] image)
FingerprintImage(byte[], FingerprintImageOptions) with default FingerprintImageOptions.
image - fingerprint image in one of the supported formats
NullPointerException - if image is null
IllegalArgumentException - if the image format is unsupported or the image is corrupted
FingerprintImage(int, int, byte[]), FingerprintCompatibility.convert(byte[]), FingerprintTemplate(byte[])
public FingerprintImage(int width,
int height,
byte[] pixels,
FingerprintImageOptions options)
FingerprintImageOptions.dpi(double).
Pixels are represented as 8-bit unsigned bytes with 0 meaning black and 255 meaning white. Java's byte is a signed 8-bit number, but this method interprets all 8 bits as an unsigned number as if by calling Byte.toUnsignedInt(byte). Pixels in pixels array are ordered from top-left to bottom-right in horizontal rows. Size of pixels must be equal to width * height.
width - width of the image
height - height of the image
pixels - image pixels ordered from top-left to bottom-right in horizontal rows
options - additional information about the image or null for default options
NullPointerException - if pixels is null
IndexOutOfBoundsException - if width or height is not positive or if pixels length is not width * height
FingerprintImage(byte[], FingerprintImageOptions), FingerprintCompatibility.convert(byte[]), FingerprintTemplate(byte[])
public FingerprintImage(int width,
int height,
byte[] pixels)
width - width of the image
height - height of the image
pixels - image pixels ordered from top-left to bottom-right in horizontal rows
NullPointerException - if pixels is null
IndexOutOfBoundsException - if width or height is not positive or if pixels length is not width * height
FingerprintImage(byte[]), FingerprintCompatibility.convert(byte[]), FingerprintTemplate(byte[])
@Deprecated public FingerprintImage()
@Deprecated public FingerprintImage dpi(double dpi)
FingerprintImageOptions.dpi(double) instead.
dpi - DPI of the fingerprint image
this (fluent method)
IllegalArgumentException - if dpi is non-positive, impossibly low, or impossibly high
FingerprintImageOptions.dpi(double)
@Deprecated public FingerprintImage decode(byte[] image)
FingerprintImage(byte[], FingerprintImageOptions) constructor to decode image in standard format.
image - fingerprint image in one of the supported formats
this (fluent method)
NullPointerException - if image is null
IllegalArgumentException - if the image format is unsupported or the image is corrupted
FingerprintImage(byte[], FingerprintImageOptions)
@Deprecated public FingerprintImage grayscale(int width, int height, byte[] pixels)
FingerprintImage(int, int, byte[], FingerprintImageOptions) constructor to read raw image.
width - width of the image
height - height of the image
pixels - image pixels ordered from top-left to bottom-right in horizontal rows
this (fluent method)
NullPointerException - if image is null
IndexOutOfBoundsException - if width or height is not positive or if pixels length is not width * height
FingerprintImage(int, int, byte[], FingerprintImageOptions)
Copyright © 2009–2021 Robert Važan. All rights reserved.