opensolaris man page for mlib_imageextrema2_fp

mlib_ImageExtrema2(3MLIB)				    mediaLib Library Functions					 mlib_ImageExtrema2(3MLIB)

NAME
       mlib_ImageExtrema2, mlib_ImageExtrema2_Fp - image extrema

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

       mlib_status mlib_ImageExtrema2(mlib_s32 *min, mlib_s32 *max,
	    const mlib_image *img, mlib_s32 xStart, mlib_s32 yStart,
	    mlib_s32 xPeriod, mlib_s32 yPeriod);

       mlib_status mlib_ImageExtrema2_Fp(mlib_d64 *min, mlib_d64 *max,
	    const mlib_image *img, mlib_s32 xStart, mlib_s32 yStart,
	    mlib_s32 xPeriod, mlib_s32 yPeriod);

DESCRIPTION
       Each of the functions determines the extrema values for each channel in an image, possibly with subsampling.

       It uses the following equation:

	 min[i] = MIN{ img[x][y][i] }
	 max[i] = MAX{ img[x][y][i] }

       where

	 x = xStart + p*xPeriod;  0 <= p < (w - xStart)/xPeriod
	 y = yStart + q*yPeriod;  0 <= q < (h - yStart)/yPeriod

PARAMETERS
       Each of the functions takes the following arguments:

       min	  Pointer to minimum vector, where length is the number of channels in the image. min[i] contains the minimum of channel i.

       max	  Pointer to maximum vector, where length is the number of channels in the image. max[i] contains the maximum of channel i.

       img	  Pointer to a source image.

       xStart	  Initial X sample coordinate.

       yStart	  Initial Y sample coordinate.

       xPeriod	   X sample rate. xPeriod >= 1.

       yPeriod	   Y sample rate. yPeriod >= 1.

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_ImageExtremaLocations(3MLIB),   mlib_ImageMaximum(3MLIB),	mlib_ImageMaximum_Fp(3MLIB),   mlib_ImageMinimum(3MLIB),   mlib_ImageMini-
       mum_Fp(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007						 mlib_ImageExtrema2(3MLIB)