IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Jul 18, 2005, 3:44:48 PM (21 years ago)
Author:
drobbin
Message:

psModules now works with the reorganized version of psLib

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/psModules/src/psAstrometry.h

    r4577 r4579  
    88*  @author GLG, MHPCC
    99*
    10 *  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
    11 *  @date $Date: 2005-07-18 18:48:29 $
     10*  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     11*  @date $Date: 2005-07-19 01:44:48 $
    1212*
    1313*  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     
    1717#define PS_ASTROMETRY_H
    1818
    19 #include "psType.h"
    20 #include "psImage.h"
    21 #include "psArray.h"
    22 #include "psList.h"
    23 #include "psFunctions.h"
    24 #include "psMetadata.h"
    25 #include "psCoord.h"
    26 #include "psPhotometry.h"
    27 
     19#include "pslib.h"
     20
     21/*
    2822struct psCell;
    2923struct psChip;
    3024struct psFPA;
    3125struct psExposure;
    32 
     26*/
    3327/// @addtogroup AstroImage
    3428/// @{
     
    4236 *
    4337 */
     38
     39/*
    4440typedef struct
    4541{
    46     const double latitude;           ///< geodetic latitude (radians)
    47     const double longitude;          ///< longitude + ... (radians)
    48     const double height;             ///< height (HM)
    49     const double abberationMag;      ///< magnitude of diurnal aberration vector
    50     const double temperature;        ///< ambient temperature (TDK)
    51     const double pressure;           ///< pressure (PMB)
    52     const double humidity;           ///< relative humidity (RH)
    53     const double wavelength;         ///< wavelength (WL)
    54     const double lapseRate;          ///< lapse rate (TLR)
    55     const double refractA, refractB; ///< refraction constants A and B (radians)
    56     const double siderealTime;       ///< local apparent sidereal time (radians)
     42   const double latitude;           ///< geodetic latitude (radians)
     43   const double longitude;          ///< longitude + ... (radians)
     44   const double height;             ///< height (HM)
     45   const double abberationMag;      ///< magnitude of diurnal aberration vector
     46   const double temperature;        ///< ambient temperature (TDK)
     47   const double pressure;           ///< pressure (PMB)
     48   const double humidity;           ///< relative humidity (RH)
     49   const double wavelength;         ///< wavelength (WL)
     50   const double lapseRate;          ///< lapse rate (TLR)
     51   const double refractA, refractB; ///< refraction constants A and B (radians)
     52   const double siderealTime;       ///< local apparent sidereal time (radians)
    5753}
    5854psGrommit;
     55*/
     56
    5957
    6058/** Fixed Pattern Corrections
     
    6765 *  of the grid in x and y as well as the origin of the grid.
    6866 */
     67/*
    6968typedef struct
    7069{
     
    8483}
    8584psFixedPattern;
     85*/
    8686
    8787/** Readout data structure.
     88 
    8889 *
    8990 *  A readout is the result of a single read of a cell (or a portion thereof).
     
    121122 *
    122123 */
     124/*
    123125typedef struct
    124126{
    125127    const psS32 col0;                  ///< Offset from the left of chip
    126128    const psS32 row0;                  ///< Offset from the bottom of chip
    127 
     129 
    128130    psArray* readouts;                 ///< readouts from the cell
    129 
     131 
    130132    psMetadata* metadata;              ///< cell-level metadata
    131 
     133 
    132134    psPlaneTransform* toChip;          ///< transformations from cell to chip coordinates
    133135    psPlaneTransform* fromChip;        ///< transformations from cell to chip coordinates
     
    135137    psPlaneTransform* toTP;            ///< transformations from cell to FPA coordinates
    136138    psPlaneTransform* toSky;           ///< transformations from cell to tangent plane coordinates
    137 
     139 
    138140    struct psChip* parent;             ///< chip in which contains this cell
    139141}
    140142psCell;
     143*/
    141144
    142145/** Chip data structure
     
    148151 *
    149152 */
    150 typedef struct psChip
     153/*typedef struct psChip
    151154{
    152155    const psS32 col0;                  ///< Offset from the left of FPA
    153156    const psS32 row0;                  ///< Offset from the bottom of FPA
    154 
     157 
    155158    psArray* cells;                    ///< cells in the chip
    156 
     159 
    157160    psMetadata* metadata;              ///< chip-level metadata
    158 
     161 
    159162    psPlaneTransform* toFPA;           ///< transformation from chip to FPA coordinates
    160163    psPlaneTransform* fromFPA;         ///< transformation from FPA to chip coordinates
    161 
     164 
    162165    struct psFPA* parent;              ///< FPA which contains this chip
    163166}
    164167psChip;
     168*/
    165169
    166170/** A Focal-Plane
     
    177181 *
    178182 */
    179 typedef struct psFPA
     183/*typedef struct psFPA
    180184{
    181185    psArray* chips;                    ///< chips in the focal plane array
    182186    psMetadata* metadata;              ///< focal-plane's metadata
    183 
     187 
    184188    psPlaneDistort* fromTangentPlane;  ///< transformation from tangent plane to focal plane
    185189    psPlaneDistort* toTangentPlane;    ///< transformation from focal plane to tangent plane
    186190    psFixedPattern* pattern;           ///< fixed pattern residual offsets
    187 
     191 
    188192    const struct psExposure* exposure; ///< information about this exposure
    189193    psGrommit *grommit;                ///< Wallace's grommit
    190 
     194 
    191195    psPhotSystem* colorPlus;           ///< Color reference
    192196    psPhotSystem* colorMinus;          ///< Color reference
    193197    psProjection *projection;          ///< projection
    194 
     198 
    195199    float rmsX;                        ///< RMS for x transformation fits
    196200    float rmsY;                        ///< RMS for y transformation fits
     
    198202}
    199203psFPA;
     204*/
    200205
    201206/** Observatory Information
     
    204209 *
    205210 */
    206 typedef struct
     211/*typedef struct
    207212{
    208213    const char* name;                  ///< Name of observatory
     
    213218}
    214219psObservatory;
     220*/
    215221
    216222/** Exposure Information
     
    221227 *
    222228 */
    223 typedef struct psExposure
     229/*typedef struct psExposure
    224230{
    225231    const double ra;                   ///< Telescope boresight, right ascention
     
    236242    const float wavelength;            ///< Wavelength in microns
    237243    const psObservatory* observatory;  ///< Observatory data
    238 
    239     /* Derived quantities */
     244 
     245    // Derived quantities
    240246    const double lst;                  ///< Local Sidereal Time
    241247    const float positionAngle;         ///< Position angle
     
    247253}
    248254psExposure;
     255*/
    249256
    250257/** Allocator for psFixedPattern struct
     
    255262 *  @return psFixedPattern*     New psFixedPattern struct.
    256263 */
    257 psFixedPattern* psFixedPatternAlloc(
     264/*psFixedPattern* psFixedPatternAlloc(
    258265    double x0,           ///< X Position of 0,0 corner on focal plane
    259266    double y0,           ///< Y Position of 0,0 corner on focal plane
     
    263270    const psImage *y     ///< The grid of offsets in y
    264271);
    265 
     272*/
    266273
    267274/** Allocator for psExposure
     
    273280 *  @return     psExposure*    New psExposure struct
    274281 */
    275 psExposure* psExposureAlloc(
     282/*psExposure* psExposureAlloc(
    276283    double ra,                         ///< Telescope boresight, right ascention
    277284    double dec,                        ///< Telescope boresight, declination
     
    288295    const psObservatory* observatory   ///< Observatory data
    289296);
     297*/
    290298
    291299/** Allocator for psObservatory
     
    296304 *  @return psObservatory*    new psObservatory struct
    297305 */
    298 psObservatory* psObservatoryAlloc(
     306/*psObservatory* psObservatoryAlloc(
    299307    const char* name,                  ///< Name of observatory
    300308    double latitude,                   ///< Latitude of observatory, east positive
     
    303311    double tlr                         ///< Tropospheric Lapse Rate
    304312);
     313*/
    305314
    306315/** Allocator for psFPA
     
    313322 *  @return psFPA*    a newly allocated psFPA
    314323 */
    315 psFPA* psFPAAlloc(
     324/*psFPA* psFPAAlloc(
    316325    psS32 nChips,                        ///< number of chips in the FPA
    317326    const psExposure* exp              ///< the exposure information
    318327);
     328*/
    319329
    320330/** Allocates a psChip
     
    326336 *  @return psChip*    newly allocated psChip
    327337 */
    328 psChip* psChipAlloc(
     338/*psChip* psChipAlloc(
    329339    psS32 nCells,                        ///< number of cells in Chip
    330340    psFPA* parentFPA                   ///< parent FPA
    331341);
     342*/
    332343
    333344/** Allocates a psCell
     
    339350 *  @return psCell*    newly allocated psCell
    340351 */
    341 psCell* psCellAlloc(
     352/*psCell* psCellAlloc(
    342353    psS32 nReadouts,                     ///< number of readouts in cell
    343354    psChip* parentChip                 ///< parent Chip
    344355);
     356*/
    345357
    346358/** Allocates a psReadout
     
    360372 *  @return psGrommit* New grommit structure.
    361373 */
    362 psGrommit* psGrommitAlloc(
     374/*psGrommit* psGrommitAlloc(
    363375    const psExposure* exp              ///< the cooresponding exposure structure.
    364376);
     377*/
    365378
    366379/** Find cooresponding cell for given FPA coordinate
     
    368381 *  @return psCell*    the cell cooresponding to the coord in FPA
    369382 */
    370 psCell* psCellInFPA(
     383/*psCell* psCellInFPA(
    371384    const psPlane* coord,              ///< the coordinate in FPA plane
    372385    const psFPA* FPA                   ///< the FPA to search for the cell
    373386);
     387*/
    374388
    375389/** Find cooresponding chip for given FPA coordinate
     
    377391 *  @return psChip*    the chip cooresponding to coord
    378392 */
    379 psChip* psChipInFPA(
     393/*psChip* psChipInFPA(
    380394    const psPlane* coord,              ///< the coordinate in FPA plane
    381395    const psFPA* FPA                   ///< the FPA to search for the cell
    382396);
     397*/
    383398
    384399/** Find cooresponding cell for given Chip coordinate
     
    386401 *  @return psCell*    the cell cooresponding to coord
    387402 */
    388 psCell* psCellInChip(
     403/*psCell* psCellInChip(
    389404    const psPlane* coord,              ///< the coordinate in Chip plane
    390405    const psChip* chip                 ///< the chip to search for the cell
    391406);
     407*/
    392408
    393409/** Translate a cell coordinate into a chip coordinate
     
    395411 *  @return psPlane*    the resulting chip coordinate
    396412 */
    397 psPlane* psCoordCellToChip(
     413/*psPlane* psCoordCellToChip(
    398414    psPlane* out,                      ///< a plane struct to recycle. If NULL, a new struct is created
    399415    const psPlane* in,                 ///< the coordinate within Cell
    400416    const psCell* cell                 ///< the Cell in interest
    401417);
     418*/
    402419
    403420/** Translate a chip coordinate into a FPA coordinate
     
    405422 *  @return psPlane*    the resulting FPA coordinate
    406423 */
    407 psPlane* psCoordChipToFPA(
     424/*psPlane* psCoordChipToFPA(
    408425    psPlane* out,                      ///< a plane struct to recycle. If NULL, a new struct is created
    409426    const psPlane* in,                 ///< the coordinate within Chip
    410427    const psChip* chip                 ///< the chip in interest
    411428);
     429*/
    412430
    413431/** Translate a FPA coordinate into a Tangent Plane coordinate
     
    415433 *  @return psPlane*    the resulting Tangent Plane coordinate
    416434 */
    417 psPlane* psCoordFPAToTP(
     435/*psPlane* psCoordFPAToTP(
    418436    psPlane* out,                      ///< a plane struct to recycle. If NULL, a new struct is created
    419437    const psPlane* in,                 ///< the coordinate within FPA
     
    422440    const psFPA* fpa                   ///< the FPA in interest
    423441);
     442*/
    424443
    425444/** Translate a Tangent Plane coordinate into a Sky coordinate
     
    427446 *  @return psSphere*    the resulting Sky coordinate
    428447 */
    429 psSphere* psCoordTPToSky(
     448/*psSphere* psCoordTPToSky(
    430449    psSphere* out,                     ///< a sphere struct to recycle. If NULL, a new struct is created
    431450    const psPlane* in,                 ///< the coordinate within Tangent Plane
    432451    const psGrommit* grommit           ///< the grommit of the tangent plane
    433452);
     453*/
    434454
    435455/** Translate a cell coordinate into a FPA coordinate
     
    437457 *  @return psPlane*    the resulting FPA coordinate
    438458 */
    439 psPlane* psCoordCellToFPA(
     459/*psPlane* psCoordCellToFPA(
    440460    psPlane* out,                      ///< a plane struct to recycle. If NULL, a new struct is created
    441461    const psPlane* in,                 ///< the coordinate within cell
    442462    const psCell* cell                 ///< the cell in interest
    443463);
     464*/
    444465
    445466/** Translate a cell coordinate into a Sky coordinate
     
    447468 *  @return psSphere*    the resulting Sky coordinate
    448469 */
    449 psSphere* psCoordCellToSky(
     470/*psSphere* psCoordCellToSky(
    450471    psSphere* out,                     ///< a sphere struct to recycle. If NULL, a new struct is created
    451472    const psPlane* in,                 ///< the coordinate within cell
     
    454475    const psCell* cell                 ///< the cell in interest
    455476);
     477*/
    456478
    457479/** Translate a cell coordinate into a Sky coordinate using a 'quick and
     
    460482 *  @return psSphere*    the resulting Sky coordinate
    461483 */
    462 psSphere* psCoordCellToSkyQuick(
     484/*psSphere* psCoordCellToSkyQuick(
    463485    psSphere* out,                     ///< a sphere struct to recycle. If NULL, a new struct is created
    464486    const psPlane* in,                 ///< the coordinate within cell
    465487    const psCell* cell                 ///< the cell in interest
    466488);
     489*/
    467490
    468491/** Translate a Sky coordinate into a Tangent Plane coordinate
     
    470493 *  @return psPlane*    the resulting Tangent Plane coordinate
    471494 */
    472 psPlane* psCoordSkyToTP(
     495/*psPlane* psCoordSkyToTP(
    473496    psPlane* out,                      ///< a plane struct to recycle. If NULL, a new struct is created
    474497    const psSphere* in,                ///< the sky coordinate
    475498    const psGrommit* grommit           ///< the grommit
    476499);
     500*/
    477501
    478502/** Translate a Tangent Plane coordinate into a FPA coordinate
     
    480504 *  @return psPlane*    the resulting FPA coordinate
    481505 */
    482 psPlane* psCoordTPToFPA(
     506/*psPlane* psCoordTPToFPA(
    483507    psPlane* out,                      ///< a plane struct to recycle. If NULL, a new struct is created
    484508    const psPlane* in,                 ///< the coordinate within tangent plane
     
    487511    const psFPA* fpa                   ///< the FPA of interest
    488512);
     513*/
    489514
    490515/** Translate a FPA coordinate into a chip coordinate
     
    492517 *  @return psPlane*    the resulting chip coordinate
    493518 */
    494 psPlane* psCoordFPAToChip(
     519/*psPlane* psCoordFPAToChip(
    495520    psPlane* out,                      ///< a plane struct to recycle. If NULL, a new struct is created
    496521    const psPlane* in,                 ///< the FPA coordinate
    497522    const psChip* chip                 ///< the chip of interest
    498523);
     524*/
    499525
    500526/** Translate a chip coordinate into a cell coordinate
     
    502528 *  @return psPlane*    the resulting cell coordinate
    503529 */
    504 psPlane* psCoordChipToCell(
     530/*psPlane* psCoordChipToCell(
    505531    psPlane* out,                      ///< a plane struct to recycle. If NULL, a new struct is created
    506532    const psPlane* in,                 ///< the Chip coordinate
    507533    const psCell* cell                 ///< the cell of interest
    508534);
     535*/
    509536
    510537/** Translate a sky coordinate into a cell coordinate
     
    512539 *  @return psPlane*    the resulting cell coordinate
    513540 */
    514 psPlane* psCoordSkyToCell(
     541/*psPlane* psCoordSkyToCell(
    515542    psPlane* out,                      ///< a plane struct to recycle. If NULL, a new struct is created
    516543    const psSphere* in,                ///< the Sky coordinate
     
    519546    const psCell* cell                 ///< the cell of interest
    520547);
     548*/
    521549
    522550/** Translate a sky coordinate into a cell coordinate using a 'quick and
     
    525553 *  @return psPlane*    the resulting cell coordinate
    526554 */
    527 psPlane* psCoordSkyToCellQuick(
     555/*psPlane* psCoordSkyToCellQuick(
    528556    psPlane* out,                      ///< a plane struct to recycle. If NULL, a new struct is created
    529557    const psSphere* in,                ///< the Sky coordinate
    530558    const psCell* cell                 ///< the cell of interest
    531559);
    532 
     560*/
    533561
    534562#endif // #ifndef PS_ASTROMETRY_H
Note: See TracChangeset for help on using the changeset viewer.