'\" te
.\" Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved 
.TH mlib_ImageCopyMask_Fp 3MLIB "2 Mar 2007" "SunOS 5.11" "mediaLib Library Functions"
.SH NAME
mlib_ImageCopyMask_Fp \- copy with mask, floating-point
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR... ] \fIfile\fR... \fB-lmlib\fR [ \fIlibrary\fR... ]
#include <mlib.h>

\fBmlib_status\fR \fBmlib_ImageCopyMask_Fp\fR(\fBmlib_image *\fR\fIdst\fR, \fBconst mlib_image *\fR\fIsrc\fR,
     \fBconst mlib_image *\fR\fImask\fR, \fBconst mlib_d64 *\fR\fIthresh\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBmlib_ImageCopyMask_Fp()\fR function copies one image to another image via a mask image by using it as a yes/no indicator. The data type of the images can be \fBMLIB_FLOAT\fR or \fBMLIB_DOUBLE\fR.
.sp
.LP
It uses the following equation:
.sp
.in +2
.nf
dst[x][y][i] = src[x][y][i]  if mask[x][y][i] \(<= thresh[i]
dst[x][y][i] = dst[x][y][i]  if mask[x][y][i] > thresh[i]
.fi
.in -2

.SH PARAMETERS
.sp
.LP
The function takes the following arguments:
.sp
.ne 2
.mk
.na
\fB\fIdst\fR\fR
.ad
.RS 10n
.rt  
Pointer to destination image.
.RE

.sp
.ne 2
.mk
.na
\fB\fIsrc\fR\fR
.ad
.RS 10n
.rt  
Pointer to source image.
.RE

.sp
.ne 2
.mk
.na
\fB\fImask\fR\fR
.ad
.RS 10n
.rt  
Pointer to mask image.
.RE

.sp
.ne 2
.mk
.na
\fB\fIthresh\fR\fR
.ad
.RS 10n
.rt  
Threshold for the mask image. \fBthresh[i]\fR contains the threshold for channel \fBi\fR.
.RE

.SH RETURN VALUES
.sp
.LP
The function returns \fBMLIB_SUCCESS\fR if successful. Otherwise it returns \fBMLIB_FAILURE\fR.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBmlib_ImageCopy\fR(3MLIB), \fBmlib_ImageCopyArea\fR(3MLIB), \fBmlib_ImageCopyMask\fR(3MLIB), \fBmlib_ImageCopySubimage\fR(3MLIB), \fBattributes\fR(5)