opensolaris man page for mlib_imagemean

mlib_ImageMean(3MLIB)					    mediaLib Library Functions					     mlib_ImageMean(3MLIB)

NAME
       mlib_ImageMean - image mean

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

       mlib_status mlib_ImageMean(mlib_d64 *mean, const mlib_image *img);

DESCRIPTION
       The mlib_ImageMean() function computes the mean value of all the pixels in the image.

       It uses the following equation:

		     1	   w-1 h-1
	 mean[i] = ----- * SUM SUM img[x][y][i]
		    w*h    x=0 y=0

PARAMETERS
       The function takes the following arguments:

       mean    Pointer to mean array, where length is the number of channels in the image. mean[i] contains the mean of channel i.

       img     Pointer to an 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 TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Committed 		   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       mlib_ImageMean_Fp(3MLIB), mlib_ImageStdDev(3MLIB), mlib_ImageStdDev_Fp(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007						     mlib_ImageMean(3MLIB)