mlib_ImageScale2_Inp (3MLIB)

Name

mlib_ImageScale2_Inp - linear scaling, in place

Synopsis

cc [ flag... ] file... –lmlib [ library... ]
#include <mlib.h>

mlib_status mlib_ImageScale2_Inp(mlib_image *srcdst, const mlib_d64 *alpha,
     const mlib_d64 *beta);

Description

The mlib_ImageScale2_Inp() function performs an in-place linear scaling on the pixels of the source image by multiplying the data by a scale factor and then adding an offset. Images can have 1, 2, 3, or 4 channels.

The following equation is used:

srcdst[x][y][i] = srcdst[x][y][i] * alpha[i] + beta[i]

If the result of the operation underflows/overflows the minimum/maximum value supported by the destination image, then it will be clamped to the minimum/maximum value respectively.

The image can be of type MLIB_BYTE, MLIB_SHORT, MLIB_USHORT or MLIB_INT.

Parameters

The function takes the following arguments:

srcdst

Pointer to source and destination image.

alpha

Scaling factor. alpha[i] contains the scaling factor for channel i.

beta

Offset value. beta[i] contains the offset for channel i.

Return Values

The function returns MLIB_SUCCESS if successful. Otherwise it returns MLIB_FAILURE.

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE Interface Stability Committed MT-Level MT-Safe

See also

mlib_ImageScale(3MLIB), mlib_ImageScale_Fp(3MLIB), mlib_ImageScale_Fp_Inp(3MLIB), mlib_ImageScale_Inp(3MLIB), mlib_ImageScale2(3MLIB), attributes(5)