Manual Pages for UNIX Operating System command usage for man mlib_ImageCrossCorrel

mediaLib Library Functions           mlib_ImageCrossCorrel(3MLIB)



NAME
     mlib_ImageCrossCorrel - cross correlation

SYNOPSIS
     cc [ flag... ] file... -lmlib [ library... ]
     #include 

     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  attri-
     butes:






SunOS 5.11           Last change: 2 Mar 2007                    1






mediaLib Library Functions           mlib_ImageCrossCorrel(3MLIB)



     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Interface Stability         | Committed                   |
    |_____________________________|_____________________________|
    | MT-Level                    | MT-Safe                     |
    |_____________________________|_____________________________|


SEE ALSO
     mlib_ImageAutoCorrel(3MLIB), mlib_ImageAutoCorrel_Fp(3MLIB),
     mlib_ImageCrossCorrel_Fp(3MLIB),
     mlib_ImageNormCrossCorrel(3MLIB),
     mlib_ImageNormCrossCorrel_Fp(3MLIB), attributes(5)









































SunOS 5.11           Last change: 2 Mar 2007                    2