Index: trunk/archive/pslib/include/psAstrom.h =================================================================== --- trunk/archive/pslib/include/psAstrom.h (revision 343) +++ trunk/archive/pslib/include/psAstrom.h (revision 344) @@ -40,23 +40,23 @@ typedef struct { // Telescope longitude, latitude and height are stored separately, since they don't change with pointing - double ra, dec; //!< Telescope boresight - double ha; //!< Hour angle - double zd; //!< Zenith distance - double az; //!< Azimuth - double lst; //!< Local Sidereal Time - float mjd; //!< MJD of observation - float rotAngle; //!< Rotator position angle - float temp; //!< Air temperature, for estimating refraction - float pressure; //!< Air pressure, for calculating refraction - float humidity; //!< Relative humidity, for calculating refraction - float exptime; //!< Exposure time + double ra, dec; ///< Telescope boresight + double ha; ///< Hour angle + double zd; ///< Zenith distance + double az; ///< Azimuth + double lst; ///< Local Sidereal Time + float mjd; ///< MJD of observation + float rotAngle; ///< Rotator position angle + float temp; ///< Air temperature, for estimating refraction + float pressure; ///< Air pressure, for calculating refraction + float humidity; ///< Relative humidity, for calculating refraction + float exptime; ///< Exposure time /* Derived quantities */ - float posAngle; //!< Position angle - float parallactic; //!< Parallactic angle - float airmass; //!< Airmass, calculated from zenith distance - float pf; //!< Parallactic factor + float posAngle; ///< Position angle + float parallactic; ///< Parallactic angle + float airmass; ///< Airmass, calculated from zenith distance + float pf; ///< Parallactic factor char *cameraName; ///< name of camera which provided exposure char *telescopeName; ///< name of telescope which provided exposure - psGrommit *grommit; //!< Data needed to convert from the sky to the tangent plane + psGrommit *grommit; ///< Data needed to convert from the sky to the tangent plane } psExposure; @@ -64,8 +64,8 @@ /** The fixed pattern residual offsets. These are specified via a coarse grid of x and y offsets. */ typedef struct { - int nX, nY; //!< Number of elements in x and y - double x0, y0; //!< Position of the lower-left corner of the grid on the focal plane - double xScale, yScale; //!< Scale of the grid - double **x, **y; //!< The grid of offsets in x and y + int nX, nY; ///< Number of elements in x and y + double x0, y0; ///< Position of the lower-left corner of the grid on the focal plane + double xScale, yScale; ///< Scale of the grid + double **x, **y; ///< The grid of offsets in x and y } psFixedPattern; @@ -82,9 +82,9 @@ psDistortion *TPtoFP; ///< Transformation term from psDistortion *FPtoTP; ///< Transformation term from - psFixedPattern *pattern; //!< Fixed pattern residual offsets + psFixedPattern *pattern; ///< Fixed pattern residual offsets psExposure *exp; ///< information about this exposure psPhotSystem colorPlus, colorMinus; ///< Colour reference - float rmsX, rmsY; //!< Dispersion in astrometric solution - float chi2; //!< chi^2 of astrometric solution + float rmsX, rmsY; ///< Dispersion in astrometric solution + float chi2; ///< chi^2 of astrometric solution } psFPA; @@ -98,5 +98,5 @@ psMetaDataSet *md; ///< Chip-level metadata psCoordXform *chipToFPA; ///< Transformations from chip coordinates to FPA coordinates - psCoordXform *FPAtoChip; //!< Transformations from FPA coordinates to chip + psCoordXform *FPAtoChip; ///< Transformations from FPA coordinates to chip struct psFPA *parentFPA; ///< FPA which contains this chip @@ -108,5 +108,5 @@ int nReadouts; ///< number of readouts in this cell realization; each may have its ///< own image, objects and overscan. - psReadout *readouts; //!< Readouts from the cell + psReadout *readouts; ///< Readouts from the cell psMetaDataSet *md; ///< Cell-level metadata @@ -120,10 +120,10 @@ /** a Readout: a collection of pixels */ typedef struct { - const int x0, y0; //!< Offset from the lower-left corner - const int nx, ny; //!< Image binning + const int x0, y0; ///< Offset from the lower-left corner + const int nx, ny; ///< Image binning psImage *image; ///< imaging area of cell psDlist *objects; ///< objects derived from cell psImage *overscan; ///< bias region (subimage) of cell - psMetaDataSet *md; //!< Readout-level metadata + psMetaDataSet *md; ///< Readout-level metadata } psReadout; @@ -138,5 +138,5 @@ /** returns Chip in FPA which contains the given FPA coordinate */ psChip * -psChipInFPA (psChip *out, //!< Chip to return, or NULL +psChipInFPA (psChip *out, ///< Chip to return, or NULL const psFPA *fpa, ///< FPA description const psCoord *coord ///< coordinate in FPA @@ -145,5 +145,5 @@ /** returns Cell in Chip which contains the given chip coordinate */ psCell * -psCellInChip(psCell *out, //!< Cell to return, or NULL +psCellInChip(psCell *out, ///< Cell to return, or NULL const psChip *chip, ///< chip description const psCoord *coord ///< coordinate in chip @@ -152,7 +152,7 @@ /** Return the cell in FPA which contains the given FPA coordinates */ psCell * -psCellInFPA(psCell *out, //!< Cell to return, or NULL - const psFPA *fpa, //!< FPA description - const psCoord *coord //!< Coordinate in FPA +psCellInFPA(psCell *out, ///< Cell to return, or NULL + const psFPA *fpa, ///< FPA description + const psCoord *coord ///< Coordinate in FPA ); @@ -160,40 +160,40 @@ /** Convert (RA,Dec) to cell and cell coordinates */ psCoord * -psCoordSkyToCell(psCoord *out, //!< Coordinates to return, or NULL - psCell *cell, //!< Cell to return - const psFPA *fpa //!< FPA description +psCoordSkyToCell(psCoord *out, ///< Coordinates to return, or NULL + psCell *cell, ///< Cell to return + const psFPA *fpa ///< FPA description ); /** Convert cell and cell coordinate to (RA,Dec) */ psCoord * -psCoordCellToSky(psCoord *out, //!< Coordinates to return, or NULL - const psCell *cell, //!< Cell to get coordinates for - const psCoord *coord //!< cell coordinates to transform +psCoordCellToSky(psCoord *out, ///< Coordinates to return, or NULL + const psCell *cell, ///< Cell to get coordinates for + const psCoord *coord ///< cell coordinates to transform ); /** Quick and dirty cell to (RA,Dec) --- employs cellToSky transformation */ psCoord * -psCoordCellToSkyQuick(psCoord *out, //!< Coordinates to return, or NULL - const psCell *cell, //!< Cell description - const psCoord *coord //!< cell coordinates to transform +psCoordCellToSkyQuick(psCoord *out, ///< Coordinates to return, or NULL + const psCell *cell, ///< Cell description + const psCoord *coord ///< cell coordinates to transform ); /** Convert (RA,Dec) to tangent plane coords */ psCoord * -psCoordSkyToTP(psCoord *out, //!< Coordinates to return, or NULL - const psExposure *exp, //!< Exposure description - const psCoord *coord //!< input Sky coordinate +psCoordSkyToTP(psCoord *out, ///< Coordinates to return, or NULL + const psExposure *exp, ///< Exposure description + const psCoord *coord ///< input Sky coordinate ); /** Convert tangent plane coords to focal plane coordinates */ psCoord * -psCoordTPtoFPA(psCoord *out, //!< Coordinates to return, or NULL - const psFPA *fpa, //!< FPA description - const psCoord *coord //!< input TP coordinate +psCoordTPtoFPA(psCoord *out, ///< Coordinates to return, or NULL + const psFPA *fpa, ///< FPA description + const psCoord *coord ///< input TP coordinate ); /** converts the specified FPA coord to the coord on the given Chip */ psCoord * -psCoordFPAtoChip (psCoord *out, //!< Coordinates to return, or NULL +psCoordFPAtoChip (psCoord *out, ///< Coordinates to return, or NULL const psChip *chip, ///< Chip of interest const psCoord *coord ///< input FPA coordinate @@ -202,5 +202,5 @@ /** converts the specified Chip coord to the coord on the given Cell */ psCoord * -psCoordChiptoCell (psCoord *out, //!< Coordinates to return, or NULL +psCoordChiptoCell (psCoord *out, ///< Coordinates to return, or NULL const psCell *cell, ///< Cell of interest const psCoord *coord ///< input Chip coordinate @@ -209,5 +209,5 @@ /** converts the specified Cell coord to the coord on the parent Chip */ psCoord * -psCoordCelltoChip (psCoord *out, //!< Coordinates to return, or NULL +psCoordCelltoChip (psCoord *out, ///< Coordinates to return, or NULL const psCell *cell, ///< Cell description const psCoord *coord ///< input Cell coordinate @@ -216,5 +216,5 @@ /** converts the specified Chip coord to the coord on the parent FPA */ psCoord * -psCoordChiptoFPA (psCoord *out, //!< Coordinates to return, or NULL +psCoordChiptoFPA (psCoord *out, ///< Coordinates to return, or NULL const psChip *chip, ///< Chip description const psCoord *coord ///< input Chip coordinate @@ -223,47 +223,47 @@ /** Convert focal plane coords to tangent plane coordinates */ psCoord * -psCoordFPAToTP(psCoord *out, //!< Coordinates to return, or NULL - const psFPA *fpa, //!< FPA description - const psCoord *coord //!< input FPA coordinate +psCoordFPAToTP(psCoord *out, ///< Coordinates to return, or NULL + const psFPA *fpa, ///< FPA description + const psCoord *coord ///< input FPA coordinate ); /** Convert tangent plane coords to (RA,Dec) */ psCoord * -psCoordTPtoSky(psCoord *out, //!< Coordinates to return, or NULL - const psExposure *exp, //!< Exposure description - const psCoord *coord //!< input TP coordinate +psCoordTPtoSky(psCoord *out, ///< Coordinates to return, or NULL + const psExposure *exp, ///< Exposure description + const psCoord *coord ///< input TP coordinate ); /** Convert Cell coords to FPA coordinates */ psCoord * -psCoordCellToFPA(psCoord *out, //!< Coordinates to return, or NULL - const psCell *cell, //!< Cell description - const psCoord *coord //!< Input cell coordinates +psCoordCellToFPA(psCoord *out, ///< Coordinates to return, or NULL + const psCell *cell, ///< Cell description + const psCoord *coord ///< Input cell coordinates ); /** Get the airmass for a given position and sidereal time */ float -psGetAirmass(const psCoord *coord, //!< Position on the sky - double siderealTime, //!< Sidereal time - float height //!< Height above sea level +psGetAirmass(const psCoord *coord, ///< Position on the sky + double siderealTime, ///< Sidereal time + float height ///< Height above sea level ); /** Get the parallactic angle for a given position and sidereal time */ float -psGetParallactic(const psCoord *coord, //!< Position on the sky - double siderealTime //!< Sidereal time +psGetParallactic(const psCoord *coord, ///< Position on the sky + double siderealTime ///< Sidereal time ); /** Estimate atmospheric refraction, along the parallactic */ float -psGetRefraction(float colour, //!< Colour of object +psGetRefraction(float colour, ///< Colour of object psPhotSystem colorPlus, ///< Colour reference psPhotSystem colorMinus, ///< Colour reference - const psExposure *exp //!< Telescope pointing information, for airmass, temp and pressure + const psExposure *exp ///< Telescope pointing information, for airmass, temp and pressure ); /** Calculate the parallax factor */ psCoord * -psGetParallaxFactor(const psExposure *exp //!< Exposure details +psGetParallaxFactor(const psExposure *exp ///< Exposure details ); @@ -272,20 +272,20 @@ /** Constructor */ psExposure * -psExposureAlloc(double ra, double dec, //!< Telescope boresight - double ha, //!< Hour angle - double zd, //!< Zenith distance - double az, //!< Azimuth - double lst, //!< Local Sidereal Time - float mjd, //!< MJD - float rotAngle, //!< Rotator position angle - float temp, //!< Temperature - float pressure, //!< Pressure - float humidity, //!< Relative humidity - float exptime //!< Exposure time +psExposureAlloc(double ra, double dec, ///< Telescope boresight + double ha, ///< Hour angle + double zd, ///< Zenith distance + double az, ///< Azimuth + double lst, ///< Local Sidereal Time + float mjd, ///< MJD + float rotAngle, ///< Rotator position angle + float temp, ///< Temperature + float pressure, ///< Pressure + float humidity, ///< Relative humidity + float exptime ///< Exposure time ); /** Destructor */ void -psExposureFree(psExposure *restrict myExp //!< Object to destroy +psExposureFree(psExposure *restrict myExp ///< Object to destroy ); /* \} */ // End of AstroGroup Functions