1mlib_ImageCrossCorrel(3MLIBm)ediaLib Library Functionmslib_ImageCrossCorrel(3MLIB)
2
3
4

NAME

6       mlib_ImageCrossCorrel - cross correlation
7

SYNOPSIS

9       cc [ flag... ] file... -lmlib [ library... ]
10       #include <mlib.h>
11
12       mlib_status mlib_ImageCrossCorrel(mlib_d64 *correl, const mlib_image *img1,
13            const mlib_image *img2);
14
15

DESCRIPTION

17       The  mlib_ImageCrossCorrel()  function  computes  the cross-correlation
18       between a pair of images.
19
20
21       It uses the following equation:
22
23                       1     w-1 h-1
24         correl[i] = ----- * SUM SUM (img1[x][y][i] * img2[x][y][i])
25                      w*h    x=0 y=0
26
27
28
29       where w and h are the width and height of the images, respectively.
30

PARAMETERS

32       The function takes the following arguments:
33
34       correl    Pointer to cross correlation array on a  channel  basis.  The
35                 array  must  be the size of channels in the images. correl[i]
36                 contains the cross-correlation of channel i.
37
38
39       img1      Pointer to first image.
40
41
42       img2      Pointer to second image.
43
44

RETURN VALUES

46       The function returns MLIB_SUCCESS if successful. Otherwise  it  returns
47       MLIB_FAILURE.
48

ATTRIBUTES

50       See attributes(5) for descriptions of the following attributes:
51
52
53
54
55       ┌─────────────────────────────┬─────────────────────────────┐
56       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
57       ├─────────────────────────────┼─────────────────────────────┤
58       │Interface Stability          │Committed                    │
59       ├─────────────────────────────┼─────────────────────────────┤
60       │MT-Level                     │MT-Safe                      │
61       └─────────────────────────────┴─────────────────────────────┘
62

SEE ALSO

64       mlib_ImageAutoCorrel(3MLIB),            mlib_ImageAutoCorrel_Fp(3MLIB),
65       mlib_ImageCrossCorrel_Fp(3MLIB),      mlib_ImageNormCrossCorrel(3MLIB),
66       mlib_ImageNormCrossCorrel_Fp(3MLIB), attributes(5)
67
68
69
70SunOS 5.11                        2 Mar 2007      mlib_ImageCrossCorrel(3MLIB)
Impressum