Changeset 973

Timestamp:

Jun 9, 2004, 3:57:54 PM (22 years ago)

Author:

Paul Price

Message:

Updated all prototypes from the phase2.h file.

File:

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

trunk/doc/modules/ModulesSDRS.tex

@@ -1 @@
-%%% $Id: ModulesSDRS.tex,v 1.1 2004-06-10 01:48:28 price Exp $
+%%% $Id: ModulesSDRS.tex,v 1.2 2004-06-10 01:57:54 price Exp $
 \documentclass[panstarrs]{panstarrs}
 
@@ -129 +129 @@
 /** Returns an image that is the result of convolving the input image with the specified kernel. */
 psImage *psPhase2ConvolveWithKernel(psImage *out, ///< Output image, or NULL
-                                    const psImage *in, ///< Input image to be convolved
-                                    const psImage *kernel ///< Kernel by which to convolve
-                                    );
+                                    const psImage *in, ///< Input image to be convolved
+                                    const psImage *kernel ///< Kernel by which to convolve
+                                    );
 \end{verbatim}
 
@@ -169 +169 @@
 /** Constructor */
 psImageRegion *psImageRegionAlloc(int x0, ///< x offset to region
-                                  int y0, ///< y offset to region
-                                  int nX, ///< Size of region in x
-                                  int nY ///< Size of region in y
-                                  );
+                                  int y0, ///< y offset to region
+                                  int nX, ///< Size of region in x
+                                  int nY ///< Size of region in y
+                                  );
 /** Destructor */
 void psImageRegionFree(psImageRegion *reg ///< Region to destroy
@@ -189 +189 @@
 /** Subtracts an overscan and bias from the input image. */
 psReadout *psPhase2SubtractBias(psReadout *in, ///< Input image to be de-biased, and output
-                                psPolynomial1D *polySpec, ///< Polynomial specification to use for fit,
-                                                          ///< outputed
-                                const psList *regions, ///< Linked list of psImageRegion types.
-                                psOverscanAxis overscanAxis, ///< Overscan axis
-                                const psStatsOptions *stat, ///< Statistic to use
-                                const psImage *bias ///< Bias (or dark) image to subtract
-                                );
+                                psPolynomial1D *polySpec, ///< Polynomial specification to use for fit,
+                                                          ///< outputed
+                                const psList *regions, ///< Linked list of psImageRegion types.
+                                psOverscanAxis overscanAxis, ///< Overscan axis
+                                const psStatsOptions *stat, ///< Statistic to use
+                                const psImage *bias ///< Bias (or dark) image to subtract
+                                );
 \end{verbatim}
 
@@ -219 +219 @@
     PS_OVERSCAN_ROWS_FIT = -1,          ///< Subtract a fit to rows
     PS_OVERSCAN_COLUMNS_FIT = -2,       ///< Subtract a fit to columns
-    PS_OVERSCAN_ALL = 3                 ///< Subtract the statistic of all pixels in overscan region
+    PS_OVERSCAN_ALL = 3                 ///< Subtract the statistic of all pixels in overscan region
 } psOverscanAxis;
 \end{verbatim}
+
 No prescan/overscan subtraction shall be performed if the
 \code{overscanAxis} is \code{PS_OVERSCAN_NONE} or if \code{regions} is
@@ -261 +262 @@
 /** Trims the input image to remove the edges corrupted by OT shifting, and the overscan. */
 psReadout *psPhase2Trim(psReadout *in,  ///< Input image to be trimmed, and output
-                      const psImageRegion *region ///< Region to keep
-                      );
+                        const psImageRegion *region ///< Region to keep
+                        );
 \end{verbatim}
 
@@ -289 +290 @@
 /** Applies the correction for detector non-linearity. */
 psReadout *psPhase2CorrectNonLinearity(psReadout *in, ///< Input image to be corrected, and output
-                                     psPolynomial1D *coeff ///< Polynomial with which to correct
-                                     );
+                                       const psPolynomial1D *coeff ///< Polynomial with which to correct
+                                       );
 \end{verbatim}
 
@@ -332 +333 @@
 following:
 \begin{verbatim}
-/** Subtracts the sky background. Needs work. */
+/** Subtracts the sky background. */
 psReadout *psPhase2SubtractSky(psReadout *in, ///< Input image to be sky-subtracted, and output
-                               psPolynomial2D *poly, ///< Polynomial specification, returns coeffcients
-                               psVector *outNorms, ///< Normalisations of the template sky images: output
-                               const psList *skyImages, ///< Template sky images: a list of type psImage, or
-                                                        ///< NULL
-                               const psList *catalog, ///< Sources nearby to mask when measuring the
-                                                      ///< background: a list of type psObject, or NULL
-                               float radiusMultiply, ///< Multiplying factor of object radius for mask
-                               float radiusAdd, ///< Additive factor to grow the object masks
-                               int binFactor ///< Binning factor to use on image before solving for polynomial
-                               );
+                               psPolynomial2D *poly, ///< Polynomial specification, returns coeffcients
+                               psVector *outNorms, ///< Normalisations of the template sky images: output
+                               const psList *skyImages, ///< Template sky images: a list of type psImage, or
+                                                        ///< NULL
+                               const psList *catalog, ///< Sources nearby to mask when measuring the
+                                                      ///< background: a list of type psObject, or NULL
+                               float radiusMultiply, ///< Multiplying factor of object radius for mask
+                               float radiusAdd, ///< Additive factor to grow the object masks
+                               int binFactor ///< Binning factor to use on image before solving for polynomial
+                               );
 \end{verbatim}
 
@@ -403 +404 @@
                                  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
+                                 float sat, ///< Saturation level: pixels brighter than this level are masked
                                  int grow ///< Radius to grow the bad pixels
                                  );
@@ -483 +484 @@
 API shall be the following:
 \begin{verbatim}
-/** Find and measure objects on the input image.  Fills in the "objects" member of the psReadout */
+/** Find and measure objects on the input image.  Fills in the "objects" member of the psReadout. */
 /** THIS NEEDS WORK. */
-psReadout *psPhase2GetObjects(psReadout *in, ///< Input image on which to find objects, and output
-                              const psImage *psf, ///< PSF to use to find objects
-                              const psVector *levels ///< Threshold levels (std dev.s)
-                              );
+psReadout *psPhase2FindObjects(psReadout *in, ///< Input image on which to find objects, and output
+                               const psImage *psf, ///< PSF to use to find objects
+                               const psVector *levels ///< Threshold levels (std dev.s)
+                               );
 \end{verbatim}