FingerWsq.encodeToFile Method

Module: FingerWsq

Definition

Encodes a FingerImage to a NIST WSQ file.

@staticmethod
encode_to_file(image: FingerImage, bit_rate: float, path: str) -> None

Parameters

image FingerImage
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.

path str
in Path to the file to save the WSQ encoded image.

Exceptions

FingerException
An error has occurred during Finger Library execution.
static void encodeToFile(FingerImage image, double bitRate, String? path)

Parameters

image FingerImage
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.

path String
in Path to the file to save the WSQ encoded image.

Exceptions

FingerException
An error has occurred during Finger Library execution.
public static void EncodeToFile(FingerImage image, float bitRate, string path)

Parameters

image FingerImage
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.

path string
in Path to the file to save the WSQ encoded image.

Exceptions

FingerException
An error has occurred during Finger Library execution.
public static void encodeToFile(FingerImage image, float bitRate, String path) throws FingerException

Parameters

image FingerImage
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.

path String
in Path to the file to save the WSQ encoded image.

Exceptions

FingerException
An error has occurred during Finger Library execution.
public static func encodeToFile(image: FingerImage, bitRate: Float, path: String) throws

Parameters

image FingerImage
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.

path String
in Path to the file to save the WSQ encoded image.

Exceptions

FingerException
An error has occurred during Finger Library execution.
int id3FingerWsq_EncodeToFile (
    ID3_FINGER_IMAGE hImage,
    float bitRate,
    const char * path)

Parameters

hImage ID3_FINGER_IMAGE
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.

path const char *
in Path to the file to save the WSQ encoded image.

Returns

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