Changeset 153 for trunk/archive/pslib/include/psPosition.h
- Timestamp:
- Mar 9, 2004, 12:28:16 PM (22 years ago)
- File:
-
- 1 edited
-
trunk/archive/pslib/include/psPosition.h (modified) (7 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/archive/pslib/include/psPosition.h
r149 r153 7 7 /***********************************************************************************************************/ 8 8 9 /* Magic values for errors */9 /** Magic values for errors */ 10 10 enum { 11 PS_NO_VALUE = -111.0, // Corresponding value not yet measured12 PS_NO_ERROR = -222.0 // Corresponding value has no error11 PS_NO_VALUE = -111.0, //!< Corresponding value not yet measured 12 PS_NO_ERROR = -222.0 //!< Corresponding value has no error 13 13 }; 14 14 15 15 /***********************************************************************************************************/ 16 16 17 /* Planets */17 /** Planets */ 18 18 enum { 19 19 PS_MERCURY = 1, … … 27 27 } psPlanetNum; 28 28 29 /* Catalogues */29 /** Catalogues */ 30 30 enum { 31 PS_PANSTARRS, // Pan-STARRS object catalogue32 PS_USNO, // USNO-B1 catalogue33 PS_2MASS, // 2MASS catalogue34 PS_TYCHO, // Tycho catalogue35 UCAC2 = 4 //UCAC2 catalogue31 PS_PANSTARRS, //!< Pan-STARRS object catalogue 32 PS_USNO, //!< USNO-B1 catalogue 33 PS_2MASS, //!< 2MASS catalogue 34 PS_TYCHO, //!< Tycho catalogue 35 PS_UCAC2 = 4 //!< UCAC2 catalogue 36 36 } psCatalogue; 37 37 38 38 /***********************************************************************************************************/ 39 39 40 /* A position on a detector */40 /** A position on a detector */ 41 41 typedef struct { 42 int chip; // Chip number43 float x; // x position44 float xErr; // Error in x position45 float y; // y position46 float yErr; // Error in y position42 int chip; //!< Chip number 43 float x; //!< x position 44 float xErr; //!< Error in x position 45 float y; //!< y position 46 float yErr; //!< Error in y position 47 47 } psOTAPos; 48 48 49 /* Constructor */49 /** Constructor */ 50 50 psOTAPos * 51 51 psOTAPosNew(void); 52 52 53 /* Destructor */53 /** Destructor */ 54 54 void 55 psOTAPosDel(psOTAPos *restrict myOTAPos // Object to destroy55 psOTAPosDel(psOTAPos *restrict myOTAPos //!< Object to destroy 56 56 ); 57 57 58 58 /***********************************************************************************************************/ 59 59 60 /* An array of detector positions */60 /** An array of detector positions */ 61 61 PS_DECLARE_ARRAY_TYPE(psOTAPos); 62 62 PS_CREATE_ARRAY_TYPE(psOTAPos); … … 64 64 /***********************************************************************************************************/ 65 65 66 /* A simple RA/Dec position on the sky, default system is ICRS. */ 67 /* Double precision needed for milli-arcsec */ 66 /* 67 * \brief A simple RA/Dec position on the sky, default system is ICRS. Double precision needed for 68 * milli-arcsec. 69 */ 68 70 typedef struct { 69 double ra; // Right Ascension70 double raErr; // Error in RA71 double dec; // Declination72 double decErr; // Error in Dec71 double ra; //!< Right Ascension 72 double raErr; //!< Error in RA 73 double dec; //!< Declination 74 double decErr; //!< Error in Dec 73 75 } psSkyPos; 74 76 75 /* Constructor */77 /** Constructor */ 76 78 psSkyPos * 77 79 psSkyPosNew(void); 78 80 79 /* Destructor */81 /** Destructor */ 80 82 void 81 psSkyPosDel(psSkyPos *restrict mySkyPos // Object to destroy83 psSkyPosDel(psSkyPos *restrict mySkyPos //!< Object to destroy 82 84 ); 83 85 84 86 /***********************************************************************************************************/ 85 87 86 /* An array of sky positions */88 /** An array of sky positions */ 87 89 PS_DECLARE_ARRAY_TYPE(psSkyPos); 88 90 PS_CREATE_ARRAY_TYPE(psSkyPos); … … 90 92 /***********************************************************************************************************/ 91 93 92 /* Latitude and Longitude. */ 93 /* Double precision needed for milli-arcsec */ 94 /** Latitude and Longitude. Double precision needed for milli-arcsec */ 94 95 typedef struct { 95 double lat; // Latitude96 double latErr; // Error in Latitude97 double lng; // Longitude (can't use "long")98 double lngErr; // Error in Longitude96 double lat; //!< Latitude 97 double latErr; //!< Error in Latitude 98 double lng; //!< Longitude (can't use "long") 99 double lngErr; //!< Error in Longitude 99 100 } psLatLong; 100 101 101 /* Constructor */102 /** Constructor */ 102 103 psLatLong * 103 104 psLatLongNew(void); 104 105 105 /* Destructor */106 /** Destructor */ 106 107 void 107 psLatLongDel(psLatLong *restrict myLatLong // Object to destroy108 psLatLongDel(psLatLong *restrict myLatLong //!< Object to destroy 108 109 ); 109 110 … … 112 113 /* Offsets */ 113 114 114 /* Get offset (RA,Dec) on the sky between two positions */ 115 /* position1 and position2 may not be identical */ 115 /** Get offset (RA,Dec) on the sky between two positions position1 and position2 may not be identical */ 116 116 psSkyPos * 117 psGetOffset(const psSkyPos *restrict position1, // Position 1118 const psSkyPos *restrict position2 // Position 2117 psGetOffset(const psSkyPos *restrict position1, //!< Position 1 118 const psSkyPos *restrict position2 //!< Position 2 119 119 ); 120 120 121 /* Apply an offset to a position */121 /** Apply an offset to a position */ 122 122 psSkyPos * 123 psApplyOffset(const psSkyPos *restrict position, // Position124 const psSkyPos *restrict offset // Offset123 psApplyOffset(const psSkyPos *restrict position, //!< Position 124 const psSkyPos *restrict offset //!< Offset 125 125 ); 126 126 … … 129 129 /* Positions of well-known objects */ 130 130 131 /* Get Sun Position */131 /** Get Sun Position */ 132 132 psSkyPos * 133 psGetSunPos(float mjd // MJD to get position for133 psGetSunPos(float mjd //!< MJD to get position for 134 134 ); 135 135 136 /* Get Moon position */136 /** Get Moon position */ 137 137 psSkyPos * 138 psGetMoonPos(float mjd, // MJD to get position for139 double latitude, // Latitude for apparent position140 double longitude // Longitude for apparent position138 psGetMoonPos(float mjd, //!< MJD to get position for 139 double latitude, //!< Latitude for apparent position 140 double longitude //!< Longitude for apparent position 141 141 ); 142 142 143 /* Get Moon phase */143 /** Get Moon phase */ 144 144 float 145 psGetMoonPhase(float mjd // MJD to get phase for145 psGetMoonPhase(float mjd //!< MJD to get phase for 146 146 ); 147 147 148 /* Get Planet positions */148 /** Get Planet positions */ 149 149 psSkyPos * 150 psGetPlanetPos(enum psPlanetNum myPlanetNum, // Number for planet151 float mjd // MJD to get position for150 psGetPlanetPos(enum psPlanetNum myPlanetNum, //!< Number for planet 151 float mjd //!< MJD to get position for 152 152 ); 153 153 154 /* Get star list from catalogue */154 /** Get star list from catalogue */ 155 155 psObjectArray * 156 psReadStarCatalogue(double ra, // RA of centre of search157 double dec, // Declination of centre of search158 float radius, // Radius of search for stars in catalogue159 float mjd, // The epoch (in MJD) for which to get positions160 enum psCatalogue myCatalogue // The catalogue to use156 psReadStarCatalogue(double ra, //!< RA of centre of search 157 double dec, //!< Declination of centre of search 158 float radius, //!< Radius of search for stars in catalogue 159 float mjd, //!< The epoch (in MJD) for which to get positions 160 enum psCatalogue myCatalogue //!< The catalogue to use 161 161 ); 162 162 … … 165 165 /* Celestial coordinate conversions */ 166 166 167 /* Convert ICRS to Ecliptic */167 /** Convert ICRS to Ecliptic */ 168 168 psLatLong * 169 psCoordinatesItoE(const psSkyPos *restrict coordinates // ICRS coordinates to convert169 psCoordinatesItoE(const psSkyPos *restrict coordinates //!< ICRS coordinates to convert 170 170 ); 171 171 172 /* Convert Ecliptic to ICRS */172 /** Convert Ecliptic to ICRS */ 173 173 psSkyPos * 174 psCoordinatesEtoI(const psLatLong *restrict coordinates // Ecliptic coordinates to convert174 psCoordinatesEtoI(const psLatLong *restrict coordinates //!< Ecliptic coordinates to convert 175 175 ); 176 176 177 /* Convert ICRS to Galactic */177 /** Convert ICRS to Galactic */ 178 178 psLatLong * 179 psCoordinatesItoG(const psSkyPos *restrict coordinates // ICRS coordinates to convert179 psCoordinatesItoG(const psSkyPos *restrict coordinates //!< ICRS coordinates to convert 180 180 ); 181 181 182 /* Convert Galactic to ICRS */182 /** Convert Galactic to ICRS */ 183 183 psSkyPos * 184 psCoordinatesGtoI(const psLatLong *restrict coordinates // Galactic coordinates to convert184 psCoordinatesGtoI(const psLatLong *restrict coordinates //!< Galactic coordinates to convert 185 185 ); 186 186
Note:
See TracChangeset
for help on using the changeset viewer.
