MAN page from RedHat Other XITE-3.3-3.i386.rpm

STATISTIC

Section: C Library Functions (3)
Updated: 16 Mar 1998
Index

NAME

statistic, statisticMask, statisticMasks - extractstatistical information from a band

SYNTAX

int statistic( IBAND band, long* size,
double* min, double* max, double* mean,
double* stdev );

int statisticMask( IBAND band, IBAND mask,
long* size, double* min, double* max,
double* mean, double* stdev, int maskval );

int statisticMasks( IBAND band, IBAND mask,
long* size, double* min, double* max,
double* mean, double* stdev );

DESCRIPTION

statisticsearches through the bandand returnssize(number of elements), min(minimum value), max(maximum value), mean(mean value)and stdev(standard deviation) from the band.

statisticMasksearches through the bandand calculatesthe same statistics for all pixels where mask[y,x] == maskval.

statisticMaskssearches through the bandand calculatesthe same statistics for all pixels and all mask values.sizearr,minarr,maxarr,meanarrand stdevarrarearrays of length 256 elements.

One or more of the parameters min,minarr,max,maxarr,mean,meanarr,stdevand stdevarrmay be NULL.

RESTRICTIONS

The maskargument must be of type unsigned byte (IBAND)and contain only values of type unsigned byte. The bandargument must be cast to IBAND, but can be of any non-complexpixel-type. Thus, the statisticMaskand statisticMasksfunctions can only use masks containing numbers in the range0 to UNS_BYTE_MAX.

The maskmust be of the same size as the band.

Does not work on complex pixel-types.

RETURN VALUE

0 - Ok
1 - Mask is not same size as band.
2 - Wrong Pixeltype

AUTHOR

Otto Milvang

This document was created byman2html,using the manual pages.