IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Feb 5, 2009, 10:44:04 AM (17 years ago)
Author:
eugene
Message:

merging Doxygen comments by Bill G from eam_branch_20081230

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/pswarp/src/pswarpMapGrid.c

    r18839 r21323  
     1/** @file pswarpMapGrid.c
     2 *
     3 *  @brief
     4 *
     5 *  @ingroup pswarp
     6 *
     7 *  @author IfA
     8 *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-05 20:44:04 $
     10 *  Copyright 2009 Institute for Astronomy, University of Hawaii
     11 */
     12
    113# include "pswarp.h"
    214
    3 // pswarpMapGridFromImage builds a set (a grid) of locally-linear maps which convert the source
    4 // coordinates (src) to destination coordinates (dest).  we construct a grid with superpixel
    5 // spacing of nXpix, nYpix.  The transformation for each grid cell is valid for the superpixel.
    6 // The grid over-fills the source image so every source image pixel is guaranteed to have a map.
     15/**
     16 * pswarpMapGridFromImage builds a set (a grid) of locally-linear maps which convert the source
     17 * coordinates (src) to destination coordinates (dest).  we construct a grid with superpixel
     18 * spacing of nXpix, nYpix.  The transformation for each grid cell is valid for the superpixel.
     19 * The grid over-fills the source image so every source image pixel is guaranteed to have a map.
     20 */
    721pswarpMapGrid *pswarpMapGridFromImage (pmReadout *dest, pmReadout *src, int nXpix, int nYpix) {
    822
     
    4155}
    4256
    43 // set the grid coordinate (gridX,gridY) for the given source image coordinate (ix,iy)
    44 // XXX return true if the result is on the src image, false otherwise (???)
     57/**
     58 * set the grid coordinate (gridX,gridY) for the given source image coordinate (ix,iy)
     59 * XXX return true if the result is on the src image, false otherwise (???)
     60 */
    4561bool pswarpMapGridSetGrid (pswarpMapGrid *grid, int ix, int iy, int *gridX, int *gridY) {
    4662
     
    5167}
    5268
    53 // given the specified grid coordinate (gridX, gridY), return the min and max coordinates for the tile
     69/**
     70 * given the specified grid coordinate (gridX, gridY), return the min and max coordinates for the tile
     71 */
    5472bool pswarpMapGridCoordRange (pswarpMapGrid *grid, int gridX, int gridY, psPlane *min, psPlane *max) {
    5573
     
    6381}
    6482
    65 // given the specified grid coordinate (gridX), return the x-coordinate for the source image
    66 // corresponding to the next grid cell
     83/**
     84 * given the specified grid coordinate (gridX), return the x-coordinate for the source image
     85 * corresponding to the next grid cell
     86 */
    6787int pswarpMapGridNextGrid_X (pswarpMapGrid *grid, int gridX) {
    6888
     
    7191}
    7292
    73 // given the specified grid coordinate (gridY), return the y-coordinate for the source image
    74 // corresponding to the next grid cell
     93/**
     94 * given the specified grid coordinate (gridY), return the y-coordinate for the source image
     95 * corresponding to the next grid cell
     96 */
    7597int pswarpMapGridNextGrid_Y (pswarpMapGrid *grid, int gridY) {
    7698
     
    79101}
    80102
    81 // measure the max error accumulated in applying one grid point to its neighbors
    82 // XXX double-check this
     103/**
     104 * measure the max error accumulated in applying one grid point to its neighbors
     105 * XXX double-check this
     106 */
    83107double pswarpMapGridMaxError (pswarpMapGrid *grid) {
    84108
     
    102126}
    103127
    104 // given the source coordinate (inX,inY), return the destination coordinate (outX,outY)
     128/**
     129 * given the source coordinate (inX,inY), return the destination coordinate (outX,outY)
     130 */
    105131bool pswarpMapApply (double *outX, double *outY, pswarpMap *map, double inX, double inY) {
    106132
     
    111137}
    112138
    113 // determine the (linear) map for the given pixel (ix,iy) from source image (src) to the destination image (dest)
    114 // pixel is in src coords. input and output pixel coordinates are in the parent frame of the image (Note that the
    115 // astrometric transformations are supplied for the parent image coordinate frame.
     139/**
     140 * determine the (linear) map for the given pixel (ix,iy) from source image (src) to the destination image (dest)
     141 * pixel is in src coords. input and output pixel coordinates are in the parent frame of the image (Note that the
     142 * astrometric transformations are supplied for the parent image coordinate frame.
     143 */
    116144bool pswarpMapSetLocalModel (pswarpMap *map, pmReadout *dest, pmReadout *src, int ix, int iy) {
    117145
     
    139167    // XXX need to include readout->cell->chip offsets
    140168
    141     // V(0,0) position
     169    /** V(0,0) position */
    142170    offset->x = ix;
    143171    offset->y = iy;
     
    149177    psPlaneTransformApply (V00, chipDest->fromFPA, FP);
    150178   
    151     // V(1,0) position
     179    /** V(1,0) position */
    152180    offset->x = ix + 1;
    153181    offset->y = iy;
     
    159187    psPlaneTransformApply (V10, chipDest->fromFPA, FP);
    160188   
    161     // V(0,1) position
     189    /** V(0,1) position */
    162190    offset->x = ix;
    163191    offset->y = iy + 1;
Note: See TracChangeset for help on using the changeset viewer.