Changeset 1118

Timestamp:

Jun 28, 2004, 4:25:13 PM (22 years ago)

Author:

Paul Price

Message:

More cleaning, untabifying.

File:

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

trunk/doc/modules/ModulesSDRS.tex

@@ -1 @@
-%%% $Id: ModulesSDRS.tex,v 1.6 2004-06-29 02:23:47 price Exp $
+%%% $Id: ModulesSDRS.tex,v 1.7 2004-06-29 02:25:13 price Exp $
 \documentclass[panstarrs]{panstarrs}
 
@@ -116 +116 @@
 /** A convolution kernel */
 typedef struct {
-    int xMin, yMin;                     ///< Most negative indices
-    int xMax, yMax;                     ///< Most positive indices
-    float **kernel;                     ///< The kernel data
+    int xMin, yMin;                     ///< Most negative indices
+    int xMax, yMax;                     ///< Most positive indices
+    float **kernel;                     ///< The kernel data
 } psKernel;
 \end{verbatim}
@@ -237 +237 @@
 /** A 1D cubic-spline */
 typedef struct {
-    int n;                              ///< Number of spline pieces
-    float *coeff[4];                    ///< Coefficients.  There are 4 coefficients for each spline piece.
-    float *coeffErr[4];                 ///< Errors in the coefficients.
-    bool *mask[4];                      ///< Mask for the coefficients.
-    float *domains;                     ///< The boundaries between each spline piece.  Size is n+1.
+    int n;                              ///< Number of spline pieces
+    float *coeff[4];                    ///< Coefficients.  There are 4 coefficients for each spline piece.
+    float *coeffErr[4];                 ///< Errors in the coefficients.
+    bool *mask[4];                      ///< Mask for the coefficients.
+    float *domains;                     ///< The boundaries between each spline piece.  Size is n+1.
 } psSpline1D;
 \end{verbatim}
@@ -307 +307 @@
 /** Fit type */
 typedef enum {
-    PS_FIT_NONE,                ///< No fit
-    PS_FIT_LINEAR,              ///< Do linear interpolation
-    PS_FIT_POLYNOMIAL,          ///< Fit polynomial
-    PS_FIT_CHEBYSHEV,           ///< Fit chebyshev
-    PS_FIT_SPLINE               ///< Fit cubic splines
+    PS_FIT_NONE,                ///< No fit
+    PS_FIT_LINEAR,              ///< Do linear interpolation
+    PS_FIT_POLYNOMIAL,          ///< Fit polynomial
+    PS_FIT_CHEBYSHEV,           ///< Fit chebyshev
+    PS_FIT_SPLINE               ///< Fit cubic splines
 } psFit;
 \end{verbatim}
@@ -331 +331 @@
 /** Overscan axis */
 typedef enum {
-    PS_OVERSCAN_NONE,                   ///< No overscan subtraction
-    PS_OVERSCAN_ROWS,                   ///< Subtract rows
-    PS_OVERSCAN_COLUMNS,                ///< Subtract columns
-    PS_OVERSCAN_ALL                     ///< Subtract the statistic of all pixels in overscan region
+    PS_OVERSCAN_NONE,                   ///< No overscan subtraction
+    PS_OVERSCAN_ROWS,                   ///< Subtract rows
+    PS_OVERSCAN_COLUMNS,                ///< Subtract columns
+    PS_OVERSCAN_ALL                     ///< Subtract the statistic of all pixels in overscan region
 } psOverscanAxis;
 \end{verbatim}
@@ -546 +546 @@
 /** Mask values */
 typedef enum {
-    PS_MASK_TRAP,                       // The pixel is a charge trap
-    PS_MASK_BADCOL,                     // The pixel is a bad column
-    PS_MASK_SAT,                        // The pixel is saturated
-    PS_MASK_FLAT,                       // The pixel is non-positive in the flat-field
-    PS_MASK_CR_MORPH                    // The pixel is determined to be a cosmic ray, based on its morphology
+    PS_MASK_TRAP,                       ///< The pixel is a charge trap
+    PS_MASK_BADCOL,                     ///< The pixel is a bad column
+    PS_MASK_SAT,                        ///< The pixel is saturated
+    PS_MASK_FLAT,                       ///< The pixel is non-positive in the flat-field
+    PS_MASK_CR_MORPH                    ///< The pixel is determined to be a cosmic ray, from morphology
 } psMaskValue;
 \end{verbatim}
@@ -569 +569 @@
 \begin{verbatim}
 /** Returns an image that has the bad pixels masked.  Also masks saturated pixels */
-psReadout *psPhase2MaskBadPixels(psReadout *in ///< Image to be masked, and output
-                                 const psImage *mask, ///< Bad pixel mask to apply
-                                 int maskVal, ///< Mask the pixels for which mask & maskVal > 0.
-                                 float sat, ///< Saturation level: pixels brighter than this level are masked
-                                 int grow ///< Radius to grow the bad pixels
-                                 );
+psReadout *psPhase2MaskBadPixels(psReadout *in, const psImage *mask, int maskVal, float sat, int grow);
 \end{verbatim}