IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Changeset 918


Ignore:
Timestamp:
Jun 7, 2004, 4:57:29 PM (22 years ago)
Author:
Paul Price
Message:

Renamed phase2Whatever to psPhase2Whatever.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/archive/modules/include/phase2.h

    r910 r918  
    2525
    2626/** Returns the kernel of OT shifts made during the course of the exposure. */
    27 psImage *phase2GetKernel(psVector *shifts ///< List of OT shifts, from which the kernel will be calculated
    28                          );
     27psImage *psPhase2GetKernel(psVector *shifts ///< List of OT shifts, from which the kernel will be calculated
     28                           );
    2929
    3030/** Returns an image that is the result of convolving the input image with the specified kernel. */
    31 psReadout *phase2ConvolveWithKernel(psReadout *out, ///< Output image, or NULL
    32                                     const psReadout *in, ///< Input image to be convolved
    33                                     const psImage *kernel ///< Kernel by which to convolve
    34                                     );
     31psReadout *psPhase2ConvolveWithKernel(psReadout *out, ///< Output image, or NULL
     32                                      const psReadout *in, ///< Input image to be convolved
     33                                      const psImage *kernel ///< Kernel by which to convolve
     34                                      );
    3535
    3636/************************************************************************************************************/
     
    7878
    7979/** Subtracts an overscan and bias from the input image. */
    80 psReadout *phase2SubtractBias(psReadout *in, ///< Input image to be de-biased, and output
    81                               psPolynomial1D *polySpec, ///< Polynomial specification to use for fit, outputed
    82                               const psImageRegionArray *regions, ///< Bias regions
    83                               psOverscanAxis overscanAxis, ///< Overscan axis
    84                               const psStatsOptions *stat, ///< Statistic to use
    85                               const psImage *bias ///< Bias (or dark) image to subtract
    86                               );
     80psReadout *psPhase2SubtractBias(psReadout *in, ///< Input image to be de-biased, and output
     81                                psPolynomial1D *polySpec, ///< Polynomial specification to use for fit,
     82                                                          ///< outputed
     83                                const psImageRegionArray *regions, ///< Bias regions
     84                                psOverscanAxis overscanAxis, ///< Overscan axis
     85                                const psStatsOptions *stat, ///< Statistic to use
     86                                const psImage *bias ///< Bias (or dark) image to subtract
     87                                );
    8788
    8889/** Trims the input image to remove the edges corrupted by OT shifting, and the overscan. */
    89 psReadout *phase2Trim(psReadout *in,    ///< Input image to be trimmed, and output
    90                       const psImageRegion *region ///< Region to keep
    91                       );
     90psReadout *psPhase2Trim(psReadout *in,  ///< Input image to be trimmed, and output
     91                        const psImageRegion *region ///< Region to keep
     92                        );
    9293
    9394/************************************************************************************************************/
     
    99100 *  image metadata.
    100101 */
    101 psReadout *phase2CorrectNonLinearity(psReadout *in, ///< Input image to be corrected, and output
    102                                      psPolynomial1D *coeff ///< Polynomial with which to correct
    103                                      );
     102psReadout *psPhase2CorrectNonLinearity(psReadout *in, ///< Input image to be corrected, and output
     103                                       psPolynomial1D *coeff ///< Polynomial with which to correct
     104                                       );
    104105
    105106/** Flat-fields the image. */
    106 psReadout *phase2FlatField(psReadout *in, ///< Input image to be flat-fielded, and output
    107                            const psReadout *flat ///< Flat-field image
    108                            );
     107psReadout *psPhase2FlatField(psReadout *in, ///< Input image to be flat-fielded, and output
     108                             const psImage *flat ///< Flat-field image
     109                             );
    109110
    110111/** Subtracts the sky background. */
    111 psReadout *phase2SubtractSky(psReadout *in, ///< Input image to be sky-subtracted, and output
    112                              psPolynomial2D *poly, ///< Polynomial specification, returns coeffcients
    113                              const psImageArray *skyImages ///< Array of sky images
    114                              );
     112psReadout *psPhase2SubtractSky(psReadout *in, ///< Input image to be sky-subtracted, and output
     113                               psPolynomial2D *poly, ///< Polynomial specification, returns coeffcients
     114                               const psImageArray *skyImages ///< Array of sky images
     115                               );
    115116
    116117/************************************************************************************************************/
     
    119120
    120121/** Returns an image that has the bad pixels masked.  Also masks saturated pixels */
    121 psReadout *phase2MaskBadPixels(psReadout *in ///< Image to be masked, and output
    122                               const psImage *mask ///< Bad pixel mask to apply
    123                               );
     122psReadout *psPhase2MaskBadPixels(psReadout *in ///< Image to be masked, and output
     123                                const psImage *mask ///< Bad pixel mask to apply
     124                                );
    124125
    125126/** Masks Cosmic Rays on the input image on the basis of morphology. */
    126 psReadout *phase2MaskCRs(psReadout *in, ///< Input image to be masked, and output
    127                          int algorithm, ///< Algorithm number to use
    128                          const void *params ///< Parameters for algorithm
    129                          );
     127psReadout *psPhase2MaskCRs(psReadout *in, ///< Input image to be masked, and output
     128                           int algorithm, ///< Algorithm number to use
     129                           const void *params ///< Parameters for algorithm
     130                           );
    130131
    131132/** Masks optical defects in the input image */
    132 psChip *phase2MaskOpticalDefects(psChip *in, ///< Image to be masked (with astrometry), and output
    133                                  const psDlist *catalog, ///< Catalog stars nearby: a list of psObjects
    134                                  int grow ///< Number of pixels to grow
    135                                  );
     133psChip *psPhase2MaskOpticalDefects(psChip *in, ///< Image to be masked (with astrometry), and output
     134                                   const psDlist *catalog, ///< Catalog stars nearby: a list of psObjects
     135                                   int grow ///< Number of pixels to grow
     136                                   );
    136137
    137138/************************************************************************************************************/
     
    140141
    141142/** Measures the PSF on the input image.  Returns the PSF */
    142 psImage *phase2MeasurePSF(const psReadout *in, ///< Input image for which to measure the PSF
    143                           int algorithm, ///< Algorithm number to use
    144                           const void *params ///< Parameters for algorithm
    145                           );
     143psImage *psPhase2MeasurePSF(const psReadout *in, ///< Input image for which to measure the PSF
     144                            int algorithm, ///< Algorithm number to use
     145                            const void *params ///< Parameters for algorithm
     146                            );
    146147
    147148/** Find and measure objects on the input image.  Fills in the "objects" member of the psReadout */
    148 psReadout *phase2GetObjects(psReadout *in, ///< Input image on which to find objects, and output
    149                             const psImage *psf, ///< PSF to use to find objects
    150                             const psVector *levels ///< Threshold levels (std dev.s)
    151                             );
     149psReadout *psPhase2GetObjects(psReadout *in, ///< Input image on which to find objects, and output
     150                              const psImage *psf, ///< PSF to use to find objects
     151                              const psVector *levels ///< Threshold levels (std dev.s)
     152                              );
    152153
    153154/************************************************************************************************************/
     
    156157
    157158/** Corrects astrometry on the input chip */
    158 psChip *phase2Astrometry(psChip *in,    ///< Input chip for which to do astrometry, and output
    159                          const psDlist *catalog, ///< Catalog stars on the chip: a list of psObjects
    160                          int nClips,    ///< Number of clipping iterations
    161                          float clipLevel ///< Level at which to clip
    162                          );
     159psChip *psPhase2Astrometry(psChip *in,  ///< Input chip for which to do astrometry, and output
     160                           const psDlist *catalog, ///< Catalog stars on the chip: a list of psObjects
     161                           int nClips,  ///< Number of clipping iterations
     162                           float clipLevel ///< Level at which to clip
     163                           );
    163164
    164165/************************************************************************************************************/
     
    173174
    174175/** Return postage stamps of a set of regions */
    175 psImageArray *phase2PostageStamps(const psChip *in, ///< Chip from which to form postage stamps
    176                                   const psDlist *regions ///< Regions to postage-stampise: a list of
    177                                                          ///< psPostageStampSpec
    178 );
     176psImageArray *psPhase2PostageStamps(const psChip *in, ///< Chip from which to form postage stamps
     177                                    const psDlist *regions ///< Regions to postage-stampise: a list of
     178                                                           ///< psPostageStampSpec
     179                                    );
    179180
    180181/************************************************************************************************************/
Note: See TracChangeset for help on using the changeset viewer.