opensolaris man page for mlib_imagerankfiltermxn_us

mlib_ImageRankFilterMxN_US(3MLIB)			    mediaLib Library Functions				 mlib_ImageRankFilterMxN_US(3MLIB)

NAME
       mlib_ImageRankFilterMxN_US - MxN rank filter, unsigned

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

       mlib_status mlib_ImageRankFilterMxN_US(mlib_image *dst,
	    const mlib_image *src, mlib_s32 m, mlib_s32 n, mlib_s32 rank,
	    mlib_s32 bits);

DESCRIPTION
       The  mlib_ImageRankFilterMxN_US()  function  performs  MxN  rank filtering on an MLIB_SHORT type of image that contains unsigned data. Each
       pixel of the destination image is the pixel with the user-specified rank in the filter window.

       The source and destination images must be single-channel images.

PARAMETERS
       The function takes the following arguments:

       dst     Pointer to destination image.

       src     Pointer to source image.

       m       Width of the filter window. m must be odd number greater than 1.

       n       Height of the filter window. n must be odd number greater than 1.

       rank    The rank of the destination pixel. The pixel with minimum value is designated rank 0.

       bits    The number of unsigned bits for pixel dynamic range. 9 <= bits <= 15.

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_ImageMaxFilter3x3(3MLIB),	 mlib_ImageMaxFilter3x3_Fp(3MLIB),    mlib_ImageMaxFilter5x5(3MLIB),	 mlib_ImageMaxFilter5x5_Fp(3MLIB),
       mlib_ImageMaxFilter7x7(3MLIB),	mlib_ImageMaxFilter7x7_Fp(3MLIB),  mlib_ImageMedianFilter3x3(3MLIB),  mlib_ImageMedianFilter3x3_Fp(3MLIB),
       mlib_ImageMedianFilter3x3_US(3MLIB),    mlib_ImageMedianFilter5x5(3MLIB),     mlib_ImageMedianFilter5x5_Fp(3MLIB),     mlib_ImageMedianFil-
       ter5x5_US(3MLIB), mlib_ImageMedianFilter7x7(3MLIB), mlib_ImageMedianFilter7x7_Fp(3MLIB), mlib_ImageMedianFilter7x7_US(3MLIB), mlib_ImageMe-
       dianFilterMxN(3MLIB), mlib_ImageMedianFilterMxN_Fp(3MLIB), mlib_ImageMedianFilterMxN_US(3MLIB), mlib_ImageMinFilter3x3(3MLIB), mlib_ImageM-
       inFilter3x3_Fp(3MLIB),  mlib_ImageMinFilter5x5(3MLIB),  mlib_ImageMinFilter5x5_Fp(3MLIB),  mlib_ImageMinFilter7x7(3MLIB), mlib_ImageMinFil-
       ter7x7_Fp(3MLIB), mlib_ImageRankFilter3x3(3MLIB), mlib_ImageRankFilter3x3_Fp(3MLIB), mlib_ImageRankFilter3x3_US(3MLIB),	mlib_ImageRankFil-
       ter5x5(3MLIB),  mlib_ImageRankFilter5x5_Fp(3MLIB),  mlib_ImageRankFilter5x5_US(3MLIB),  mlib_ImageRankFilter7x7(3MLIB),	mlib_ImageRankFil-
       ter7x7_Fp(3MLIB), mlib_ImageRankFilter7x7_US(3MLIB), mlib_ImageRankFilterMxN(3MLIB), mlib_ImageRankFilterMxN_Fp(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007					 mlib_ImageRankFilterMxN_US(3MLIB)