Index: trunk/archive/pslib/include/psAstrom.h =================================================================== --- trunk/archive/pslib/include/psAstrom.h (revision 149) +++ trunk/archive/pslib/include/psAstrom.h (revision 153) @@ -14,91 +14,91 @@ /***********************************************************************************************************/ -/* Astrometric coefficients */ -typedef struct { - int xyOrder; // Spatial (x,y) order of polynomial - int colourOrder; // Order of polynomial in colour - int magOrder; // Order of polynomial in magnitude - int xyColourOrder; // Spatial (x,y) order of polynomial in colour times x and y - int xyMagOrder; // Spatial (x,y) order of polynomial in magnitude times x and y - enum psColourRef colourRef; // Colour reference - psDoubleArray *restrict coeff; // Coefficients of astrometric solution - psDoubleArray *restrict coeffErr; // Error in coefficients +/** Astrometric coefficients */ +typedef struct { + int xyOrder; //!< Spatial (x,y) order of polynomial + int colourOrder; //!< Order of polynomial in colour + int magOrder; //!< Order of polynomial in magnitude + int xyColourOrder; //!< Spatial (x,y) order of polynomial in colour times x and y + int xyMagOrder; //!< Spatial (x,y) order of polynomial in magnitude times x and y + enum psColourRef colourRef; //!< Colour reference + psDoubleArray *restrict coeff; //!< Coefficients of astrometric solution + psDoubleArray *restrict coeffErr; //!< Error in coefficients } psAstromCoeffs; -/* Constructor */ +/** Constructor */ psAstromCoeffs * -psAstromCoeffsNew(int xyOrder, // Spatial (x,y) order of polynomial - int colourOrder, // Order of polynomial in colour - int magOrder, // Order of polynomial in magnitude - int xyColourOrder, // Spatial (x,y) order of polynomial in colour times x and y - int xyMagOrder, // Spatial (x,y) order of polynomial in magnitude times x and y - enum psColourRef colourRef // Colour reference - ); - -/* Destructor */ -void -psAstromCoeffsDel(psAstromCoeffs *restrict myAstromCoeffs // Object to destroy - ); - -/***********************************************************************************************************/ - -/* Telescope pointing information for an exposure */ +psAstromCoeffsNew(int xyOrder, //!< Spatial (x,y) order of polynomial + int colourOrder, //!< Order of polynomial in colour + int magOrder, //!< Order of polynomial in magnitude + int xyColourOrder, //!< Spatial (x,y) order of polynomial in colour times x and y + int xyMagOrder, //!< Spatial (x,y) order of polynomial in magnitude times x and y + enum psColourRef colourRef //!< Colour reference + ); + +/** Destructor */ +void +psAstromCoeffsDel(psAstromCoeffs *restrict myAstromCoeffs //!< Object to destroy + ); + +/***********************************************************************************************************/ + +/** Telescope pointing information for an exposure */ 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 - float rotAngle; // Rotator position angle - float temp; // Temperature - float pressure; // Pressure + double ra, dec; //!< Telescope boresight + double ha; //!< Hour angle + double zd; //!< Zenith distance + double az; //!< Azimuth + float rotAngle; //!< Rotator position angle + float temp; //!< Temperature + float pressure; //!< Pressure /* Derived quantities */ - float parallactic; // Parallactic angle - float airmass; // Airmass, calculated from zenith distance + float parallactic; //!< Parallactic angle + float airmass; //!< Airmass, calculated from zenith distance } psTelPointing; -/* Constructor */ +/** Constructor */ psTelPointing * -psTelPointingNew(double ra, double dec, // Telescope boresight - double ha, // Hour angle - double zd, // Zenith distance - double az, // Azimuth - float rotAngle, // Rotator position angle - float temp, // Temperature - float pressure // Pressure - ); - -/* Destructor */ -void -psTelPointingDel(psTelPointing *restrict myTelPointing // Object to destroy - ); - - -/***********************************************************************************************************/ - -/* Cell details: specifies how the cell is mounted on its parent OTA */ -typedef struct { - psOTAPos position; // Position of cell in its OTA. Specifies the position of the - // (imaginary) pixel (0,0) - float rotation; // Rotation of cell in its OTA. Specified from +x through +y - int xSize, ySize; // Number of pixels in x and y - float scale; // Relative pixel scales, if CCD pitch varies. Specify a positive - // scale for a left-handed coordinate system, negative for right. If - // NULL, then every chip has identical scale, and system is - // left-handed. +psTelPointingNew(double ra, double dec, //!< Telescope boresight + double ha, //!< Hour angle + double zd, //!< Zenith distance + double az, //!< Azimuth + float rotAngle, //!< Rotator position angle + float temp, //!< Temperature + float pressure //!< Pressure + ); + +/** Destructor */ +void +psTelPointingDel(psTelPointing *restrict myTelPointing //!< Object to destroy + ); + + +/***********************************************************************************************************/ + +/** Cell details: specifies how the cell is mounted on its parent OTA */ +typedef struct { + psOTAPos position; //!< Position of cell in its OTA. Specifies the position of the + //!< (imaginary) pixel (0,0) + float rotation; //!< Rotation of cell in its OTA. Specified from +x through +y + int xSize, ySize; //!< Number of pixels in x and y + float scale; //!< Relative pixel scales, if CCD pitch varies. Specify a positive + //!< scale for a left-handed coordinate system, negative for right. If + //!< NULL, then every chip has identical scale, and system is + //!< left-handed. } psCellDescription; -/* Constructor */ +/** Constructor */ psCellDescription * psCellDescriptionNew(void); -/* Destructor */ -void -psCellDescriptionDel(psCellDescription *restrict myCell // Cell description to destroy - ); - -/***********************************************************************************************************/ - -/* Array of cell descriptions */ +/** Destructor */ +void +psCellDescriptionDel(psCellDescription *restrict myCell //!< Cell description to destroy + ); + +/***********************************************************************************************************/ + +/** Array of cell descriptions */ PS_DECLARE_ARRAY_TYPE(psCellDescription); PS_CREATE_ARRAY_TYPE(psCellDescription); @@ -106,26 +106,26 @@ /***********************************************************************************************************/ -/* OTA details: specifies how the OTA is mounted on the focal plane */ -typedef struct { - psOTAPos position; // Position of OTA on the focal plane. Specifies the position of the - // bottom left-hand corner. - float rotation; // Rotation of OTA on the focal plane. Specified from +x through +y - psCellDescriptionArray *restrict cells; // Cell descriptions - psOTAAstrom *astrom; // OTA astrometry +/** OTA details: specifies how the OTA is mounted on the focal plane */ +typedef struct { + psOTAPos position; //!< Position of OTA on the focal plane. Specifies the position of the + //!< bottom left-hand corner. + float rotation; //!< Rotation of OTA on the focal plane. Specified from +x through +y + psCellDescriptionArray *restrict cells; //!< Cell descriptions + psOTAAstrom *astrom; //!< OTA astrometry } psOTADescription; -/* Constructor */ +/** Constructor */ psOTADescription * psOTADescriptionNew(void); -/* Destructor */ -void -psOTADescriptionDel(psOTADescription *restrict myOTA // OTA description to destroy - ); - -/***********************************************************************************************************/ - -/* Astrometric solution for an OTA */ -/* There are four coordinate frames that we need to worry about: +/** Destructor. */ +void +psOTADescriptionDel(psOTADescription *restrict myOTA //!< OTA description to destroy + ); + +/***********************************************************************************************************/ + +/** Astrometric solution for an OTA. + * There are four coordinate frames that we need to worry about: * 1. Chip frame: chip# plus x,y in pixels * 2. Focal plane frame: X,Y in microns @@ -144,24 +144,24 @@ typedef struct { /* Focal plane to and from tangent plane */ - psAstromCoeffs *restrict tpToFP; // General astrometric solution for tangent plane to focal plane - psAstromCoeffs *restrict fpToTP; // General astrometric solution for focal plane to tangent plane - psMatrix *pattern; // Fixed pattern distortions for focal plane to tangent plane (simply - // * -1 for the reverse); MAY NEED TO BE REVISED UPON IMPLEMENTATION + psAstromCoeffs *restrict tpToFP; //!< General astrometric solution for tangent plane to focal plane + psAstromCoeffs *restrict fpToTP; //!< General astrometric solution for focal plane to tangent plane + psMatrix *pattern; //!< Fixed pattern distortions for focal plane to tangent plane (simply + //!< * -1 for the reverse); MAY NEED TO BE REVISED UPON IMPLEMENTATION /* Tangent plane to and from the celestial sphere */ - psDoubleArray *restrict tp; // Data needed to convert from the sky to the tangent plane and back; - // produced by and used by SLALib (a.k.a. "Wallace's Grommit") + psDoubleArray *restrict tp; //!< Data needed to convert from the sky to the tangent plane and back; + //!< produced by and used by SLALib (a.k.a. "Wallace's Grommit") /* Characterisation of the solution */ - 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 } psOTAAstrom; -/* Constructor */ +/** Constructor */ psAstrom * -psAstromNew(const psTelPointing *telescope // Telescope pointing, used to initialise the tp data. - ); - -/* Destructor */ -void -psAstromDel(psAstrom *restrict myAstrom // Object to destroy +psAstromNew(const psTelPointing *telescope //!< Telescope pointing, used to initialise the tp data. + ); + +/** Destructor */ +void +psAstromDel(psAstrom *restrict myAstrom //!< Object to destroy ); @@ -170,23 +170,23 @@ /* Calculating and applying astrometric solutions */ -/* Convert (RA,Dec) to (cell#,x,y) */ +/** Convert (RA,Dec) to (cell#,x,y) */ psOTAPos * -psSkyToOTA(const psSkyPos *restrict position, // Position on the sky - const psOTADescription *restrict ota // OTA details - ); - -/* Convert (cell#,x,y) to (RA,Dec) */ +psSkyToOTA(const psSkyPos *restrict position, //!< Position on the sky + const psOTADescription *restrict ota //!< OTA details + ); + +/** Convert (cell#,x,y) to (RA,Dec) */ psSkyPos * -psOTAToSky(const psOTAPos *restrict position, // Position on the detector - const psOTADescription *restrict ota // OTA details - ); - -/* Fit astrometric solution to list of (chip#,x,y) and (RA,Dec) */ +psOTAToSky(const psOTAPos *restrict position, //!< Position on the detector + const psOTADescription *restrict ota //!< OTA details + ); + +/** Fit astrometric solution to list of (chip#,x,y) and (RA,Dec) */ int -psFitAstrom(psOTADescription *restrict ota, // psAstrom struct containing initial guess for coefficients - const psOTAPosArray *restrict detector, // Positions on OTA (chip#,x,y) - const psSkyPosArray *restrict sky, // Positions on the sky (RA,Dec) - const psTelPointing *telescope // Telescope pointing information, for airmass, parallactic angle - // which may help set the astrometric solution +psFitAstrom(psOTADescription *restrict ota, //!< psAstrom struct containing initial guess for coefficients + const psOTAPosArray *restrict detector, //!< Positions on OTA (chip#,x,y) + const psSkyPosArray *restrict sky, //!< Positions on the sky (RA,Dec) + const psTelPointing *telescope //!< Telescope pointing information, for airmass, parallactic angle + //!< which may help set the astrometric solution ); @@ -195,21 +195,21 @@ /* Functions needed for astrometry, and will likely be useful elsewhere */ -/* Get the airmass for a given position and sidereal time */ +/** Get the airmass for a given position and sidereal time */ float -psGetAirmass(const psSkyPos *restrict position, // Position on the sky - float siderealTime // Sidereal time +psGetAirmass(const psSkyPos *restrict position, //!< Position on the sky + float siderealTime //!< Sidereal time ); -/* Get the parallactic angle for a given position and sidereal time */ +/** Get the parallactic angle for a given position and sidereal time */ float -psGetParallactic(const psSkyPos *restrict position, // Position on the sky - real siderealTime // Sidereal time +psGetParallactic(const psSkyPos *restrict position, //!< Position on the sky + real siderealTime //!< Sidereal time ); -/* Estimate atmospheric refraction, along the parallactic */ +/** Estimate atmospheric refraction, along the parallactic */ float -psGetRefraction(float colour, // Colour of object - enum psColourRef colourRef; // Colour reference - psTelPointing telescope // Telescope pointing information, for airmass, temp and pressure +psGetRefraction(float colour, //!< Colour of object + enum psColourRef colourRef; //!< Colour reference + psTelPointing telescope //!< Telescope pointing information, for airmass, temp and pressure );