Changeset 2638 for trunk/doc/modules/ModulesSDRS.tex

Timestamp:

Dec 6, 2004, 10:13:57 AM (22 years ago)

Author:

Paul Price

Message:

Fixed up specification of fitSpec for pmSubtractSky.

File:

• trunk/doc/modules/ModulesSDRS.tex (modified) (3 diffs)

trunk/doc/modules/ModulesSDRS.tex

@@ -1 @@
-%%% $Id: ModulesSDRS.tex,v 1.23 2004-12-02 22:21:19 price Exp $
+%%% $Id: ModulesSDRS.tex,v 1.24 2004-12-06 20:13:57 price Exp $
 \documentclass[panstarrs]{panstarrs}
 
@@ -870 +870 @@
 the following:
 \begin{verbatim}
-psReadout *pmSubtractSky(psReadout *in, void *fitSpec, psFit fit, int binFactor, 
+psReadout *pmSubtractSky(psReadout *in, psPolynomial2D *poly, int binFactor, 
                          psStats *stats, float clipSD);
 \end{verbatim}
@@ -879 +879 @@
 the coefficients used in the subtraction.
 
-The fit specification, \code{fitSpec}, specifies the order of the
-polynomial or spline to be used in fitting the background.
-\code{fitSpec} shall be interpreted as a polynomial, Chebyshev or
-spline on the basis of \code{fit} (in the same manner as for bias
-subtraction; \S\ref{sec:bias}).  If \code{fitSpec} is \code{NULL} or
-\code{fit} is \code{PM_FIT_NONE} or \code{PM_FIT_SPLINE}, then no fit
-shall be performed, and the function shall generate a warning and
-return.
+The polynomial, \code{poly}, specifies the order of the polynomial,
+and on return shall contain the coefficients of the fit.  If
+\code{poly} is \code{NULL}, then no fit shall be performed, and the
+function shall generate a warning and return.
 
 When fitting the polynomial, the function shall first bin the input