opensolaris man page for mlib_imagefouriertransform

mlib_ImageFourierTransform(3MLIB)			    mediaLib Library Functions				 mlib_ImageFourierTransform(3MLIB)

NAME
       mlib_ImageFourierTransform - Fourier transform

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

       mlib_status mlib_ImageFourierTransform(mlib_image *dst,
	    const mlib_image *src, mlib_fourier_mode mode);

DESCRIPTION
       The  mlib_ImageFourierTransform() function performs a two-dimensional Fourier transformation. The source and destination images must be the
       same type and the same size. The data type of the images can be MLIB_BYTE, MLIB_SHORT, MLIB_USHORT, MLIB_INT, MLIB_FLOAT,  or  MLIB_DOUBLE.
       The height and width of the images must be some positive power of 2 (but they do not have to be equal).

       They  can  have	1  or  2 channels. If the source image has just one channel the imaginary parts are assumed to be zero. If the destination
       image has just one channel, then it is assumed that the imaginary parts of the output can be discarded. But in case both source and  desti-
       nation images are one-channel images, then MLIB_FAILURE is returned.

       The predefined modes used in the image Fourier transform function are as follows:

		  Mode				   Description
       ----------------------------------------------------------------------
       MLIB_DFT_SCALE_NONE	     Forward DFT without scaling
       MLIB_DFT_SCALE_MXN	     Forward DFT with scaling of 1/(M*N)
       MLIB_DFT_SCALE_SQRT	     Forward DFT with scaling of 1/sqrt(M*N)
       MLIB_IDFT_SCALE_NONE	     Inverse DFT without scaling
       MLIB_IDFT_SCALE_MXN	     Inverse DFT with scaling of 1/(M*N)
       MLIB_IDFT_SCALE_SQRT	     Inverse DFT with scaling of 1/sqrt(M*N)

PARAMETERS
       The function takes the following arguments:

       dst     Pointer to destination image.

       src     Pointer to source image.

       mode    Mode of the transform.

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
       attributes(5)

SunOS 5.11							    2 Mar 2007					 mlib_ImageFourierTransform(3MLIB)