opensolaris man page for mlib_imagemedianfilter3x3

mlib_ImageMedianFilter3x3(3MLIB)			    mediaLib Library Functions				  mlib_ImageMedianFilter3x3(3MLIB)

NAME
       mlib_ImageMedianFilter3x3 - 3x3 median filter

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

       mlib_status mlib_ImageMedianFilter3x3(mlib_image *dst,
	    const mlib_image *src, mlib_median_mask mmask, mlib_s32 cmask,
	    mlib_edge edge);

DESCRIPTION
       The  mlib_ImageMedianFilter3x3() function performs median filtering on an image. Each pixel of the destination image is the pixel with rank
       middle in the filter window.

PARAMETERS
       The function takes the following arguments:

       dst	Pointer to destination image.

       src	Pointer to source image.

       mmask	Shape of the mask to be used for median filtering. It can be one of the following:

		  MLIB_MEDIAN_MASK_RECT
		  MLIB_MEDIAN_MASK_PLUS
		  MLIB_MEDIAN_MASK_X
		  MLIB_MEDIAN_MASK_RECT_SEPARABLE

       cmask	Channel mask to indicate the channels to be filtered. Each bit of which represents a channel in the  image.  The  channels  corre-
		sponded to 1 bits are those to be processed.

       edge	Type of edge condition. It can be one of the following:

		  MLIB_EDGE_DST_NO_WRITE
		  MLIB_EDGE_DST_FILL_ZERO
		  MLIB_EDGE_DST_COPY_SRC
		  MLIB_EDGE_SRC_EXTEND

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_Fp(3MLIB),  mlib_ImageMedianFilter3x3_US(3MLIB),
       mlib_ImageMedianFilter5x5(3MLIB),     mlib_ImageMedianFilter5x5_Fp(3MLIB),     mlib_ImageMedianFilter5x5_US(3MLIB),    mlib_ImageMedianFil-
       ter7x7(3MLIB), mlib_ImageMedianFilter7x7_Fp(3MLIB), mlib_ImageMedianFilter7x7_US(3MLIB), mlib_ImageMedianFilterMxN(3MLIB),  mlib_ImageMedi-
       anFilterMxN_Fp(3MLIB), mlib_ImageMedianFilterMxN_US(3MLIB), mlib_ImageMinFilter3x3(3MLIB), mlib_ImageMinFilter3x3_Fp(3MLIB), mlib_ImageMin-
       Filter5x5(3MLIB),  mlib_ImageMinFilter5x5_Fp(3MLIB),  mlib_ImageMinFilter7x7(3MLIB),  mlib_ImageMinFilter7x7_Fp(3MLIB),	mlib_ImageRankFil-
       ter3x3(3MLIB),  mlib_ImageRankFilter3x3_Fp(3MLIB),  mlib_ImageRankFilter3x3_US(3MLIB),  mlib_ImageRankFilter5x5(3MLIB),	mlib_ImageRankFil-
       ter5x5_Fp(3MLIB), mlib_ImageRankFilter5x5_US(3MLIB), mlib_ImageRankFilter7x7(3MLIB), mlib_ImageRankFilter7x7_Fp(3MLIB),	mlib_ImageRankFil-
       ter7x7_US(3MLIB), mlib_ImageRankFilterMxN(3MLIB), mlib_ImageRankFilterMxN_Fp(3MLIB), mlib_ImageRankFilterMxN_US(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007					  mlib_ImageMedianFilter3x3(3MLIB)