Content-type: text/html Man page of mlib_ImageScale

mlib_ImageScale

Section: mediaLib Library Functions (3MLIB)
Updated: 2 Mar 2007
Index Return to Main Contents
 

NAME

mlib_ImageScale - linear scaling  

SYNOPSIS

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

mlib_status mlib_ImageScale(mlib_image *dst,
    const mlib_image *src, const mlib_s32 *alpha, const mlib_s32 *beta,
    mlib_s32 shift);

 

DESCRIPTION

The mlib_ImageScale() function performs a linear scaling on the pixels of the source image by multiplying the data by a scale factor, shifting, and then adding an offset.

The following equation is used:

dst[x][y][i] = src[x][y][i] * alpha[i] * 2**(-shift) +
              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.

See the following table for available variations of this linear scaling function.

Type [*]BYTESHORTUSHORTINTFLOATDOUBLE

MLIB_BYTEYYYYYY

MLIB_SHORT

MLIB_USHORT

MLIB_INT

[*] Each row represents a source data type. Each column represents a destination data type.  

PARAMETERS

The function takes the following arguments:

dst

Pointer to destination image.

src

Pointer to source image.

alpha

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

beta

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

shift

Right shifting factor.

 

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 TYPEATTRIBUTE VALUE

Interface StabilityCommitted

MT-Level

 

SEE ALSO

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


 

Index

NAME
SYNOPSIS
DESCRIPTION
PARAMETERS
RETURN VALUES
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:38:29 GMT, October 02, 2010