Index: trunk/psModules/src/psAstrometry.h =================================================================== --- trunk/psModules/src/psAstrometry.h (revision 4577) +++ trunk/psModules/src/psAstrometry.h (revision 4579) @@ -8,6 +8,6 @@ * @author GLG, MHPCC * -* @version $Revision: 1.1 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-07-18 18:48:29 $ +* @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ +* @date $Date: 2005-07-19 01:44:48 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -17,18 +17,12 @@ #define PS_ASTROMETRY_H -#include "psType.h" -#include "psImage.h" -#include "psArray.h" -#include "psList.h" -#include "psFunctions.h" -#include "psMetadata.h" -#include "psCoord.h" -#include "psPhotometry.h" - +#include "pslib.h" + +/* struct psCell; struct psChip; struct psFPA; struct psExposure; - +*/ /// @addtogroup AstroImage /// @{ @@ -42,19 +36,23 @@ * */ + +/* typedef struct { - const double latitude; ///< geodetic latitude (radians) - const double longitude; ///< longitude + ... (radians) - const double height; ///< height (HM) - const double abberationMag; ///< magnitude of diurnal aberration vector - const double temperature; ///< ambient temperature (TDK) - const double pressure; ///< pressure (PMB) - const double humidity; ///< relative humidity (RH) - const double wavelength; ///< wavelength (WL) - const double lapseRate; ///< lapse rate (TLR) - const double refractA, refractB; ///< refraction constants A and B (radians) - const double siderealTime; ///< local apparent sidereal time (radians) + const double latitude; ///< geodetic latitude (radians) + const double longitude; ///< longitude + ... (radians) + const double height; ///< height (HM) + const double abberationMag; ///< magnitude of diurnal aberration vector + const double temperature; ///< ambient temperature (TDK) + const double pressure; ///< pressure (PMB) + const double humidity; ///< relative humidity (RH) + const double wavelength; ///< wavelength (WL) + const double lapseRate; ///< lapse rate (TLR) + const double refractA, refractB; ///< refraction constants A and B (radians) + const double siderealTime; ///< local apparent sidereal time (radians) } psGrommit; +*/ + /** Fixed Pattern Corrections @@ -67,4 +65,5 @@ * of the grid in x and y as well as the origin of the grid. */ +/* typedef struct { @@ -84,6 +83,8 @@ } psFixedPattern; +*/ /** Readout data structure. + * * A readout is the result of a single read of a cell (or a portion thereof). @@ -121,13 +122,14 @@ * */ +/* typedef struct { const psS32 col0; ///< Offset from the left of chip const psS32 row0; ///< Offset from the bottom of chip - + psArray* readouts; ///< readouts from the cell - + psMetadata* metadata; ///< cell-level metadata - + psPlaneTransform* toChip; ///< transformations from cell to chip coordinates psPlaneTransform* fromChip; ///< transformations from cell to chip coordinates @@ -135,8 +137,9 @@ psPlaneTransform* toTP; ///< transformations from cell to FPA coordinates psPlaneTransform* toSky; ///< transformations from cell to tangent plane coordinates - + struct psChip* parent; ///< chip in which contains this cell } psCell; +*/ /** Chip data structure @@ -148,19 +151,20 @@ * */ -typedef struct psChip +/*typedef struct psChip { const psS32 col0; ///< Offset from the left of FPA const psS32 row0; ///< Offset from the bottom of FPA - + psArray* cells; ///< cells in the chip - + psMetadata* metadata; ///< chip-level metadata - + psPlaneTransform* toFPA; ///< transformation from chip to FPA coordinates psPlaneTransform* fromFPA; ///< transformation from FPA to chip coordinates - + struct psFPA* parent; ///< FPA which contains this chip } psChip; +*/ /** A Focal-Plane @@ -177,20 +181,20 @@ * */ -typedef struct psFPA +/*typedef struct psFPA { psArray* chips; ///< chips in the focal plane array psMetadata* metadata; ///< focal-plane's metadata - + psPlaneDistort* fromTangentPlane; ///< transformation from tangent plane to focal plane psPlaneDistort* toTangentPlane; ///< transformation from focal plane to tangent plane psFixedPattern* pattern; ///< fixed pattern residual offsets - + const struct psExposure* exposure; ///< information about this exposure psGrommit *grommit; ///< Wallace's grommit - + psPhotSystem* colorPlus; ///< Color reference psPhotSystem* colorMinus; ///< Color reference psProjection *projection; ///< projection - + float rmsX; ///< RMS for x transformation fits float rmsY; ///< RMS for y transformation fits @@ -198,4 +202,5 @@ } psFPA; +*/ /** Observatory Information @@ -204,5 +209,5 @@ * */ -typedef struct +/*typedef struct { const char* name; ///< Name of observatory @@ -213,4 +218,5 @@ } psObservatory; +*/ /** Exposure Information @@ -221,5 +227,5 @@ * */ -typedef struct psExposure +/*typedef struct psExposure { const double ra; ///< Telescope boresight, right ascention @@ -236,6 +242,6 @@ const float wavelength; ///< Wavelength in microns const psObservatory* observatory; ///< Observatory data - - /* Derived quantities */ + + // Derived quantities const double lst; ///< Local Sidereal Time const float positionAngle; ///< Position angle @@ -247,4 +253,5 @@ } psExposure; +*/ /** Allocator for psFixedPattern struct @@ -255,5 +262,5 @@ * @return psFixedPattern* New psFixedPattern struct. */ -psFixedPattern* psFixedPatternAlloc( +/*psFixedPattern* psFixedPatternAlloc( double x0, ///< X Position of 0,0 corner on focal plane double y0, ///< Y Position of 0,0 corner on focal plane @@ -263,5 +270,5 @@ const psImage *y ///< The grid of offsets in y ); - +*/ /** Allocator for psExposure @@ -273,5 +280,5 @@ * @return psExposure* New psExposure struct */ -psExposure* psExposureAlloc( +/*psExposure* psExposureAlloc( double ra, ///< Telescope boresight, right ascention double dec, ///< Telescope boresight, declination @@ -288,4 +295,5 @@ const psObservatory* observatory ///< Observatory data ); +*/ /** Allocator for psObservatory @@ -296,5 +304,5 @@ * @return psObservatory* new psObservatory struct */ -psObservatory* psObservatoryAlloc( +/*psObservatory* psObservatoryAlloc( const char* name, ///< Name of observatory double latitude, ///< Latitude of observatory, east positive @@ -303,4 +311,5 @@ double tlr ///< Tropospheric Lapse Rate ); +*/ /** Allocator for psFPA @@ -313,8 +322,9 @@ * @return psFPA* a newly allocated psFPA */ -psFPA* psFPAAlloc( +/*psFPA* psFPAAlloc( psS32 nChips, ///< number of chips in the FPA const psExposure* exp ///< the exposure information ); +*/ /** Allocates a psChip @@ -326,8 +336,9 @@ * @return psChip* newly allocated psChip */ -psChip* psChipAlloc( +/*psChip* psChipAlloc( psS32 nCells, ///< number of cells in Chip psFPA* parentFPA ///< parent FPA ); +*/ /** Allocates a psCell @@ -339,8 +350,9 @@ * @return psCell* newly allocated psCell */ -psCell* psCellAlloc( +/*psCell* psCellAlloc( psS32 nReadouts, ///< number of readouts in cell psChip* parentChip ///< parent Chip ); +*/ /** Allocates a psReadout @@ -360,7 +372,8 @@ * @return psGrommit* New grommit structure. */ -psGrommit* psGrommitAlloc( +/*psGrommit* psGrommitAlloc( const psExposure* exp ///< the cooresponding exposure structure. ); +*/ /** Find cooresponding cell for given FPA coordinate @@ -368,8 +381,9 @@ * @return psCell* the cell cooresponding to the coord in FPA */ -psCell* psCellInFPA( +/*psCell* psCellInFPA( const psPlane* coord, ///< the coordinate in FPA plane const psFPA* FPA ///< the FPA to search for the cell ); +*/ /** Find cooresponding chip for given FPA coordinate @@ -377,8 +391,9 @@ * @return psChip* the chip cooresponding to coord */ -psChip* psChipInFPA( +/*psChip* psChipInFPA( const psPlane* coord, ///< the coordinate in FPA plane const psFPA* FPA ///< the FPA to search for the cell ); +*/ /** Find cooresponding cell for given Chip coordinate @@ -386,8 +401,9 @@ * @return psCell* the cell cooresponding to coord */ -psCell* psCellInChip( +/*psCell* psCellInChip( const psPlane* coord, ///< the coordinate in Chip plane const psChip* chip ///< the chip to search for the cell ); +*/ /** Translate a cell coordinate into a chip coordinate @@ -395,9 +411,10 @@ * @return psPlane* the resulting chip coordinate */ -psPlane* psCoordCellToChip( +/*psPlane* psCoordCellToChip( psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created const psPlane* in, ///< the coordinate within Cell const psCell* cell ///< the Cell in interest ); +*/ /** Translate a chip coordinate into a FPA coordinate @@ -405,9 +422,10 @@ * @return psPlane* the resulting FPA coordinate */ -psPlane* psCoordChipToFPA( +/*psPlane* psCoordChipToFPA( psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created const psPlane* in, ///< the coordinate within Chip const psChip* chip ///< the chip in interest ); +*/ /** Translate a FPA coordinate into a Tangent Plane coordinate @@ -415,5 +433,5 @@ * @return psPlane* the resulting Tangent Plane coordinate */ -psPlane* psCoordFPAToTP( +/*psPlane* psCoordFPAToTP( psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created const psPlane* in, ///< the coordinate within FPA @@ -422,4 +440,5 @@ const psFPA* fpa ///< the FPA in interest ); +*/ /** Translate a Tangent Plane coordinate into a Sky coordinate @@ -427,9 +446,10 @@ * @return psSphere* the resulting Sky coordinate */ -psSphere* psCoordTPToSky( +/*psSphere* psCoordTPToSky( psSphere* out, ///< a sphere struct to recycle. If NULL, a new struct is created const psPlane* in, ///< the coordinate within Tangent Plane const psGrommit* grommit ///< the grommit of the tangent plane ); +*/ /** Translate a cell coordinate into a FPA coordinate @@ -437,9 +457,10 @@ * @return psPlane* the resulting FPA coordinate */ -psPlane* psCoordCellToFPA( +/*psPlane* psCoordCellToFPA( psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created const psPlane* in, ///< the coordinate within cell const psCell* cell ///< the cell in interest ); +*/ /** Translate a cell coordinate into a Sky coordinate @@ -447,5 +468,5 @@ * @return psSphere* the resulting Sky coordinate */ -psSphere* psCoordCellToSky( +/*psSphere* psCoordCellToSky( psSphere* out, ///< a sphere struct to recycle. If NULL, a new struct is created const psPlane* in, ///< the coordinate within cell @@ -454,4 +475,5 @@ const psCell* cell ///< the cell in interest ); +*/ /** Translate a cell coordinate into a Sky coordinate using a 'quick and @@ -460,9 +482,10 @@ * @return psSphere* the resulting Sky coordinate */ -psSphere* psCoordCellToSkyQuick( +/*psSphere* psCoordCellToSkyQuick( psSphere* out, ///< a sphere struct to recycle. If NULL, a new struct is created const psPlane* in, ///< the coordinate within cell const psCell* cell ///< the cell in interest ); +*/ /** Translate a Sky coordinate into a Tangent Plane coordinate @@ -470,9 +493,10 @@ * @return psPlane* the resulting Tangent Plane coordinate */ -psPlane* psCoordSkyToTP( +/*psPlane* psCoordSkyToTP( psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created const psSphere* in, ///< the sky coordinate const psGrommit* grommit ///< the grommit ); +*/ /** Translate a Tangent Plane coordinate into a FPA coordinate @@ -480,5 +504,5 @@ * @return psPlane* the resulting FPA coordinate */ -psPlane* psCoordTPToFPA( +/*psPlane* psCoordTPToFPA( psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created const psPlane* in, ///< the coordinate within tangent plane @@ -487,4 +511,5 @@ const psFPA* fpa ///< the FPA of interest ); +*/ /** Translate a FPA coordinate into a chip coordinate @@ -492,9 +517,10 @@ * @return psPlane* the resulting chip coordinate */ -psPlane* psCoordFPAToChip( +/*psPlane* psCoordFPAToChip( psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created const psPlane* in, ///< the FPA coordinate const psChip* chip ///< the chip of interest ); +*/ /** Translate a chip coordinate into a cell coordinate @@ -502,9 +528,10 @@ * @return psPlane* the resulting cell coordinate */ -psPlane* psCoordChipToCell( +/*psPlane* psCoordChipToCell( psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created const psPlane* in, ///< the Chip coordinate const psCell* cell ///< the cell of interest ); +*/ /** Translate a sky coordinate into a cell coordinate @@ -512,5 +539,5 @@ * @return psPlane* the resulting cell coordinate */ -psPlane* psCoordSkyToCell( +/*psPlane* psCoordSkyToCell( psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created const psSphere* in, ///< the Sky coordinate @@ -519,4 +546,5 @@ const psCell* cell ///< the cell of interest ); +*/ /** Translate a sky coordinate into a cell coordinate using a 'quick and @@ -525,10 +553,10 @@ * @return psPlane* the resulting cell coordinate */ -psPlane* psCoordSkyToCellQuick( +/*psPlane* psCoordSkyToCellQuick( psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created const psSphere* in, ///< the Sky coordinate const psCell* cell ///< the cell of interest ); - +*/ #endif // #ifndef PS_ASTROMETRY_H