FingerWsq.encodeToBuffer Method

Module: FingerWsq

Definition

Encodes a FingerImage to a NIST WSQ data buffer.

@staticmethod
encode_to_buffer(image: FingerImage, bit_rate: float) -> bytearray

Parameters

in Image to encode to WSQ.

bit_rate float
in WSQ encoding bit rate. The lower the bit rate is, the higher is the compression level and vice versa. The recommended bit rate is 0.75. It corresponds to 15:1 compression. Another common bit rate is 2.25 for 5:1 compression.

Returns

bytearray
Buffer to receive the WSQ encoded image.

Exceptions

An error has occurred during Finger Library execution.
static Uint8List encodeToBuffer(FingerImage image, double bitRate)

Parameters

in Image to encode to WSQ.

bitRate double
in WSQ encoding bit rate. The lower the bit rate is, the higher is the compression level and vice versa. The recommended bit rate is 0.75. It corresponds to 15:1 compression. Another common bit rate is 2.25 for 5:1 compression.

Returns

Uint8List
Buffer to receive the WSQ encoded image.

Exceptions

An error has occurred during Finger Library execution.
public static byte[] EncodeToBuffer(FingerImage image, float bitRate)

Parameters

in Image to encode to WSQ.

bitRate float
in WSQ encoding bit rate. The lower the bit rate is, the higher is the compression level and vice versa. The recommended bit rate is 0.75. It corresponds to 15:1 compression. Another common bit rate is 2.25 for 5:1 compression.

Returns

byte[]
Buffer to receive the WSQ encoded image.

Exceptions

An error has occurred during Finger Library execution.
public static byte[] encodeToBuffer(FingerImage image, float bitRate) throws FingerException

Parameters

in Image to encode to WSQ.

bitRate float
in WSQ encoding bit rate. The lower the bit rate is, the higher is the compression level and vice versa. The recommended bit rate is 0.75. It corresponds to 15:1 compression. Another common bit rate is 2.25 for 5:1 compression.

Returns

byte[]
Buffer to receive the WSQ encoded image.

Exceptions

An error has occurred during Finger Library execution.
public static func encodeToBuffer(image: FingerImage, bitRate: Float) throws -> [UInt8]

Parameters

in Image to encode to WSQ.

bitRate Float
in WSQ encoding bit rate. The lower the bit rate is, the higher is the compression level and vice versa. The recommended bit rate is 0.75. It corresponds to 15:1 compression. Another common bit rate is 2.25 for 5:1 compression.

Returns

[UInt8]
Buffer to receive the WSQ encoded image.

Exceptions

An error has occurred during Finger Library execution.
int id3FingerWsq_EncodeToBuffer (
    ID3_FINGER_IMAGE hImage,
    float bitRate,
    unsigned char * wsqBuffer,
    int * wsqBufferSize)

Parameters

in Image to encode to WSQ.

bitRate float
in WSQ encoding bit rate. The lower the bit rate is, the higher is the compression level and vice versa. The recommended bit rate is 0.75. It corresponds to 15:1 compression. Another common bit rate is 2.25 for 5:1 compression.

wsqBuffer unsigned char *
out Buffer to receive the WSQ encoded image.

wsqBufferSize int *
in Size of the ‘wsqBuffer’ buffer. Receives the number of elements in the ‘wsqBuffer’ array.

Returns

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