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

Timestamp:

Jul 26, 2006, 12:10:38 PM (20 years ago)

Author:

Paul Price

Message:

Adding psStatsFromString and psStatsToString, which are already coded.

File:

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

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.422 2006-07-25 00:26:51 eugene Exp $
+%%% $Id: psLibSDRS.tex,v 1.423 2006-07-26 22:10:38 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -4788 +4788 @@
 \end{prototype}
 
+It is convenient for the (end-)user to refer to the statistics by strings,
+so we specify functions to convert between strings and \code{psStats}:
+\begin{prototype}
+psStats *psStatsFromString(const char *string);
+psString psStatsToString(const psStats *stats);
+\end{prototype}
+\code{psStatsFromString} shall parse the input \code{string} for
+statistics options.  Multiple options may be included in the same
+string, separated by spaces, commas or semi-colons.  The options shall
+be specified by their \code{psStatsOptions} enum, without the leading
+\code{PS_STAT_}.  In addition, \code{SAMPLE_} may be excluded for the
+user's convenience, and \code{ROBUST} shall refer to a
+\code{ROBUST_MEDIAN}, \code{FITTED} to a \code{FITTED_MEAN}, and
+\code{CLIPPED} to a \code{CLIPPED_MEAN}.  \code{psStatsToString} shall
+translate in the reverse direction.
+
 \begin{prototype}
 long psVectorCountPixelMask (psVector *mask, psMaskType value);