IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Aug 9, 2004, 12:44:25 PM (22 years ago)
Author:
desonia
Message:

fixed some stupid indent-induced formating problems and added doxygen
comments.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/psLib/src/astronomy/psAstrometry.h

    r1407 r1426  
    99*  @author George Gusciora, MHPCC
    1010*
    11 *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
    12 *  @date $Date: 2004-08-07 00:06:06 $
     11*  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
     12*  @date $Date: 2004-08-09 22:44:25 $
    1313*
    1414*  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    4545typedef struct
    4646{
    47     const double latitude;      // /< geodetic latitude (radians)
    48     const double sinLat;        // /< sine of geodetic latitude
    49     const double cosLat;        // /< cosine of geodetic latitude
    50     const double abberationMag; // /< magnitude of diurnal aberration vector
    51     const double height;        // /< height (HM)
    52     const double temperature;   // /< ambient temperature (TDK)
    53     const double pressure;      // /< pressure (PMB)
    54     const double humidity;      // /< relative humidity (RH)
    55     const double wavelength;    // /< wavelength (WL)
    56     const double lapseRate;     // /< lapse rate (TLR)
    57     const double refractA;      // /< refraction constant A (radians)
    58     const double refractB;      // /< refraction constant B (radians)
    59     const double longitudeOffset;       // /< longitude + ... (radians)
    60     const double siderealTime;  // /< local apparent sidereal time (radians)
     47    const double latitude;      ///< geodetic latitude (radians)
     48    const double sinLat;        ///< sine of geodetic latitude
     49    const double cosLat;        ///< cosine of geodetic latitude
     50    const double abberationMag; ///< magnitude of diurnal aberration vector
     51    const double height;        ///< height (HM)
     52    const double temperature;   ///< ambient temperature (TDK)
     53    const double pressure;      ///< pressure (PMB)
     54    const double humidity;      ///< relative humidity (RH)
     55    const double wavelength;    ///< wavelength (WL)
     56    const double lapseRate;     ///< lapse rate (TLR)
     57    const double refractA;      ///< refraction constant A (radians)
     58    const double refractB;      ///< refraction constant B (radians)
     59    const double longitudeOffset;       ///< longitude + ... (radians)
     60    const double siderealTime;  ///< local apparent sidereal time (radians)
    6161}
    6262psGrommit;
     
    7373typedef struct
    7474{
    75     int nX;                     // /< Number of elements in x direction
    76     int nY;                     // /< Number of elements in y direction
    77     double x0;                  // /< X Position of 0,0 corner on focal plane
    78     double y0;                  // /< Y Position of 0,0 corner on focal plane
    79     double xScale;              // /< Scale of the grid in x direction
    80     double yScale;              // /< Scale of the grid in x direction
    81     double **x;                 // /< The grid of offsets in x
    82     double **y;                 // /< The grid of offsets in y
     75    int nX;                     ///< Number of elements in x direction
     76    int nY;                     ///< Number of elements in y direction
     77    double x0;                  ///< X Position of 0,0 corner on focal plane
     78    double y0;                  ///< Y Position of 0,0 corner on focal plane
     79    double xScale;              ///< Scale of the grid in x direction
     80    double yScale;              ///< Scale of the grid in x direction
     81    double **x;                 ///< The grid of offsets in x
     82    double **y;                 ///< The grid of offsets in y
    8383}
    8484psFixedPattern;
     
    9595typedef struct
    9696{
    97     const unsigned int colBins; // /< Amount of binning in x-dimension
    98     const unsigned int rowBins; // /< Amount of binning in y-dimension
    99     const int col0;             // /< Offset from the left of chip.
    100     const int row0;             // /< Offset from the bottom of chip.
    101 
    102     psImage *image;             // /< imaging area of Readout
    103     psList *objects;            // /< objects derived from Readout
    104     psMetadata *metadata;       // /< readout-level metadata
     97    const unsigned int colBins; ///< Amount of binning in x-dimension
     98    const unsigned int rowBins; ///< Amount of binning in y-dimension
     99    const int col0;             ///< Offset from the left of chip.
     100    const int row0;             ///< Offset from the bottom of chip.
     101
     102    psImage *image;             ///< imaging area of Readout
     103    psList *objects;            ///< objects derived from Readout
     104    psMetadata *metadata;       ///< readout-level metadata
    105105}
    106106psReadout;
     
    117117typedef struct psCell
    118118{
    119     psArray *readouts;          // /< readouts from the cell
    120     psMetadata *metadata;       // /< cell-level metadata
    121 
    122     psPlaneTransform *toChip;   // /< transformations from cell to chip coordinates
    123     psPlaneTransform *fromChip; // /< transformations from chip to cell coordinates
    124     psPlaneTransform *toFPA;    // /< transformations from cell to FPA coordinates
    125     psPlaneTransform *toSky;    // /< transformations from cell to sky coordinates
    126 
    127     struct psChip *parent;      // /< chip in which contains this cell
     119    psArray *readouts;          ///< readouts from the cell
     120    psMetadata *metadata;       ///< cell-level metadata
     121
     122    psPlaneTransform *toChip;   ///< transformations from cell to chip coordinates
     123    psPlaneTransform *fromChip; ///< transformations from chip to cell coordinates
     124    psPlaneTransform *toFPA;    ///< transformations from cell to FPA coordinates
     125    psPlaneTransform *toSky;    ///< transformations from cell to sky coordinates
     126
     127    struct psChip *parent;      ///< chip in which contains this cell
    128128}
    129129psCell;
     
    139139typedef struct psChip
    140140{
    141     psArray *cells;             // /< cells in the chip
    142     psMetadata *metadata;       // /< chip-level metadata
    143 
    144     psPlaneTransform *toFPA;    // /< transformation from chip to FPA coordinates
    145     psPlaneTransform *fromFPA;  // /< transformation from FPA to chip coordinates
    146 
    147     struct psFPA *parent;       // /< FPA which contains this chip
     141    psArray *cells;             ///< cells in the chip
     142    psMetadata *metadata;       ///< chip-level metadata
     143
     144    psPlaneTransform *toFPA;    ///< transformation from chip to FPA coordinates
     145    psPlaneTransform *fromFPA;  ///< transformation from FPA to chip coordinates
     146
     147    struct psFPA *parent;       ///< FPA which contains this chip
    148148}
    149149psChip;
     
    164164typedef struct psFPA
    165165{
    166     psArray *chips;             // /< chips in the focal plane array
    167     psMetadata *metadata;       // /< focal-plane's metadata
    168 
    169     psPlaneDistort *fromTangentPlane;   // /< transformation from tangent plane to focal plane
    170     psPlaneDistort *toTangentPlane;     // /< transformation from focal plane to tangent plane
    171     psFixedPattern *pattern;    // /< fixed pattern residual offsets
    172 
    173     const struct psExposure *exposure;  // /< information about this exposure
    174 
    175     psPhotSystem *colorPlus;    // /< Color reference
    176     psPhotSystem *colorMinus;   // /< Color reference
    177 
    178     float rmsX;                 // /< RMS for x transformation fits
    179     float rmsY;                 // /< RMS for y transformation fits
    180     float chi2;                 // /< chi^2 of astrometric solution
     166    psArray *chips;             ///< chips in the focal plane array
     167    psMetadata *metadata;       ///< focal-plane's metadata
     168
     169    psPlaneDistort *fromTangentPlane;   ///< transformation from tangent plane to focal plane
     170    psPlaneDistort *toTangentPlane;     ///< transformation from focal plane to tangent plane
     171    psFixedPattern *pattern;    ///< fixed pattern residual offsets
     172
     173    const struct psExposure *exposure;  ///< information about this exposure
     174
     175    psPhotSystem *colorPlus;    ///< Color reference
     176    psPhotSystem *colorMinus;   ///< Color reference
     177
     178    float rmsX;                 ///< RMS for x transformation fits
     179    float rmsY;                 ///< RMS for y transformation fits
     180    float chi2;                 ///< chi^2 of astrometric solution
    181181}
    182182psFPA;
     
    191191typedef struct psExposure
    192192{
    193     const double ra;            // /< Telescope boresight, right ascention
    194     const double dec;           // /< Telescope boresight, declination
    195     const double hourAngle;     // /< Hour angle
    196     const double zenith;        // /< Zenith distance
    197     const double azimuth;       // /< Azimuth
    198     const double localTime;     // /< Local Sidereal Time
    199     const float date;           // /< Modified Jullian Date of observation
    200     const float rotAngle;       // /< Rotator position angle
    201     const float temperature;    // /< Air temperature, for estimating refraction
    202     const float pressure;       // /< Air pressure, for calculating refraction
    203     const float humidity;       // /< Relative humidity, for refraction
    204     const float exposureTime;   // /< Exposure time
     193    const double ra;            ///< Telescope boresight, right ascention
     194    const double dec;           ///< Telescope boresight, declination
     195    const double hourAngle;     ///< Hour angle
     196    const double zenith;        ///< Zenith distance
     197    const double azimuth;       ///< Azimuth
     198    const double localTime;     ///< Local Sidereal Time
     199    const float date;           ///< Modified Jullian Date of observation
     200    const float rotAngle;       ///< Rotator position angle
     201    const float temperature;    ///< Air temperature, for estimating refraction
     202    const float pressure;       ///< Air pressure, for calculating refraction
     203    const float humidity;       ///< Relative humidity, for refraction
     204    const float exposureTime;   ///< Exposure time
    205205
    206206    /* Derived quantities */
    207     const float positionAngle;  // /< Position angle
    208     const float parallacticAngle;       // /< Parallactic angle
    209     const float airmass;        // /< Airmass, calculated from zenith distance
    210     const float parallacticFactor;      // /< Parallactic factor
    211     const char *cameraName;     // /< name of camera which provided exposure
    212     const char *telescopeName;  // /< name of telescope which provided exposure
     207    const float positionAngle;  ///< Position angle
     208    const float parallacticAngle;       ///< Parallactic angle
     209    const float airmass;        ///< Airmass, calculated from zenith distance
     210    const float parallacticFactor;      ///< Parallactic factor
     211    const char *cameraName;     ///< name of camera which provided exposure
     212    const char *telescopeName;  ///< name of telescope which provided exposure
    213213}
    214214psExposure;
    215215
    216 psExposure *psExposureAlloc(double ra,  // /< Telescope boresight, right ascention
    217                             double dec, // /< Telescope boresight, declination
    218                             double hourAngle,   // /< Hour angle
    219                             double zenith,      // /< Zenith distance
    220                             double azimuth,     // /< Azimuth
    221                             double localTime,   // /< Local Sidereal Time
    222                             float date, // /< MJD
    223                             float rotAngle,     // /< Rotator position angle
    224                             float temperature,  // /< Temperature
    225                             float pressure,     // /< Pressure
    226                             float humidity,     // /< Relative humidity
    227                             float exposureTime  // /< Exposure time
     216psExposure *psExposureAlloc(double ra,  ///< Telescope boresight, right ascention
     217                            double dec, ///< Telescope boresight, declination
     218                            double hourAngle,   ///< Hour angle
     219                            double zenith,      ///< Zenith distance
     220                            double azimuth,     ///< Azimuth
     221                            double localTime,   ///< Local Sidereal Time
     222                            float date, ///< MJD
     223                            float rotAngle,     ///< Rotator position angle
     224                            float temperature,  ///< Temperature
     225                            float pressure,     ///< Pressure
     226                            float humidity,     ///< Relative humidity
     227                            float exposureTime  ///< Exposure time
    228228                           );
    229229
     
    235235 *  @return psGrommit*     New grommit structure.
    236236 */
    237 psGrommit *psGrommitAlloc(const psExposure * exp        // /< the cooresponding exposure structure.
     237psGrommit *psGrommitAlloc(const psExposure * exp        ///< the cooresponding exposure structure.
    238238                         );
    239239
Note: See TracChangeset for help on using the changeset viewer.