FingerImage Class

Namespace: id3.Finger

Definition

Represents a finger image.

Python

class FingerImage

Dart

class FingerImage implements Finalizable

C#

public partial class FingerImage

Java

public class FingerImage implements AutoCloseable, Serializable

Swift

public class FingerImage

C

typedef struct id3FingerImage *ID3_FINGER_IMAGE;

Usage

Python

fingerImageInstance = id3finger.FingerImage()

Explicit destruction

# ...
del fingerImageInstance

Dart

final fingerImageInstance = sdk.FingerImage();
// ...

Explicit destruction

// ...
fingerImageInstance.dispose()

C#

using (var fingerImageInstance = new FingerImage())
{
   // ...
}

Explicit destruction

var fingerImageInstance = new FingerImage()
// ...
fingerImageInstance.Dispose()

Java

try (FingerImage fingerImageInstance = new FingerImage()) {
// ...
}

Explicit destruction

FingerImage fingerImageInstance = new FingerImage();
// ...
fingerImageInstance.close();

Swift

private var fingerImageInstance: FingerImage? = nil
fingerImageInstance = try FingerImage()

C

ID3_FINGER_IMAGE hFingerImage{};
int err = id3FingerImage_Initialize(&hFingerImage);
if (err == ID3_SUCCESS) {
    // ...
    id3FingerImage_Dispose(&hFingerImage);
}

Properties

Name	Type	Description
acquisitionLevel	int	Level of acquisition of the image.
captureDeviceCertificationList	FingerCaptureDeviceCertificationList	List of certifications obtained by the capture device.
captureDeviceTechnology	FingerCaptureDeviceTechnology	Technology of the capture device, as defined in ISO/IEC 19794-2:2011.
captureDeviceType	int	Capture device type identifier that identifies the product type that created this finger image.
captureDeviceVendorId	int	Capture device vendor identifier.
cbeffProductId	int	CBEFF product ID as registered with the IBIA (www.ibia.org).
compressionAlgorithm	FingerImageCompressionAlgorithm	Compression algorithm used to compress the image in a record.
data	byte[]	Raw data buffer of the image.
detectedFingerList	DetectedFingerList	Represents the list of detected fingers.
fingerCount	int	Number of detected fingers.
height	int	Height in pixels.
horizontalResolution	int	Horizontal resolution of the image (in DPI).
horizontalScanResolution	int	Horizontal scan resolution of the image (in DPI). Independent from image rescaling.
impressionType	FingerImpressionType	Impression type of the finger image.
pixelDepth	int	Pixel depth.
pixelFormat	PixelFormat	Pixel format.
position	FingerPosition	Finger position, as defined in ANSI/NIST-ITL 1-2011.
quality	int	Quality of the created template, from 0 to 100. 100 being maximum quality and -1 meaning ‘not computed’.
qualityAlgorithmId	int	Quality algorithm identifier (including version) as assigned by the vendor.
qualityAlgorithmVendorId	int	Quality algorithm vendor identifier as registered with the IBIA (www.ibia.org).
stride	int	Stride in bytes.
templateRecord	FingerTemplateRecord	Represents a finger template record.
verticalResolution	int	Vertical resolution of the image (in DPI).
verticalScanResolution	int	Vertical scan resolution of the image (in DPI). Independent from image rescaling.
viewNumber	int	Number of the view. Mostly useful for lists with multiple views of the same finger position.
width	int	Width in pixels.

Static Methods

Name	Description
fromBuffer	Creates an Image from the specified data buffer.
fromFile	Creates an Image from the specified file.
fromNumpy	Creates an Image from the specified data buffer. Supported pixel formats are grayscale formats, BGR and RGB 24bits, and BGRA. For integers format, input datatype must be UINT8.
fromRawBuffer	Creates an Image from the specified raw data buffer.
fromYuvPlanes	Creates an Image from the specified YUV planes.
set	Sets the Image object fields.

Methods

Name	Description
clone	Clones the FingerImage object.
compare	Computes the difference with another image.
correctGamma	Applies a gamma correction to the image.
crop	Crop a rectangular region of interest in the image according to the given bounds.
downscale	Downscales the image in-place so that its maximum dimension is equal to the given maximum size, while preserving the aspect ratio.
downscaleTo	Downscales the image so that its maximum dimension equals the given maximum size, while preserving the aspect ratio.
extractFinger	Extracts an image of a specified finger from the previously detected set of fingers.
extractRoi	Extracts a region of interest in the image according to the given bounds.
extractRoiWithColor	Extracts a region of interest in the image according to the given bounds.
flip	Flips the image in-place.
flipTo	Flips the image.
getPixels	Gets a pointer to the image pixels.
pad	Add padding around the image
reallocate	Reallocates the internal memory of the Image from parameters.
rescale	Rescales the image to the required resolution.
resize	Resizes the image in-place to the required width and height.
resizeTo	Resizes the image to the specified width and height.
rotate	Rotates the image in-place to the specified angle.
rotateTo	Rotates the image to the specified angle.
setResolution	Sets both the image horizontal and vertical resolutions.
toBuffer	Exports the image to a buffer.
toBufferObject	Copies the image to a buffer in the specified format.
toFile	Saves the image to the specified file.
toNumpy	Exports the image to a numpy array (Python only)
toRawBuffer	Copies image pixels in the specified format into a buffer.
transpose	Transposes the image object.