Changeset 11761

Timestamp:

Feb 12, 2007, 5:08:29 PM (19 years ago)

Author:

Paul Price

Message:

Fixing bug 843 by modifying functions that (unnecessarily) returned an input to return a bool.

File:

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

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.441 2007-02-09 01:19:43 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.442 2007-02-13 03:08:29 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -2584 +2584 @@
 
 \begin{prototype}
-psBitSet *psBitSetSet(psBitSet *bitSet, long bit);
-psBitSet* psBitSetClear(psBitSet *bitSet, long bit);
+bool psBitSetSet(psBitSet *bitSet, long bit);
+bool psBitSetClear(psBitSet *bitSet, long bit);
 psBitSet *psBitSetOp(psBitSet *outBitSet, const psBitSet *inBitSet1,
                      const char *operator, const psBitSet *inBitSet2);
@@ -2594 +2594 @@
 
 \code{psBitSetSet} sets the specified \code{bit} in the
-\code{psBitSet}, and returns the updated bitset.  The input bitset
+\code{psBitSet}.  The input bitset
 will be modified.
 
@@ -5034 +5034 @@
 The following function populates the histogram bins from the specified
 vector (\code{values}), and optionally the \code{errors} in the input
-values.  It alters and returns the histogram \code{out} structure.
-\begin{prototype}
-psHistogram *psVectorHistogram(psHistogram *out, const psVector *values,
+values.  It alters the histogram \code{out} structure.
+\begin{prototype}
+bool psVectorHistogram(psHistogram *out, const psVector *values,
                                const psVector *errors, const psVector *mask,
                                psMaskType maskVal);
@@ -5465 +5465 @@
 
 \begin{prototype}
-psPolynomial1D *psVectorFitPolynomial1D(psPolynomial1D *poly, const psVector *mask, 
-                                        psMaskType maskValue, const psVector *f,
-                                        const psVector *fErr, const psVector *x);
-psPolynomial2D *psVectorFitPolynomial2D(psPolynomial2D *poly, const psVector *mask, 
-                                        psMaskType maskValue, const psVector *f,
-                                        const psVector *fErr, const psVector *x, 
-                                        const psVector *y);
-psPolynomial3D *psVectorFitPolynomial3D(psPolynomial3D *poly, const psVector *mask, 
-                                        psMaskType maskValue, const psVector *f,
-                                        const psVector *fErr, const psVector *x, 
-                                        const psVector *y, const psVector *z);
-psPolynomial4D *psVectorFitPolynomial4D(psPolynomial4D *poly, const psVector *mask, 
-                                        psMaskType maskValue, const psVector *f,
-                                        const psVector *fErr, const psVector *x, 
-                                        const psVector *y, const psVector *z, 
-                                        const psVector *t);
+bool psVectorFitPolynomial1D(psPolynomial1D *poly, const psVector *mask, 
+                             psMaskType maskValue, const psVector *f,
+                             const psVector *fErr, const psVector *x);
+bool psVectorFitPolynomial2D(psPolynomial2D *poly, const psVector *mask, 
+                             psMaskType maskValue, const psVector *f,
+                             const psVector *fErr, const psVector *x, 
+                             const psVector *y);
+bool psVectorFitPolynomial3D(psPolynomial3D *poly, const psVector *mask, 
+                             psMaskType maskValue, const psVector *f,
+                             const psVector *fErr, const psVector *x, 
+                             const psVector *y, const psVector *z);
+bool psVectorFitPolynomial4D(psPolynomial4D *poly, const psVector *mask, 
+                             psMaskType maskValue, const psVector *f,
+                             const psVector *fErr, const psVector *x, 
+                             const psVector *y, const psVector *z, 
+                             const psVector *t);
 \end{prototype}
 These functions return the polynomial that best fits the input data.
@@ -5545 +5545 @@
 
 \begin{prototype}
-psPolynomial4D *psVectorChiClipFitPolynomial4D(psPolynomial4D *poly, psStats *stats,
-                                               const psVector *mask, psMaskType maskValue,
-                                               const psVector *f, const psVector *fErr,
-                                               const psVector *x, const psVector *y,
-                                               const psVector *z, const psVector *t);
+bool psVectorChiClipFitPolynomial4D(psPolynomial4D *poly, psStats *stats,
+                                    const psVector *mask, psMaskType maskValue,
+                                    const psVector *f, const psVector *fErr,
+                                    const psVector *x, const psVector *y,
+                                    const psVector *z, const psVector *t);
 \end{prototype}
 
@@ -5872 +5872 @@
 
 \begin{prototype}
-psStats *psImageStats(psStats *stats, const psImage *in,
-                      const psImage *mask, psMaskType maskVal);
+bool psImageStats(psStats *stats, const psImage *in,
+                  const psImage *mask, psMaskType maskVal);
 \end{prototype}
 Determine statistics for image (or subimage).  The statistics to be
@@ -5883 +5883 @@
 
 \begin{prototype}
-psHistogram *psImageHistogram(psHistogram *out, const psImage *in,
-                              const psImage *mask, psMaskType maskVal);
+bool psImageHistogram(psHistogram *out, const psImage *in,
+                      const psImage *mask, psMaskType maskVal);
 \end{prototype}
 Construct a histogram from an image (or subimage).  The histogram to
-generate is specified by \code{psHistogram hist} (see
+generate is specified by \code{psHistogram out} (see
 section~\ref{sec:histograms}).  The \code{mask} and \code{maskVal}
 entries are passed to the psLib statistics function used to calculate
@@ -5895 +5895 @@
 
 \begin{prototype}
-long psImageCountPixelMask (psImage *mask, psRegion region, psMaskType value);
+long psImageCountPixelMask(psImage *mask, psRegion region, psMaskType value);
 \end{prototype}
 This function returns the number of pixels in the image region which
@@ -5904 +5904 @@
 
 \begin{prototype}
-psPolynomial2D *psImageFitPolynomial(psPolynomial2D *coeffs, const psImage *input);
+bool psImageFitPolynomial(psPolynomial2D *coeffs, const psImage *input);
 \end{prototype}
 Fit a 2-D Chebychev polynomial surface to an image.  The input