Content-type: text/html Man page of mlib_ImageCrossCorrel

mlib_ImageCrossCorrel

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

NAME

mlib_ImageCrossCorrel - cross correlation  

SYNOPSIS

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

mlib_status mlib_ImageCrossCorrel(mlib_d64 *correl, const mlib_image *img1,
    const mlib_image *img2);

 

DESCRIPTION

The mlib_ImageCrossCorrel() function computes the cross-correlation between a pair of images.

It uses the following equation:

              1     w-1 h-1
correl[i] = ----- * SUM SUM (img1[x][y][i] * img2[x][y][i])
            w*h    x=0 y=0

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

PARAMETERS

The function takes the following arguments:

correl

Pointer to cross correlation array on a channel basis. The array must be the size of channels in the images. correl[i] contains the cross-correlation of channel i.

img1

Pointer to first image.

img2

Pointer to second image.

 

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_ImageAutoCorrel(3MLIB), mlib_ImageAutoCorrel_Fp(3MLIB), mlib_ImageCrossCorrel_Fp(3MLIB), mlib_ImageNormCrossCorrel(3MLIB), mlib_ImageNormCrossCorrel_Fp(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:07 GMT, October 02, 2010