Changeset 2649

Timestamp:

Dec 7, 2004, 11:29:43 AM (22 years ago)

Author:

Paul Price

Message:

Added a mask to pmSubtractSky, and specified that binned pixels which
are clipped may be interpolated over, or simply ignored.

Location:

trunk/doc/modules

Files:

• ChangeLogSDRS.tex (modified) (2 diffs)
• ModulesSDRS.tex (modified) (3 diffs)

trunk/doc/modules/ChangeLogSDRS.tex

@@ -1 @@
-%%% $Id: ChangeLogSDRS.tex,v 1.8 2004-12-02 22:21:15 price Exp $
+%%% $Id: ChangeLogSDRS.tex,v 1.9 2004-12-07 21:29:38 price Exp $
 
 \subsection{Changes from version 00 to version 01}
@@ -33 +33 @@
 \begin{itemize}
 \item Fixed up specification of \code{fitSpec} for \code{pmSubtractSky}.
+\item Added a \code{mask} to \code{pmSubtractSky}, and specified that binned pixels which are clipped may be interpolated over, or simply ignored.
 \end{itemize}

trunk/doc/modules/ModulesSDRS.tex

@@ -1 @@
-%%% $Id: ModulesSDRS.tex,v 1.24 2004-12-06 20:13:57 price Exp $
+%%% $Id: ModulesSDRS.tex,v 1.25 2004-12-07 21:29:43 price Exp $
 \documentclass[panstarrs]{panstarrs}
 
@@ -870 +870 @@
 the following:
 \begin{verbatim}
-psReadout *pmSubtractSky(psReadout *in, psPolynomial2D *poly, int binFactor, 
-                         psStats *stats, float clipSD);
+psReadout *pmSubtractSky(psReadout *in, psPolynomial2D *poly, psImage *mask, psU8 maskVal, 
+                         int binFactor, psStats *stats, float clipSD);
 \end{verbatim}
 
@@ -886 +886 @@
 When fitting the polynomial, the function shall first bin the input
 image by \code{binFactor} in order to reduce the required processing
-time.  The statistic to use in this binning is specified by
-\code{stat}.  \code{stat} is of type \code{psStats} instead of simply
-\code{psStatsOptions} so that clipping levels may be specified, if
-desired.  In the event that multiple options are specified by
-\code{stats}, a warning shall be generated, and the option with the
-highest priority shall be used, according to the following priority
-order: \code{PS_STAT_SAMPLE_MEAN}, \code{PS_STAT_SAMPLE_MEDIAN},
-\code{PS_STAT_CLIPPED_MEAN}, \code{PS_STAT_ROBUST_MEAN},\
-\code{PS_STAT_ROBUST_MEDIAN}, \code{PS_STAT_ROBUST_MODE}.  If the
-\code{binFactor} is non-positive, or \code{stats} is \code{NULL} or
-fails to specify an option, a warning shall be generated, and the fit
-shall be performed on the entire image.
+time.  In the binning, pixels in the \code{mask} (if non-\code{NULL})
+which satisfy the \code{maskVal} shall be excluded.  The statistic to
+use in this binning is specified by \code{stat}.  \code{stat} is of
+type \code{psStats} instead of simply \code{psStatsOptions} so that
+clipping levels may be specified, if desired.  In the event that
+multiple options are specified by \code{stats}, a warning shall be
+generated, and the option with the highest priority shall be used,
+according to the following priority order: \code{PS_STAT_SAMPLE_MEAN},
+\code{PS_STAT_SAMPLE_MEDIAN}, \code{PS_STAT_CLIPPED_MEAN},
+\code{PS_STAT_ROBUST_MEAN}, \code{PS_STAT_ROBUST_MEDIAN},
+\code{PS_STAT_ROBUST_MODE}.  If the \code{binFactor} is non-positive,
+or \code{stats} is \code{NULL} or fails to specify an option, a
+warning shall be generated, and the fit shall be performed on the
+entire image.
 
 Binned pixels deviating more than \code{clipSD} standard deviations
 from the mean of the binned pixels shall be clipped in a single
-clipping iteration before polynomial fitting.  If the \code{clipSD} is
-non-positive, then the function shall generate a warning and not
-perform any clipping.
-
+clipping iteration before polynomial fitting.  These pixels may be
+interpolated over, or may be simply ignored in the fitting, according
+to the choice of algorithm.  If the \code{clipSD} is non-positive,
+then the function shall generate a warning and not perform any
+clipping.
+
+The \code{mask} shall be of type \code{psU8}, and the input image,
+\code{in}, shall be of type \code{psF32}.
 
 \section{Calibration}