Go to main content

man pages section 3: Multimedia Library Functions

Exit Print View

Updated: July 2017
 
 

mlib_ImageAutoCorrel (3MLIB)

Name

mlib_ImageAutoCorrel - auto-correlation of an image

Synopsis

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

mlib_status mlib_ImageAutoCorrel(mlib_d64 *correl, const mlib_image *img,
     mlib_s32 dx, mlib_s32 dy);

Description

The mlib_ImageAutoCorrel() function computes the auto-correlation of an image, given an offset.

It uses the following equation:

                  1          w-dx-1 h-dy-1
correl[i] = -------------- *  SUM    SUM  (img[x][y][i] * img[x+dx][y+dy][i])
            (w-dx)*(h-dy)     x=0    y=0

where w and h are the width and height of the image, respectively.

Parameters

The function takes the following arguments:

correl

Pointer to auto-correlation array where size is equal to the number of channels. correl[i] contains the auto-correlation of channel i.

img

Pointer to image.

dx

Displacement in the X direction.

dy

Displacement in the Y direction.

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_ImageAutoCorrel_Fp(3MLIB), mlib_ImageCrossCorrel(3MLIB), mlib_ImageCrossCorrel_Fp(3MLIB), attributes(5)