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

Timestamp:

Jul 26, 2006, 5:52:15 PM (20 years ago)

Author:

Paul Price

Message:

Adding psStatsOptionFromString and psStatsOptionToString.

File:

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

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.423 2006-07-26 22:10:38 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.424 2006-07-27 03:52:15 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -4791 +4791 @@
 so we specify functions to convert between strings and \code{psStats}:
 \begin{prototype}
+psStatsOptions psStatsOptionFromString(const char *string);
+psString psStatsOptionToString(psStatsOptions option);
 psStats *psStatsFromString(const char *string);
 psString psStatsToString(const psStats *stats);
 \end{prototype}
+\code{psStatsOptionFromString} shall parse the \code{string} for a
+single statistics option.  The options shall be specified by their
+\code{psStatsOptions} enum name, 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{psStatsOptionToString} shall translate in
+the reverse direction, returning the appropriate string given the
+\code{option} (which may be a blend of options).
 \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.
+statistics options, where multiple options may be included in the same
+string, separated by spaces, commas or semi-colons.
+\code{psStatsToString} shall translate in the reverse direction.
 
 \begin{prototype}