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

\fBmlib_status\fR \fBmlib_VolumeFindMaxBMask_U8\fR(\fBmlib_u8 *\fR\fImax\fR,
     \fBconst mlib_rays *\fR\fIrays\fR, \fBconst mlib_u8 *\fR\fIbmask\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_VolumeFindMaxBMask_S16\fR(\fBmlib_s16 *\fR\fImax\fR,
     \fBconst mlib_rays *\fR\fIrays\fR, \fBconst mlib_u8 *\fR\fIbmask\fR);
.fi

.SH DESCRIPTION
.sp
.LP
Each function performs maximum intensity searching.
.sp
.LP
It uses the following equation:
.sp
.in +2
.nf
max[i] = MAX{ rays->results[j][i]
              j = 0, 1, ..., rays->nsteps[i]; bmask[j] = 1 }
.fi
.in -2

.sp
.LP
where \fBi = 0, 1, ..., rays->nrays - 1\fR.
.SH PARAMETERS
.sp
.LP
The function takes the following arguments:
.sp
.ne 2
.mk
.na
\fB\fImax\fR\fR
.ad
.RS 9n
.rt  
Pointer to an array of \fBrays->nrays\fR maximum values of the samples in each ray.
.RE

.sp
.ne 2
.mk
.na
\fB\fIrays\fR\fR
.ad
.RS 9n
.rt  
Pointer to an \fBmlib_rays\fR structure. The data \fBrays->results\fR are organized with ray number (rather than ray step) varying fastest. Ray number and ray step are the output of the ray casting functions. The data might have values beyond the maximum step on a ray. For example, \fBrays->results[rays->nsteps[i]][i]\fR on ray \fBi\fR might not equal \fB0\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fIbmask\fR\fR
.ad
.RS 9n
.rt  
Pointer to a 1-bit mask array. Eight mask bits are packed into one byte. A \fB1\fR corresponds to the data in the step to be considered.
.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_VolumeFindMax_U8\fR(3MLIB), \fBmlib_VolumeFindMaxCMask_U8\fR(3MLIB), \fBattributes\fR(5)