FingerImage.downscale Method

Module: FingerImage

Definition

Downscales the image in-place so that its maximum dimension is equal to the given maximum size, while preserving the aspect ratio.

Note

If the maximum dimension is already smaller than the given maximum size, the function does nothing and the scaling ration returned is 1.

downscale(self, max_size: int) -> float

Parameters

max_size int
in Maximum image size, in pixels. The value must be greater than 0.

Returns

float
The scaling ratio applied to the image. Range is ]0:1].

Exceptions

An error has occurred during Finger Library execution.
double downscale(int maxSize)

Parameters

maxSize int
in Maximum image size, in pixels. The value must be greater than 0.

Returns

double
The scaling ratio applied to the image. Range is ]0:1].

Exceptions

An error has occurred during Finger Library execution.
public float Downscale(int maxSize)

Parameters

maxSize int
in Maximum image size, in pixels. The value must be greater than 0.

Returns

float
The scaling ratio applied to the image. Range is ]0:1].

Exceptions

An error has occurred during Finger Library execution.
public float downscale(int maxSize) throws FingerException

Parameters

maxSize int
in Maximum image size, in pixels. The value must be greater than 0.

Returns

float
The scaling ratio applied to the image. Range is ]0:1].

Exceptions

An error has occurred during Finger Library execution.
public func downscale(maxSize: Int32) throws -> Float

Parameters

maxSize Int32
in Maximum image size, in pixels. The value must be greater than 0.

Returns

Float
The scaling ratio applied to the image. Range is ]0:1].

Exceptions

An error has occurred during Finger Library execution.
int id3FingerImage_Downscale (
    ID3_FINGER_IMAGE hFingerImage,
    int maxSize,
    float * scaleRatio)

Parameters

hFingerImage ID3_FINGER_IMAGE
in Handle to the FingerImage object.

maxSize int
in Maximum image size, in pixels. The value must be greater than 0.

scaleRatio float *
out The scaling ratio applied to the image. Range is ]0:1].

Returns

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