IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Mar 31, 2004, 5:01:04 PM (22 years ago)
Author:
Paul Price
Message:

Standardised on /< as Doxygen comment for variable.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/archive/pslib/include/psAstrom.h

    r343 r344  
    4040typedef struct {
    4141    // Telescope longitude, latitude and height are stored separately, since they don't change with pointing
    42     double ra, dec;                     //!< Telescope boresight
    43     double ha;                          //!< Hour angle
    44     double zd;                          //!< Zenith distance
    45     double az;                          //!< Azimuth
    46     double lst;                         //!< Local Sidereal Time
    47     float mjd;                          //!< MJD of observation
    48     float rotAngle;                     //!< Rotator position angle
    49     float temp;                         //!< Air temperature, for estimating refraction
    50     float pressure;                     //!< Air pressure, for calculating refraction
    51     float humidity;                     //!< Relative humidity, for calculating refraction
    52     float exptime;                      //!< Exposure time
     42    double ra, dec;                     ///< Telescope boresight
     43    double ha;                          ///< Hour angle
     44    double zd;                          ///< Zenith distance
     45    double az;                          ///< Azimuth
     46    double lst;                         ///< Local Sidereal Time
     47    float mjd;                          ///< MJD of observation
     48    float rotAngle;                     ///< Rotator position angle
     49    float temp;                         ///< Air temperature, for estimating refraction
     50    float pressure;                     ///< Air pressure, for calculating refraction
     51    float humidity;                     ///< Relative humidity, for calculating refraction
     52    float exptime;                      ///< Exposure time
    5353    /* Derived quantities */
    54     float posAngle;                     //!< Position angle
    55     float parallactic;                  //!< Parallactic angle
    56     float airmass;                      //!< Airmass, calculated from zenith distance
    57     float pf;                           //!< Parallactic factor
     54    float posAngle;                     ///< Position angle
     55    float parallactic;                  ///< Parallactic angle
     56    float airmass;                      ///< Airmass, calculated from zenith distance
     57    float pf;                           ///< Parallactic factor
    5858    char *cameraName;                   ///< name of camera which provided exposure
    5959    char *telescopeName;                ///< name of telescope which provided exposure
    60     psGrommit *grommit;                 //!< Data needed to convert from the sky to the tangent plane
     60    psGrommit *grommit;                 ///< Data needed to convert from the sky to the tangent plane
    6161} psExposure;
    6262
     
    6464/** The fixed pattern residual offsets.  These are specified via a coarse grid of x and y offsets. */
    6565typedef struct {
    66     int nX, nY;                         //!< Number of elements in x and y
    67     double x0, y0;                      //!< Position of the lower-left corner of the grid on the focal plane
    68     double xScale, yScale;              //!< Scale of the grid
    69     double **x, **y;                    //!< The grid of offsets in x and y
     66    int nX, nY;                         ///< Number of elements in x and y
     67    double x0, y0;                      ///< Position of the lower-left corner of the grid on the focal plane
     68    double xScale, yScale;              ///< Scale of the grid
     69    double **x, **y;                    ///< The grid of offsets in x and y
    7070} psFixedPattern;
    7171
     
    8282    psDistortion *TPtoFP;               ///< Transformation term from
    8383    psDistortion *FPtoTP;               ///< Transformation term from
    84     psFixedPattern *pattern;            //!< Fixed pattern residual offsets
     84    psFixedPattern *pattern;            ///< Fixed pattern residual offsets
    8585    psExposure *exp;                    ///< information about this exposure
    8686    psPhotSystem colorPlus, colorMinus; ///< Colour reference
    87     float rmsX, rmsY;                   //!< Dispersion in astrometric solution
    88     float chi2;                         //!< chi^2 of astrometric solution
     87    float rmsX, rmsY;                   ///< Dispersion in astrometric solution
     88    float chi2;                         ///< chi^2 of astrometric solution
    8989} psFPA;
    9090
     
    9898    psMetaDataSet *md;                  ///< Chip-level metadata
    9999    psCoordXform *chipToFPA;            ///< Transformations from chip coordinates to FPA coordinates
    100     psCoordXform *FPAtoChip;            //!< Transformations from FPA coordinates to chip
     100    psCoordXform *FPAtoChip;            ///< Transformations from FPA coordinates to chip
    101101
    102102    struct psFPA *parentFPA;            ///< FPA which contains this chip
     
    108108    int nReadouts;                      ///< number of readouts in this cell realization; each may have its
    109109                                        ///< own image, objects and overscan.
    110     psReadout *readouts;                //!< Readouts from the cell
     110    psReadout *readouts;                ///< Readouts from the cell
    111111    psMetaDataSet *md;                  ///< Cell-level metadata
    112112
     
    120120/** a Readout: a collection of pixels */
    121121typedef struct {
    122     const int x0, y0;                   //!< Offset from the lower-left corner
    123     const int nx, ny;                   //!< Image binning
     122    const int x0, y0;                   ///< Offset from the lower-left corner
     123    const int nx, ny;                   ///< Image binning
    124124    psImage *image;                     ///< imaging area of cell
    125125    psDlist *objects;                   ///< objects derived from cell
    126126    psImage *overscan;                  ///< bias region (subimage) of cell
    127     psMetaDataSet *md;                  //!< Readout-level metadata
     127    psMetaDataSet *md;                  ///< Readout-level metadata
    128128} psReadout;
    129129   
     
    138138/** returns Chip in FPA which contains the given FPA coordinate */
    139139psChip *
    140 psChipInFPA (psChip *out,               //!< Chip to return, or NULL
     140psChipInFPA (psChip *out,               ///< Chip to return, or NULL
    141141             const psFPA *fpa,          ///< FPA description
    142142             const psCoord *coord       ///< coordinate in FPA
     
    145145/** returns Cell in Chip which contains the given chip coordinate */
    146146psCell *
    147 psCellInChip(psCell *out,               //!< Cell to return, or NULL
     147psCellInChip(psCell *out,               ///< Cell to return, or NULL
    148148             const psChip *chip,        ///< chip description
    149149             const psCoord *coord       ///< coordinate in chip
     
    152152/** Return the cell in FPA which contains the given FPA coordinates */
    153153psCell *
    154 psCellInFPA(psCell *out,                //!< Cell to return, or NULL
    155             const psFPA *fpa,           //!< FPA description
    156             const psCoord *coord        //!< Coordinate in FPA
     154psCellInFPA(psCell *out,                ///< Cell to return, or NULL
     155            const psFPA *fpa,           ///< FPA description
     156            const psCoord *coord        ///< Coordinate in FPA
    157157            );
    158158
     
    160160/** Convert (RA,Dec) to cell and cell coordinates */
    161161psCoord *
    162 psCoordSkyToCell(psCoord *out,          //!< Coordinates to return, or NULL
    163                  psCell *cell,          //!< Cell to return
    164                  const psFPA *fpa       //!< FPA description
     162psCoordSkyToCell(psCoord *out,          ///< Coordinates to return, or NULL
     163                 psCell *cell,          ///< Cell to return
     164                 const psFPA *fpa       ///< FPA description
    165165                 );
    166166
    167167/** Convert cell and cell coordinate to (RA,Dec) */
    168168psCoord *
    169 psCoordCellToSky(psCoord *out,          //!< Coordinates to return, or NULL
    170                  const psCell *cell,    //!< Cell to get coordinates for
    171                  const psCoord *coord   //!< cell coordinates to transform
     169psCoordCellToSky(psCoord *out,          ///< Coordinates to return, or NULL
     170                 const psCell *cell,    ///< Cell to get coordinates for
     171                 const psCoord *coord   ///< cell coordinates to transform
    172172                 );
    173173
    174174/** Quick and dirty cell to (RA,Dec) --- employs cellToSky transformation */
    175175psCoord *
    176 psCoordCellToSkyQuick(psCoord *out,     //!< Coordinates to return, or NULL
    177                       const psCell *cell, //!< Cell description
    178                       const psCoord *coord //!< cell coordinates to transform
     176psCoordCellToSkyQuick(psCoord *out,     ///< Coordinates to return, or NULL
     177                      const psCell *cell, ///< Cell description
     178                      const psCoord *coord ///< cell coordinates to transform
    179179                      );
    180180
    181181/** Convert (RA,Dec) to tangent plane coords */
    182182psCoord *
    183 psCoordSkyToTP(psCoord *out,            //!< Coordinates to return, or NULL
    184                const psExposure *exp,   //!< Exposure description
    185                const psCoord *coord     //!< input Sky coordinate
     183psCoordSkyToTP(psCoord *out,            ///< Coordinates to return, or NULL
     184               const psExposure *exp,   ///< Exposure description
     185               const psCoord *coord     ///< input Sky coordinate
    186186               );
    187187
    188188/** Convert tangent plane coords to focal plane coordinates */
    189189psCoord *
    190 psCoordTPtoFPA(psCoord *out,            //!< Coordinates to return, or NULL
    191                const psFPA *fpa,        //!< FPA description
    192                const psCoord *coord     //!< input TP coordinate
     190psCoordTPtoFPA(psCoord *out,            ///< Coordinates to return, or NULL
     191               const psFPA *fpa,        ///< FPA description
     192               const psCoord *coord     ///< input TP coordinate
    193193               );
    194194
    195195/** converts the specified FPA coord to the coord on the given Chip */
    196196psCoord *
    197 psCoordFPAtoChip (psCoord *out,         //!< Coordinates to return, or NULL
     197psCoordFPAtoChip (psCoord *out,         ///< Coordinates to return, or NULL
    198198                  const psChip *chip,   ///< Chip of interest
    199199                  const psCoord *coord  ///< input FPA coordinate
     
    202202/** converts the specified Chip coord to the coord on the given Cell */
    203203psCoord *
    204 psCoordChiptoCell (psCoord *out,        //!< Coordinates to return, or NULL
     204psCoordChiptoCell (psCoord *out,        ///< Coordinates to return, or NULL
    205205                   const psCell *cell,  ///< Cell of interest
    206206                   const psCoord *coord ///< input Chip coordinate
     
    209209/** converts the specified Cell coord to the coord on the parent Chip */
    210210psCoord *
    211 psCoordCelltoChip (psCoord *out,        //!< Coordinates to return, or NULL
     211psCoordCelltoChip (psCoord *out,        ///< Coordinates to return, or NULL
    212212                   const psCell *cell,  ///< Cell description
    213213                   const psCoord *coord ///< input Cell coordinate
     
    216216/** converts the specified Chip coord to the coord on the parent FPA */
    217217psCoord *
    218 psCoordChiptoFPA (psCoord *out,         //!< Coordinates to return, or NULL
     218psCoordChiptoFPA (psCoord *out,         ///< Coordinates to return, or NULL
    219219                  const psChip *chip,   ///< Chip description
    220220                  const psCoord *coord  ///< input Chip coordinate
     
    223223/** Convert focal plane coords to tangent plane coordinates */
    224224psCoord *
    225 psCoordFPAToTP(psCoord *out,            //!< Coordinates to return, or NULL
    226                const psFPA *fpa,        //!< FPA description
    227                const psCoord *coord     //!< input FPA coordinate
     225psCoordFPAToTP(psCoord *out,            ///< Coordinates to return, or NULL
     226               const psFPA *fpa,        ///< FPA description
     227               const psCoord *coord     ///< input FPA coordinate
    228228               );
    229229
    230230/** Convert tangent plane coords to (RA,Dec) */
    231231psCoord *
    232 psCoordTPtoSky(psCoord *out,            //!< Coordinates to return, or NULL
    233                const psExposure *exp,   //!< Exposure description
    234                const psCoord *coord     //!< input TP coordinate
     232psCoordTPtoSky(psCoord *out,            ///< Coordinates to return, or NULL
     233               const psExposure *exp,   ///< Exposure description
     234               const psCoord *coord     ///< input TP coordinate
    235235               );
    236236
    237237/** Convert Cell coords to FPA coordinates */
    238238psCoord *
    239 psCoordCellToFPA(psCoord *out,          //!< Coordinates to return, or NULL
    240                  const psCell *cell,    //!< Cell description
    241                  const psCoord *coord   //!< Input cell coordinates
     239psCoordCellToFPA(psCoord *out,          ///< Coordinates to return, or NULL
     240                 const psCell *cell,    ///< Cell description
     241                 const psCoord *coord   ///< Input cell coordinates
    242242                 );
    243243
    244244/** Get the airmass for a given position and sidereal time */
    245245float
    246 psGetAirmass(const psCoord *coord,      //!< Position on the sky
    247              double siderealTime,       //!< Sidereal time
    248              float height               //!< Height above sea level
     246psGetAirmass(const psCoord *coord,      ///< Position on the sky
     247             double siderealTime,       ///< Sidereal time
     248             float height               ///< Height above sea level
    249249             );
    250250
    251251/** Get the parallactic angle for a given position and sidereal time */
    252252float
    253 psGetParallactic(const psCoord *coord,  //!< Position on the sky
    254                  double siderealTime    //!< Sidereal time
     253psGetParallactic(const psCoord *coord,  ///< Position on the sky
     254                 double siderealTime    ///< Sidereal time
    255255                 );
    256256
    257257/** Estimate atmospheric refraction, along the parallactic */
    258258float
    259 psGetRefraction(float colour,           //!< Colour of object
     259psGetRefraction(float colour,           ///< Colour of object
    260260                psPhotSystem colorPlus, ///< Colour reference
    261261                psPhotSystem colorMinus, ///< Colour reference
    262                 const psExposure *exp   //!< Telescope pointing information, for airmass, temp and pressure
     262                const psExposure *exp   ///< Telescope pointing information, for airmass, temp and pressure
    263263                );
    264264
    265265/** Calculate the parallax factor */
    266266psCoord *
    267 psGetParallaxFactor(const psExposure *exp //!< Exposure details
     267psGetParallaxFactor(const psExposure *exp ///< Exposure details
    268268    );
    269269
     
    272272/** Constructor */
    273273psExposure *
    274 psExposureAlloc(double ra, double dec,  //!< Telescope boresight
    275                 double ha,              //!< Hour angle
    276                 double zd,              //!< Zenith distance
    277                 double az,              //!< Azimuth
    278                 double lst,             //!< Local Sidereal Time
    279                 float mjd,              //!< MJD
    280                 float rotAngle,         //!< Rotator position angle
    281                 float temp,             //!< Temperature
    282                 float pressure,         //!< Pressure
    283                 float humidity,         //!< Relative humidity
    284                 float exptime           //!< Exposure time
     274psExposureAlloc(double ra, double dec,  ///< Telescope boresight
     275                double ha,              ///< Hour angle
     276                double zd,              ///< Zenith distance
     277                double az,              ///< Azimuth
     278                double lst,             ///< Local Sidereal Time
     279                float mjd,              ///< MJD
     280                float rotAngle,         ///< Rotator position angle
     281                float temp,             ///< Temperature
     282                float pressure,         ///< Pressure
     283                float humidity,         ///< Relative humidity
     284                float exptime           ///< Exposure time
    285285                );
    286286
    287287/** Destructor */
    288288void
    289 psExposureFree(psExposure *restrict myExp //!< Object to destroy
     289psExposureFree(psExposure *restrict myExp ///< Object to destroy
    290290               );
    291291/* \} */ // End of AstroGroup Functions
Note: See TracChangeset for help on using the changeset viewer.