Changeset 2038 for trunk/doc/pslib/psLibSDRS.tex

Timestamp:

Oct 8, 2004, 3:37:41 PM (22 years ago)

Author:

Paul Price

Message:

Added "errors" parameter to psVectorStats.

File:

• trunk/doc/pslib/psLibSDRS.tex (modified) (4 diffs)

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.132 2004-10-08 01:55:52 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.133 2004-10-09 01:37:41 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -1859 +1859 @@
 psStats *psVectorStats(psStats *stats,
                        const psVector *in, 
-                       const psVector *mask, 
-                       unsigned int maskVal);
-\end{verbatim}
-%
-This function takes the input data in \code{in} (with optional masking
-in \code{mask}, so that the user may explicitly reject specific
-entries) and a \code{psStats} structure, which will be altered and
-returned.  The \code{psStats} structure includes several fields which
-are used for both input and output: \code{min} and \code{max} may be
-used to specify a value range for which the statistics are calculated.
+                       const psVector *errors,
+                       const psVector *mask,
+                       unsigned int maskVal
+                       );
+\end{verbatim}
+%
+This function takes the input data in \code{in} (with optional
+\code{errors} in these values; and with optional masking in
+\code{mask}, so that the user may explicitly reject specific entries )
+and a \code{psStats} structure, which will be altered and returned.
+The \code{psStats} structure includes several fields which are used
+for both input and output: \code{min} and \code{max} may be used to
+specify a value range for which the statistics are calculated.
 \code{binsize} specifies a choice for the robust statistics histogram
 bin size.  If these are to be used, the user must set the
@@ -1987 +1990 @@
 
 The following function populates the histogram bins from the specified
-vector (\code{in}).  It alters and returns the histogram \code{out}
-structure.  
+vector (\code{in}), and optionally the \code{errors} in the input
+values.  It alters and returns the histogram \code{out} structure.
 \begin{verbatim}
 psHistogram *psVectorHistogram(psHistogram *out, 
@@ -2666 +2669 @@
 \begin{verbatim}
 psHistogram *psImageHistogram(psHistogram *out, 
-                              const psImage *in, 
+                              const psImage *in,
                               const psImage *mask, 
                               unsigned int maskVal);