Index: /trunk/psLib/src/astro/psCoord.h =================================================================== --- /trunk/psLib/src/astro/psCoord.h (revision 1425) +++ /trunk/psLib/src/astro/psCoord.h (revision 1426) @@ -11,6 +11,6 @@ * @author George Gusciora, MHPCC * -* @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-07 00:06:06 $ +* @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -39,8 +39,8 @@ typedef struct { - double x; // /< x position - double y; // /< y position - double xErr; // /< Error in x position - double yErr; // /< Error in y position + double x; ///< x position + double y; ///< y position + double xErr; ///< Error in x position + double yErr; ///< Error in y position } psPlane; @@ -55,8 +55,8 @@ typedef struct { - double r; // /< RA - double d; // /< Dec - double rErr; // /< Error in RA - double dErr; // /< Error in Dec + double r; ///< RA + double d; ///< Dec + double rErr; ///< Error in RA + double dErr; ///< Error in Dec } psSphere; @@ -72,6 +72,6 @@ typedef struct { - psDPolynomial2D *x; // /< 2D polynomial transform of X coordinates - psDPolynomial2D *y; // /< 2D polynomial transform of Y coordinates + psDPolynomial2D *x; ///< 2D polynomial transform of X coordinates + psDPolynomial2D *y; ///< 2D polynomial transform of Y coordinates } psPlaneTransform; @@ -91,6 +91,6 @@ typedef struct { - psDPolynomial4D *x; // /< 4D polynomial transform of X coordinates - psDPolynomial4D *y; // /< 4D polynomial transform of Y coordinates + psDPolynomial4D *x; ///< 4D polynomial transform of X coordinates + psDPolynomial4D *y; ///< 4D polynomial transform of Y coordinates } psPlaneDistort; @@ -108,8 +108,8 @@ typedef struct { - double sinPhi; // /< sin of North Pole lattitude - double cosPhi; // /< cos of North Pole lattitude - double Xo; // /< First PT of Ares lon - double xo; // /< First PT of Ares equiv lon + double sinPhi; ///< sin of North Pole lattitude + double cosPhi; ///< cos of North Pole lattitude + double Xo; ///< First PT of Ares lon + double xo; ///< First PT of Ares equiv lon } psSphereTransform; @@ -121,12 +121,12 @@ */ typedef enum { - PS_PROJ_TAN, // /< Tangent projection - PS_PROJ_SIN, // /< Sine projection - PS_PROJ_AIT, // /< Aitoff projection - PS_PROJ_PAR, // /< Par projection - PS_PROJ_GLS, // /< GLS projection - PS_PROJ_CAR, // /< CAR projection - PS_PROJ_MER, // /< MER projection - PS_PROJ_NTYPE // /< Number of types; must be last. + PS_PROJ_TAN, ///< Tangent projection + PS_PROJ_SIN, ///< Sine projection + PS_PROJ_AIT, ///< Aitoff projection + PS_PROJ_PAR, ///< Par projection + PS_PROJ_GLS, ///< GLS projection + PS_PROJ_CAR, ///< CAR projection + PS_PROJ_MER, ///< MER projection + PS_PROJ_NTYPE ///< Number of types; must be last. } psProjectionType; @@ -138,9 +138,9 @@ typedef struct { - double R; // /< Coordinates of projection center - double D; // /< Coordinates of projection center - double Xs; // /< plate-scale in X direction - double Ys; // /< plate-scale in Y direction - psProjectionType type; // /< Projection type + double R; ///< Coordinates of projection center + double D; ///< Coordinates of projection center + double Xs; ///< plate-scale in X direction + double Ys; ///< plate-scale in Y direction + psProjectionType type; ///< Projection type } psProjection; @@ -152,6 +152,6 @@ */ typedef enum { - PS_SPHERICAL, // /< offset corresponds to an angular offset - PS_LINEAR // /< offset corresponds to a linear offset + PS_SPHERICAL, ///< offset corresponds to an angular offset + PS_LINEAR ///< offset corresponds to a linear offset } psSphereOffsetMode; @@ -162,8 +162,8 @@ */ typedef enum { - PS_ARCSEC, // /< Arcseconds - PS_ARCMIN, // /< Arcminutes - PS_DEGREE, // /< Degrees - PS_RADIAN // /< Radians + PS_ARCSEC, ///< Arcseconds + PS_ARCMIN, ///< Arcminutes + PS_DEGREE, ///< Degrees + PS_RADIAN ///< Radians } psSphereOffsetUnit; @@ -171,7 +171,7 @@ * */ -psPlane *psPlaneTransformApply(psPlane * out, // /< a psPlane to recycle. If NULL, a new one is generated. - const psPlaneTransform * transform, // /< the transform to apply - const psPlane * coords // /< the coordinate to apply the transform above. +psPlane *psPlaneTransformApply(psPlane * out, ///< a psPlane to recycle. If NULL, a new one is generated. + const psPlaneTransform * transform, ///< the transform to apply + const psPlane * coords ///< the coordinate to apply the transform above. ); @@ -179,9 +179,9 @@ * */ -psPlane *psPlaneDistortApply(psPlane * out, // /< a psPlane to recycle. If NULL, a new one is generated. - const psPlaneDistort * transform, // /< the transform to apply - const psPlane * coords, // /< the coordinate to apply the transform above. - float term3, // /< third term -- maybe magnitude - float term4 // /< forth term -- maybe color +psPlane *psPlaneDistortApply(psPlane * out, ///< a psPlane to recycle. If NULL, a new one is generated. + const psPlaneDistort * transform, ///< the transform to apply + const psPlane * coords, ///< the coordinate to apply the transform above. + float term3, ///< third term -- maybe magnitude + float term4 ///< forth term -- maybe color ); @@ -189,7 +189,7 @@ * */ -psSphereTransform *psSphereTransformAlloc(double NPlat, // /< north pole latitude - double Xo, // /< First PT of Ares lon - double xo // /< First PT of Ares equiv lon +psSphereTransform *psSphereTransformAlloc(double NPlat, ///< north pole latitude + double Xo, ///< First PT of Ares lon + double xo ///< First PT of Ares equiv lon ); @@ -197,8 +197,8 @@ * */ -psSphere *psSphereTransformApply(psSphere * out, // /< a psSphere to recycle. If NULL, a new one is +psSphere *psSphereTransformApply(psSphere * out, ///< a psSphere to recycle. If NULL, a new one is // generated. - const psSphereTransform * transform, // /< the transform to apply - const psSphere * coord // /< the coordinate to apply the transform above.x + const psSphereTransform * transform, ///< the transform to apply + const psSphere * coord ///< the coordinate to apply the transform above.x ); Index: /trunk/psLib/src/astronomy/psAstrometry.h =================================================================== --- /trunk/psLib/src/astronomy/psAstrometry.h (revision 1425) +++ /trunk/psLib/src/astronomy/psAstrometry.h (revision 1426) @@ -9,6 +9,6 @@ * @author George Gusciora, MHPCC * -* @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-07 00:06:06 $ +* @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -45,18 +45,18 @@ typedef struct { - const double latitude; // /< geodetic latitude (radians) - const double sinLat; // /< sine of geodetic latitude - const double cosLat; // /< cosine of geodetic latitude - const double abberationMag; // /< magnitude of diurnal aberration vector - const double height; // /< height (HM) - 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; // /< refraction constant A (radians) - const double refractB; // /< refraction constant B (radians) - const double longitudeOffset; // /< longitude + ... (radians) - const double siderealTime; // /< local apparent sidereal time (radians) + const double latitude; ///< geodetic latitude (radians) + const double sinLat; ///< sine of geodetic latitude + const double cosLat; ///< cosine of geodetic latitude + const double abberationMag; ///< magnitude of diurnal aberration vector + const double height; ///< height (HM) + 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; ///< refraction constant A (radians) + const double refractB; ///< refraction constant B (radians) + const double longitudeOffset; ///< longitude + ... (radians) + const double siderealTime; ///< local apparent sidereal time (radians) } psGrommit; @@ -73,12 +73,12 @@ typedef struct { - int nX; // /< Number of elements in x direction - int nY; // /< Number of elements in y direction - double x0; // /< X Position of 0,0 corner on focal plane - double y0; // /< Y Position of 0,0 corner on focal plane - double xScale; // /< Scale of the grid in x direction - double yScale; // /< Scale of the grid in x direction - double **x; // /< The grid of offsets in x - double **y; // /< The grid of offsets in y + int nX; ///< Number of elements in x direction + int nY; ///< Number of elements in y direction + double x0; ///< X Position of 0,0 corner on focal plane + double y0; ///< Y Position of 0,0 corner on focal plane + double xScale; ///< Scale of the grid in x direction + double yScale; ///< Scale of the grid in x direction + double **x; ///< The grid of offsets in x + double **y; ///< The grid of offsets in y } psFixedPattern; @@ -95,12 +95,12 @@ typedef struct { - const unsigned int colBins; // /< Amount of binning in x-dimension - const unsigned int rowBins; // /< Amount of binning in y-dimension - const int col0; // /< Offset from the left of chip. - const int row0; // /< Offset from the bottom of chip. - - psImage *image; // /< imaging area of Readout - psList *objects; // /< objects derived from Readout - psMetadata *metadata; // /< readout-level metadata + const unsigned int colBins; ///< Amount of binning in x-dimension + const unsigned int rowBins; ///< Amount of binning in y-dimension + const int col0; ///< Offset from the left of chip. + const int row0; ///< Offset from the bottom of chip. + + psImage *image; ///< imaging area of Readout + psList *objects; ///< objects derived from Readout + psMetadata *metadata; ///< readout-level metadata } psReadout; @@ -117,13 +117,13 @@ typedef struct psCell { - psArray *readouts; // /< readouts from the cell - psMetadata *metadata; // /< cell-level metadata - - psPlaneTransform *toChip; // /< transformations from cell to chip coordinates - psPlaneTransform *fromChip; // /< transformations from chip to cell coordinates - psPlaneTransform *toFPA; // /< transformations from cell to FPA coordinates - psPlaneTransform *toSky; // /< transformations from cell to sky coordinates - - struct psChip *parent; // /< chip in which contains this cell + psArray *readouts; ///< readouts from the cell + psMetadata *metadata; ///< cell-level metadata + + psPlaneTransform *toChip; ///< transformations from cell to chip coordinates + psPlaneTransform *fromChip; ///< transformations from chip to cell coordinates + psPlaneTransform *toFPA; ///< transformations from cell to FPA coordinates + psPlaneTransform *toSky; ///< transformations from cell to sky coordinates + + struct psChip *parent; ///< chip in which contains this cell } psCell; @@ -139,11 +139,11 @@ typedef struct psChip { - 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 + 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; @@ -164,19 +164,19 @@ 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 - - psPhotSystem *colorPlus; // /< Color reference - psPhotSystem *colorMinus; // /< Color reference - - float rmsX; // /< RMS for x transformation fits - float rmsY; // /< RMS for y transformation fits - float chi2; // /< chi^2 of astrometric solution + 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 + + psPhotSystem *colorPlus; ///< Color reference + psPhotSystem *colorMinus; ///< Color reference + + float rmsX; ///< RMS for x transformation fits + float rmsY; ///< RMS for y transformation fits + float chi2; ///< chi^2 of astrometric solution } psFPA; @@ -191,39 +191,39 @@ typedef struct psExposure { - const double ra; // /< Telescope boresight, right ascention - const double dec; // /< Telescope boresight, declination - const double hourAngle; // /< Hour angle - const double zenith; // /< Zenith distance - const double azimuth; // /< Azimuth - const double localTime; // /< Local Sidereal Time - const float date; // /< Modified Jullian Date of observation - const float rotAngle; // /< Rotator position angle - const float temperature; // /< Air temperature, for estimating refraction - const float pressure; // /< Air pressure, for calculating refraction - const float humidity; // /< Relative humidity, for refraction - const float exposureTime; // /< Exposure time + const double ra; ///< Telescope boresight, right ascention + const double dec; ///< Telescope boresight, declination + const double hourAngle; ///< Hour angle + const double zenith; ///< Zenith distance + const double azimuth; ///< Azimuth + const double localTime; ///< Local Sidereal Time + const float date; ///< Modified Jullian Date of observation + const float rotAngle; ///< Rotator position angle + const float temperature; ///< Air temperature, for estimating refraction + const float pressure; ///< Air pressure, for calculating refraction + const float humidity; ///< Relative humidity, for refraction + const float exposureTime; ///< Exposure time /* Derived quantities */ - const float positionAngle; // /< Position angle - const float parallacticAngle; // /< Parallactic angle - const float airmass; // /< Airmass, calculated from zenith distance - const float parallacticFactor; // /< Parallactic factor - const char *cameraName; // /< name of camera which provided exposure - const char *telescopeName; // /< name of telescope which provided exposure + const float positionAngle; ///< Position angle + const float parallacticAngle; ///< Parallactic angle + const float airmass; ///< Airmass, calculated from zenith distance + const float parallacticFactor; ///< Parallactic factor + const char *cameraName; ///< name of camera which provided exposure + const char *telescopeName; ///< name of telescope which provided exposure } psExposure; -psExposure *psExposureAlloc(double ra, // /< Telescope boresight, right ascention - double dec, // /< Telescope boresight, declination - double hourAngle, // /< Hour angle - double zenith, // /< Zenith distance - double azimuth, // /< Azimuth - double localTime, // /< Local Sidereal Time - float date, // /< MJD - float rotAngle, // /< Rotator position angle - float temperature, // /< Temperature - float pressure, // /< Pressure - float humidity, // /< Relative humidity - float exposureTime // /< Exposure time +psExposure *psExposureAlloc(double ra, ///< Telescope boresight, right ascention + double dec, ///< Telescope boresight, declination + double hourAngle, ///< Hour angle + double zenith, ///< Zenith distance + double azimuth, ///< Azimuth + double localTime, ///< Local Sidereal Time + float date, ///< MJD + float rotAngle, ///< Rotator position angle + float temperature, ///< Temperature + float pressure, ///< Pressure + float humidity, ///< Relative humidity + float exposureTime ///< Exposure time ); @@ -235,5 +235,5 @@ * @return psGrommit* New grommit structure. */ -psGrommit *psGrommitAlloc(const psExposure * exp // /< the cooresponding exposure structure. +psGrommit *psGrommitAlloc(const psExposure * exp ///< the cooresponding exposure structure. ); Index: /trunk/psLib/src/astronomy/psCoord.h =================================================================== --- /trunk/psLib/src/astronomy/psCoord.h (revision 1425) +++ /trunk/psLib/src/astronomy/psCoord.h (revision 1426) @@ -11,6 +11,6 @@ * @author George Gusciora, MHPCC * -* @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-07 00:06:06 $ +* @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -39,8 +39,8 @@ typedef struct { - double x; // /< x position - double y; // /< y position - double xErr; // /< Error in x position - double yErr; // /< Error in y position + double x; ///< x position + double y; ///< y position + double xErr; ///< Error in x position + double yErr; ///< Error in y position } psPlane; @@ -55,8 +55,8 @@ typedef struct { - double r; // /< RA - double d; // /< Dec - double rErr; // /< Error in RA - double dErr; // /< Error in Dec + double r; ///< RA + double d; ///< Dec + double rErr; ///< Error in RA + double dErr; ///< Error in Dec } psSphere; @@ -72,6 +72,6 @@ typedef struct { - psDPolynomial2D *x; // /< 2D polynomial transform of X coordinates - psDPolynomial2D *y; // /< 2D polynomial transform of Y coordinates + psDPolynomial2D *x; ///< 2D polynomial transform of X coordinates + psDPolynomial2D *y; ///< 2D polynomial transform of Y coordinates } psPlaneTransform; @@ -91,6 +91,6 @@ typedef struct { - psDPolynomial4D *x; // /< 4D polynomial transform of X coordinates - psDPolynomial4D *y; // /< 4D polynomial transform of Y coordinates + psDPolynomial4D *x; ///< 4D polynomial transform of X coordinates + psDPolynomial4D *y; ///< 4D polynomial transform of Y coordinates } psPlaneDistort; @@ -108,8 +108,8 @@ typedef struct { - double sinPhi; // /< sin of North Pole lattitude - double cosPhi; // /< cos of North Pole lattitude - double Xo; // /< First PT of Ares lon - double xo; // /< First PT of Ares equiv lon + double sinPhi; ///< sin of North Pole lattitude + double cosPhi; ///< cos of North Pole lattitude + double Xo; ///< First PT of Ares lon + double xo; ///< First PT of Ares equiv lon } psSphereTransform; @@ -121,12 +121,12 @@ */ typedef enum { - PS_PROJ_TAN, // /< Tangent projection - PS_PROJ_SIN, // /< Sine projection - PS_PROJ_AIT, // /< Aitoff projection - PS_PROJ_PAR, // /< Par projection - PS_PROJ_GLS, // /< GLS projection - PS_PROJ_CAR, // /< CAR projection - PS_PROJ_MER, // /< MER projection - PS_PROJ_NTYPE // /< Number of types; must be last. + PS_PROJ_TAN, ///< Tangent projection + PS_PROJ_SIN, ///< Sine projection + PS_PROJ_AIT, ///< Aitoff projection + PS_PROJ_PAR, ///< Par projection + PS_PROJ_GLS, ///< GLS projection + PS_PROJ_CAR, ///< CAR projection + PS_PROJ_MER, ///< MER projection + PS_PROJ_NTYPE ///< Number of types; must be last. } psProjectionType; @@ -138,9 +138,9 @@ typedef struct { - double R; // /< Coordinates of projection center - double D; // /< Coordinates of projection center - double Xs; // /< plate-scale in X direction - double Ys; // /< plate-scale in Y direction - psProjectionType type; // /< Projection type + double R; ///< Coordinates of projection center + double D; ///< Coordinates of projection center + double Xs; ///< plate-scale in X direction + double Ys; ///< plate-scale in Y direction + psProjectionType type; ///< Projection type } psProjection; @@ -152,6 +152,6 @@ */ typedef enum { - PS_SPHERICAL, // /< offset corresponds to an angular offset - PS_LINEAR // /< offset corresponds to a linear offset + PS_SPHERICAL, ///< offset corresponds to an angular offset + PS_LINEAR ///< offset corresponds to a linear offset } psSphereOffsetMode; @@ -162,8 +162,8 @@ */ typedef enum { - PS_ARCSEC, // /< Arcseconds - PS_ARCMIN, // /< Arcminutes - PS_DEGREE, // /< Degrees - PS_RADIAN // /< Radians + PS_ARCSEC, ///< Arcseconds + PS_ARCMIN, ///< Arcminutes + PS_DEGREE, ///< Degrees + PS_RADIAN ///< Radians } psSphereOffsetUnit; @@ -171,7 +171,7 @@ * */ -psPlane *psPlaneTransformApply(psPlane * out, // /< a psPlane to recycle. If NULL, a new one is generated. - const psPlaneTransform * transform, // /< the transform to apply - const psPlane * coords // /< the coordinate to apply the transform above. +psPlane *psPlaneTransformApply(psPlane * out, ///< a psPlane to recycle. If NULL, a new one is generated. + const psPlaneTransform * transform, ///< the transform to apply + const psPlane * coords ///< the coordinate to apply the transform above. ); @@ -179,9 +179,9 @@ * */ -psPlane *psPlaneDistortApply(psPlane * out, // /< a psPlane to recycle. If NULL, a new one is generated. - const psPlaneDistort * transform, // /< the transform to apply - const psPlane * coords, // /< the coordinate to apply the transform above. - float term3, // /< third term -- maybe magnitude - float term4 // /< forth term -- maybe color +psPlane *psPlaneDistortApply(psPlane * out, ///< a psPlane to recycle. If NULL, a new one is generated. + const psPlaneDistort * transform, ///< the transform to apply + const psPlane * coords, ///< the coordinate to apply the transform above. + float term3, ///< third term -- maybe magnitude + float term4 ///< forth term -- maybe color ); @@ -189,7 +189,7 @@ * */ -psSphereTransform *psSphereTransformAlloc(double NPlat, // /< north pole latitude - double Xo, // /< First PT of Ares lon - double xo // /< First PT of Ares equiv lon +psSphereTransform *psSphereTransformAlloc(double NPlat, ///< north pole latitude + double Xo, ///< First PT of Ares lon + double xo ///< First PT of Ares equiv lon ); @@ -197,8 +197,8 @@ * */ -psSphere *psSphereTransformApply(psSphere * out, // /< a psSphere to recycle. If NULL, a new one is +psSphere *psSphereTransformApply(psSphere * out, ///< a psSphere to recycle. If NULL, a new one is // generated. - const psSphereTransform * transform, // /< the transform to apply - const psSphere * coord // /< the coordinate to apply the transform above.x + const psSphereTransform * transform, ///< the transform to apply + const psSphere * coord ///< the coordinate to apply the transform above.x ); Index: /trunk/psLib/src/astronomy/psMetadata.h =================================================================== --- /trunk/psLib/src/astronomy/psMetadata.h (revision 1425) +++ /trunk/psLib/src/astronomy/psMetadata.h (revision 1426) @@ -11,6 +11,6 @@ * @author Ross Harman, MHPCC * -* @version $Revision: 1.16 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-07 00:06:06 $ +* @version $Revision: 1.17 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -34,16 +34,16 @@ */ typedef enum { - PS_META_ITEM_SET = 0, // /< Null. Metadata is in psMetadataItem.items - PS_META_BOOL, // /< Boolean data. - PS_META_S32, // /< Signed 32-bit integer data. - PS_META_F32, // /< Single-precision float data. - PS_META_F64, // /< Double-precision float data. - PS_META_STR, // /< String data (Stored in as void *). - PS_META_IMG, // /< Image data (Stored in as void *). - PS_META_JPEG, // /< JPEG data (Stored in as void . - PS_META_PNG, // /< PNG data (Stored in as void *). - PS_META_ASTROM, // /< Astrometric coefficients (Stored in as void *). - PS_META_UNKNOWN, // /< Other data (Stored in as void *). - PS_META_NTYPE // /< Number of types. Must be last. + PS_META_ITEM_SET = 0, ///< Null. Metadata is in psMetadataItem.items + PS_META_BOOL, ///< Boolean data. + PS_META_S32, ///< Signed 32-bit integer data. + PS_META_F32, ///< Single-precision float data. + PS_META_F64, ///< Double-precision float data. + PS_META_STR, ///< String data (Stored in as void *). + PS_META_IMG, ///< Image data (Stored in as void *). + PS_META_JPEG, ///< JPEG data (Stored in as void . + PS_META_PNG, ///< PNG data (Stored in as void *). + PS_META_ASTROM, ///< Astrometric coefficients (Stored in as void *). + PS_META_UNKNOWN, ///< Other data (Stored in as void *). + PS_META_NTYPE ///< Number of types. Must be last. } psMetadataType; @@ -55,16 +55,16 @@ typedef struct psMetadataItem { - const int id; // /< Unique ID for metadata item. - char *restrict name; // /< Name of metadata item. - psMetadataType type; // /< Type of metadata item. + const int id; ///< Unique ID for metadata item. + char *restrict name; ///< Name of metadata item. + psMetadataType type; ///< Type of metadata item. union { bool B; - psS32 S32; // /< Signed 32-bit integer data. - psF32 F32; // /< Single-precision float data. - psF64 F64; // /< Double-precision float data. - psPTR V; // /< Pointer to other type of data. - } data; // /< Union for data types. - char *comment; // /< Optional comment ("", not NULL). - psList *restrict items; // /< List of psMetadataItems with same name. + psS32 S32; ///< Signed 32-bit integer data. + psF32 F32; ///< Single-precision float data. + psF64 F64; ///< Double-precision float data. + psPTR V; ///< Pointer to other type of data. + } data; ///< Union for data types. + char *comment; ///< Optional comment ("", not NULL). + psList *restrict items; ///< List of psMetadataItems with same name. } psMetadataItem; @@ -102,8 +102,8 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataItemAlloc(const char *name, // /< Name of metadata item. - psMetadataType type, // /< Type of metadata item. - const char *comment, // /< Comment for metadata item. - ... // /< Arguments for name formatting and metadata item data. +psMetadataItem *psMetadataItemAlloc(const char *name, ///< Name of metadata item. + psMetadataType type, ///< Type of metadata item. + const char *comment, ///< Comment for metadata item. + ... ///< Arguments for name formatting and metadata item data. ); @@ -121,8 +121,8 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataItemAllocV(const char *name, // /< Name of metadata item. - psMetadataType type, // /< Type of metadata item. - const char *comment, // /< Comment for metadata item. - va_list list // /< Arguments for name formatting and metadata item +psMetadataItem *psMetadataItemAllocV(const char *name, ///< Name of metadata item. + psMetadataType type, ///< Type of metadata item. + const char *comment, ///< Comment for metadata item. + va_list list ///< Arguments for name formatting and metadata item // data. ); @@ -134,5 +134,5 @@ * @return psMetadata*: Pointer metadata. */ -psMetadata *psMetadataAlloc(void // /< Void. +psMetadata *psMetadataAlloc(void ///< Void. ); @@ -143,7 +143,7 @@ * @return bool: True for success, false for failure. */ -bool psMetadataAddItem(psMetadata * restrict md, // /< Metadata collection to insert metadat item. - int where, // /< Location to be added. - psMetadataItem * restrict item // /< Metadata item to be added. +bool psMetadataAddItem(psMetadata * restrict md, ///< Metadata collection to insert metadat item. + int where, ///< Location to be added. + psMetadataItem * restrict item ///< Metadata item to be added. ); @@ -154,10 +154,10 @@ * @return bool: True for success, false for failure. */ -bool psMetadataAdd(psMetadata * restrict md, // /< Metadata collection to insert metadat item. - int where, // /< Location to be added. - const char *name, // /< Name of metadata item. - psMetadataType type, // /< Type of metadata item. - const char *comment, // /< Comment for metadata item. - ... // /< Arguments for name formatting and metadata item data. +bool psMetadataAdd(psMetadata * restrict md, ///< Metadata collection to insert metadat item. + int where, ///< Location to be added. + const char *name, ///< Name of metadata item. + psMetadataType type, ///< Type of metadata item. + const char *comment, ///< Comment for metadata item. + ... ///< Arguments for name formatting and metadata item data. ); @@ -171,7 +171,7 @@ * @return bool: True for success, false for failure. */ -bool psMetadataRemove(psMetadata * restrict md, // /< Metadata collection to insert metadat item. - int where, // /< Location to be removed. - const char *restrict key // /< Name of metadata key. +bool psMetadataRemove(psMetadata * restrict md, ///< Metadata collection to insert metadat item. + int where, ///< Location to be removed. + const char *restrict key ///< Name of metadata key. ); @@ -183,7 +183,7 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataLookup(psMetadata * restrict md, // /< Metadata collection to insert metadat +psMetadataItem *psMetadataLookup(psMetadata * restrict md, ///< Metadata collection to insert metadat // item. - const char *restrict key // /< Name of metadata key. + const char *restrict key ///< Name of metadata key. ); @@ -194,6 +194,6 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataGet(psMetadata * restrict md, // /< Metadata collection to insert metadat item. - int where // /< Location to be retrieved. +psMetadataItem *psMetadataGet(psMetadata * restrict md, ///< Metadata collection to insert metadat item. + int where ///< Location to be retrieved. ); @@ -204,6 +204,6 @@ * @return void: void. */ -bool psMetadataSetIterator(psMetadata * restrict md, // /< Metadata collection to iterate. - int where // /< Location of iterator. +bool psMetadataSetIterator(psMetadata * restrict md, ///< Metadata collection to iterate. + int where ///< Location of iterator. ); @@ -214,7 +214,7 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataGetNext(psMetadata * restrict md, // /< Metadata collection to iterate. - const char *restrict match, // /< Beginning of key name. - int which // /< Iterator to be used. +psMetadataItem *psMetadataGetNext(psMetadata * restrict md, ///< Metadata collection to iterate. + const char *restrict match, ///< Beginning of key name. + int which ///< Iterator to be used. ); @@ -225,7 +225,7 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataGetPrevious(psMetadata * restrict md, // /< Metadata collection to iterate. - const char *restrict match, // /< Beginning of key name. - int which // /< Iterator to be used. +psMetadataItem *psMetadataGetPrevious(psMetadata * restrict md, ///< Metadata collection to iterate. + const char *restrict match, ///< Beginning of key name. + int which ///< Iterator to be used. ); @@ -240,7 +240,7 @@ * @return psMetadataItem*: Pointer metadata item. */ -void psMetadataItemPrint(FILE * fd, // /< Pointer to file to write metadata item. - const char *format, // /< Format to print metadata item. - const psMetadataItem * restrict metadataItem // /< Metadata item to print. +void psMetadataItemPrint(FILE * fd, ///< Pointer to file to write metadata item. + const char *format, ///< Format to print metadata item. + const psMetadataItem * restrict metadataItem ///< Metadata item to print. ); @@ -252,8 +252,8 @@ * @return psMetadata*: Pointer metadata. */ -psMetadata *psMetadataReadHeader(psMetadata * output, // /< Resulting metadata from read. - char *extname, // /< File name extension string. - int extnum, // /< File name extension number. Starts at 1. - char *filename // /< Name of file to read. +psMetadata *psMetadataReadHeader(psMetadata * output, ///< Resulting metadata from read. + char *extname, ///< File name extension string. + int extnum, ///< File name extension number. Starts at 1. + char *filename ///< Name of file to read. ); @@ -264,8 +264,8 @@ * @return psMetadata*: Pointer metadata. */ -psMetadata *psMetadataFReadHeader(psMetadata * output, // /< Resulting metadata from read. - char *extName, // /< File name extension string. - int extNum, // /< File name extension number. - fitsfile * fd // /< Pointer to file to read. +psMetadata *psMetadataFReadHeader(psMetadata * output, ///< Resulting metadata from read. + char *extName, ///< File name extension string. + int extNum, ///< File name extension number. + fitsfile * fd ///< Pointer to file to read. ); Index: /trunk/psLib/src/astronomy/psPhotometry.h =================================================================== --- /trunk/psLib/src/astronomy/psPhotometry.h (revision 1425) +++ /trunk/psLib/src/astronomy/psPhotometry.h (revision 1426) @@ -10,6 +10,6 @@ * @author George Gusciora, MHPCC * -* @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-07 00:06:06 $ +* @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -43,9 +43,9 @@ typedef struct { - const int ID; // /< ID number for this photometric system - const char *name; // /< Name of photometric system - const char *camera; // /< Camera for photometric system - const char *filter; // /< Filter used for photometric system - const char *detector; // /< Detector used for photometric system + const int ID; ///< ID number for this photometric system + const char *name; ///< Name of photometric system + const char *camera; ///< Camera for photometric system + const char *filter; ///< Filter used for photometric system + const char *detector; ///< Detector used for photometric system } psPhotSystem; @@ -59,13 +59,13 @@ typedef struct { - psPhotSystem src; // /< Source photometric system - psPhotSystem dst; // /< Destination photometric system - psPhotSystem pP; // /< Primary color reference - psPhotSystem pM; // /< Primary color reference - psPhotSystem sP; // /< Secondary color reference - psPhotSystem sM; // /< Secondary color reference - float pA; // /< Color offset for references - float sA; // /< Color offset for references - psPolynomial3D transform; // /< Transformation from source to destination + psPhotSystem src; ///< Source photometric system + psPhotSystem dst; ///< Destination photometric system + psPhotSystem pP; ///< Primary color reference + psPhotSystem pM; ///< Primary color reference + psPhotSystem sP; ///< Secondary color reference + psPhotSystem sM; ///< Secondary color reference + float pA; ///< Color offset for references + float sA; ///< Color offset for references + psPolynomial3D transform; ///< Transformation from source to destination } psPhotTransform; Index: /trunk/psLib/src/collections/psArray.h =================================================================== --- /trunk/psLib/src/collections/psArray.h (revision 1425) +++ /trunk/psLib/src/collections/psArray.h (revision 1426) @@ -12,6 +12,6 @@ * @author Ross Harman, MHPCC * - * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.13 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -34,7 +34,7 @@ typedef struct { - unsigned int nalloc; // /< Total number of elements available. - unsigned int n; // /< Number of elements in use. - psPTR *data; // /< An Array of pointer elements + unsigned int nalloc; ///< Total number of elements available. + unsigned int n; ///< Number of elements in use. + psPTR *data; ///< An Array of pointer elements } psArray; @@ -54,5 +54,5 @@ * */ -psArray *psArrayAlloc(unsigned int nalloc // /< Total number of elements to make available. +psArray *psArrayAlloc(unsigned int nalloc ///< Total number of elements to make available. ); @@ -65,6 +65,6 @@ * */ -psArray *psArrayRealloc(unsigned int nalloc, // /< Total number of elements to make available. - psArray * restrict psArr // /< array to reallocate. +psArray *psArrayRealloc(unsigned int nalloc, ///< Total number of elements to make available. + psArray * restrict psArr ///< array to reallocate. ); @@ -76,5 +76,5 @@ * */ -void psArrayElementFree(psArray * restrict psArr // /< Void pointer array to destroy. +void psArrayElementFree(psArray * restrict psArr ///< Void pointer array to destroy. ); Index: /trunk/psLib/src/collections/psHash.h =================================================================== --- /trunk/psLib/src/collections/psHash.h (revision 1425) +++ /trunk/psLib/src/collections/psHash.h (revision 1426) @@ -11,6 +11,6 @@ * @author George Gusciora, MHPCC * - * @version $Revision: 1.1 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-09 20:29:43 $ + * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -29,7 +29,7 @@ typedef struct psHashBucket { - char *key; // /< key for this item of data - void *data; // /< the data itself - struct psHashBucket *next; // /< list of other possible keys + char *key; ///< key for this item of data + void *data; ///< the data itself + struct psHashBucket *next; ///< list of other possible keys } psHashBucket; @@ -40,31 +40,31 @@ typedef struct psHash { - int nbucket; // /< Number of buckets in hash table. - psHashBucket **buckets; // /< The bucket data. + int nbucket; ///< Number of buckets in hash table. + psHashBucket **buckets; ///< The bucket data. } psHash; /// Allocate hash buckets in table. -psHash *psHashAlloc(int nbucket // /< The number of buckets to allocate. +psHash *psHashAlloc(int nbucket ///< The number of buckets to allocate. ); /// Insert entry into table. -bool psHashAdd(psHash * table, // /< table to insert in - const char *key, // /< key to use - void *data // /< data to insert +bool psHashAdd(psHash * table, ///< table to insert in + const char *key, ///< key to use + void *data ///< data to insert ); /// Lookup key in table. -void *psHashLookup(psHash * table, // /< table to lookup key in - const char *key // /< key to lookup +void *psHashLookup(psHash * table, ///< table to lookup key in + const char *key ///< key to lookup ); /// Remove key from table. -bool psHashRemove(psHash * table, // /< table to lookup key in - const char *key // /< key to lookup +bool psHashRemove(psHash * table, ///< table to lookup key in + const char *key ///< key to lookup ); /// List all keys in table. -psList *psHashKeyList(psHash * table // /< table to list keys from. +psList *psHashKeyList(psHash * table ///< table to list keys from. ); Index: /trunk/psLib/src/collections/psList.h =================================================================== --- /trunk/psLib/src/collections/psList.h (revision 1425) +++ /trunk/psLib/src/collections/psList.h (revision 1426) @@ -10,6 +10,6 @@ * @ingroup LinkedList * - * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -33,10 +33,10 @@ */ enum { - PS_LIST_HEAD = 0, // /< at head - PS_LIST_TAIL = -1, // /< at tail - PS_LIST_PREVIOUS = -2, // /< previous element - PS_LIST_CURRENT = -3, // /< current element - PS_LIST_NEXT = -4, // /< next element - PS_LIST_UNKNOWN = -5 // /< unknown position (should be last in enum list) + PS_LIST_HEAD = 0, ///< at head + PS_LIST_TAIL = -1, ///< at tail + PS_LIST_PREVIOUS = -2, ///< previous element + PS_LIST_CURRENT = -3, ///< current element + PS_LIST_NEXT = -4, ///< next element + PS_LIST_UNKNOWN = -5 ///< unknown position (should be last in enum list) }; @@ -44,7 +44,7 @@ typedef struct psListElem { - struct psListElem *prev; // /< previous link in list - struct psListElem *next; // /< next link in list - void *data; // /< real data item + struct psListElem *prev; ///< previous link in list + struct psListElem *next; ///< next link in list + void *data; ///< real data item } psListElem; @@ -57,10 +57,10 @@ typedef struct { - unsigned int size; // /< number of elements on list - psListElem *head; // /< first element on list (may be NULL) - psListElem *tail; // /< last element on list (may be NULL) - psListElem *iter; // /< iteration cursor - unsigned int iterIndex; // /< the numeric position of the iteration cursor in the list - pthread_mutex_t lock; // /< mutex to lock a node during changes + unsigned int size; ///< number of elements on list + psListElem *head; ///< first element on list (may be NULL) + psListElem *tail; ///< last element on list (may be NULL) + psListElem *iter; ///< iteration cursor + unsigned int iterIndex; ///< the numeric position of the iteration cursor in the list + pthread_mutex_t lock; ///< mutex to lock a node during changes } psList; @@ -71,5 +71,5 @@ */ psList *psListAlloc(void *data - // /< initial data item; may be NULL if no an empty psList is desired + ///< initial data item; may be NULL if no an empty psList is desired ) ; @@ -80,7 +80,7 @@ * NULL, the return value will also be NULL. */ -bool psListAdd(psList * restrict list, // /< list to add to (if NULL, nothing is done) - void *data, // /< data item to add. If NULL, list is not modified. - int where // /< index, PS_LIST_HEAD, PS_LIST_TAIL, or numbered location. +bool psListAdd(psList * restrict list, ///< list to add to (if NULL, nothing is done) + void *data, ///< data item to add. If NULL, list is not modified. + int where ///< index, PS_LIST_HEAD, PS_LIST_TAIL, or numbered location. ); @@ -90,9 +90,9 @@ */ bool psListRemove(psList * restrict list, - // /< list to remove element from + ///< list to remove element from void *data, - // /< if which is PS_LIST_UNKNOWN, data item to find and remove, otherwise this is ignored. + ///< if which is PS_LIST_UNKNOWN, data item to find and remove, otherwise this is ignored. int which - // /< index of item, or PS_LIST_UNKNOWN, PS_LIST_NEXT, PS_LIST_PREV, or numbered location. + ///< index of item, or PS_LIST_UNKNOWN, PS_LIST_NEXT, PS_LIST_PREV, or numbered location. ); @@ -104,6 +104,6 @@ * NULL is returned. */ -void *psListGet(psList * restrict list, // /< list to retrieve element from - int which // /< index number, or PS_LIST_NEXT, PS_LIST_PREV, PS_LIST_UNKNOWN +void *psListGet(psList * restrict list, ///< list to retrieve element from + int which ///< index number, or PS_LIST_NEXT, PS_LIST_PREV, PS_LIST_UNKNOWN ); @@ -112,6 +112,6 @@ * */ -void psListSetIterator(psList * restrict list, // /< list to retrieve element from - int where // /< index number, PS_LIST_HEAD, or PS_LIST_TAIL +void psListSetIterator(psList * restrict list, ///< list to retrieve element from + int where ///< index number, PS_LIST_HEAD, or PS_LIST_TAIL ); @@ -123,5 +123,5 @@ * parameter was NULL. */ -void *psListGetNext(psList * restrict list // /< list to retrieve element from +void *psListGetNext(psList * restrict list ///< list to retrieve element from ); @@ -133,5 +133,5 @@ * iterator is not valid or list parameter was NULL. */ -void *psListGetCurrent(psList * restrict list // /< list to retrieve element from +void *psListGetCurrent(psList * restrict list ///< list to retrieve element from ); @@ -143,5 +143,5 @@ * parameter was NULL. */ -void *psListGetPrevious(psList * restrict list // /< list to retrieve element from +void *psListGetPrevious(psList * restrict list ///< list to retrieve element from ); @@ -151,5 +151,5 @@ * or NULL if the given dlist parameter is NULL. */ -psArray *psListToArray(psList * dlist // /< List to convert +psArray *psListToArray(psList * dlist ///< List to convert ); @@ -159,5 +159,5 @@ * or NULL is the given arr parameter is NULL. */ -psList *psArrayToList(psArray * arr // /< vector to convert +psList *psArrayToList(psArray * arr ///< vector to convert ); Index: /trunk/psLib/src/collections/psMetadata.h =================================================================== --- /trunk/psLib/src/collections/psMetadata.h (revision 1425) +++ /trunk/psLib/src/collections/psMetadata.h (revision 1426) @@ -11,6 +11,6 @@ * @author Ross Harman, MHPCC * -* @version $Revision: 1.16 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-07 00:06:06 $ +* @version $Revision: 1.17 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -34,16 +34,16 @@ */ typedef enum { - PS_META_ITEM_SET = 0, // /< Null. Metadata is in psMetadataItem.items - PS_META_BOOL, // /< Boolean data. - PS_META_S32, // /< Signed 32-bit integer data. - PS_META_F32, // /< Single-precision float data. - PS_META_F64, // /< Double-precision float data. - PS_META_STR, // /< String data (Stored in as void *). - PS_META_IMG, // /< Image data (Stored in as void *). - PS_META_JPEG, // /< JPEG data (Stored in as void . - PS_META_PNG, // /< PNG data (Stored in as void *). - PS_META_ASTROM, // /< Astrometric coefficients (Stored in as void *). - PS_META_UNKNOWN, // /< Other data (Stored in as void *). - PS_META_NTYPE // /< Number of types. Must be last. + PS_META_ITEM_SET = 0, ///< Null. Metadata is in psMetadataItem.items + PS_META_BOOL, ///< Boolean data. + PS_META_S32, ///< Signed 32-bit integer data. + PS_META_F32, ///< Single-precision float data. + PS_META_F64, ///< Double-precision float data. + PS_META_STR, ///< String data (Stored in as void *). + PS_META_IMG, ///< Image data (Stored in as void *). + PS_META_JPEG, ///< JPEG data (Stored in as void . + PS_META_PNG, ///< PNG data (Stored in as void *). + PS_META_ASTROM, ///< Astrometric coefficients (Stored in as void *). + PS_META_UNKNOWN, ///< Other data (Stored in as void *). + PS_META_NTYPE ///< Number of types. Must be last. } psMetadataType; @@ -55,16 +55,16 @@ typedef struct psMetadataItem { - const int id; // /< Unique ID for metadata item. - char *restrict name; // /< Name of metadata item. - psMetadataType type; // /< Type of metadata item. + const int id; ///< Unique ID for metadata item. + char *restrict name; ///< Name of metadata item. + psMetadataType type; ///< Type of metadata item. union { bool B; - psS32 S32; // /< Signed 32-bit integer data. - psF32 F32; // /< Single-precision float data. - psF64 F64; // /< Double-precision float data. - psPTR V; // /< Pointer to other type of data. - } data; // /< Union for data types. - char *comment; // /< Optional comment ("", not NULL). - psList *restrict items; // /< List of psMetadataItems with same name. + psS32 S32; ///< Signed 32-bit integer data. + psF32 F32; ///< Single-precision float data. + psF64 F64; ///< Double-precision float data. + psPTR V; ///< Pointer to other type of data. + } data; ///< Union for data types. + char *comment; ///< Optional comment ("", not NULL). + psList *restrict items; ///< List of psMetadataItems with same name. } psMetadataItem; @@ -102,8 +102,8 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataItemAlloc(const char *name, // /< Name of metadata item. - psMetadataType type, // /< Type of metadata item. - const char *comment, // /< Comment for metadata item. - ... // /< Arguments for name formatting and metadata item data. +psMetadataItem *psMetadataItemAlloc(const char *name, ///< Name of metadata item. + psMetadataType type, ///< Type of metadata item. + const char *comment, ///< Comment for metadata item. + ... ///< Arguments for name formatting and metadata item data. ); @@ -121,8 +121,8 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataItemAllocV(const char *name, // /< Name of metadata item. - psMetadataType type, // /< Type of metadata item. - const char *comment, // /< Comment for metadata item. - va_list list // /< Arguments for name formatting and metadata item +psMetadataItem *psMetadataItemAllocV(const char *name, ///< Name of metadata item. + psMetadataType type, ///< Type of metadata item. + const char *comment, ///< Comment for metadata item. + va_list list ///< Arguments for name formatting and metadata item // data. ); @@ -134,5 +134,5 @@ * @return psMetadata*: Pointer metadata. */ -psMetadata *psMetadataAlloc(void // /< Void. +psMetadata *psMetadataAlloc(void ///< Void. ); @@ -143,7 +143,7 @@ * @return bool: True for success, false for failure. */ -bool psMetadataAddItem(psMetadata * restrict md, // /< Metadata collection to insert metadat item. - int where, // /< Location to be added. - psMetadataItem * restrict item // /< Metadata item to be added. +bool psMetadataAddItem(psMetadata * restrict md, ///< Metadata collection to insert metadat item. + int where, ///< Location to be added. + psMetadataItem * restrict item ///< Metadata item to be added. ); @@ -154,10 +154,10 @@ * @return bool: True for success, false for failure. */ -bool psMetadataAdd(psMetadata * restrict md, // /< Metadata collection to insert metadat item. - int where, // /< Location to be added. - const char *name, // /< Name of metadata item. - psMetadataType type, // /< Type of metadata item. - const char *comment, // /< Comment for metadata item. - ... // /< Arguments for name formatting and metadata item data. +bool psMetadataAdd(psMetadata * restrict md, ///< Metadata collection to insert metadat item. + int where, ///< Location to be added. + const char *name, ///< Name of metadata item. + psMetadataType type, ///< Type of metadata item. + const char *comment, ///< Comment for metadata item. + ... ///< Arguments for name formatting and metadata item data. ); @@ -171,7 +171,7 @@ * @return bool: True for success, false for failure. */ -bool psMetadataRemove(psMetadata * restrict md, // /< Metadata collection to insert metadat item. - int where, // /< Location to be removed. - const char *restrict key // /< Name of metadata key. +bool psMetadataRemove(psMetadata * restrict md, ///< Metadata collection to insert metadat item. + int where, ///< Location to be removed. + const char *restrict key ///< Name of metadata key. ); @@ -183,7 +183,7 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataLookup(psMetadata * restrict md, // /< Metadata collection to insert metadat +psMetadataItem *psMetadataLookup(psMetadata * restrict md, ///< Metadata collection to insert metadat // item. - const char *restrict key // /< Name of metadata key. + const char *restrict key ///< Name of metadata key. ); @@ -194,6 +194,6 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataGet(psMetadata * restrict md, // /< Metadata collection to insert metadat item. - int where // /< Location to be retrieved. +psMetadataItem *psMetadataGet(psMetadata * restrict md, ///< Metadata collection to insert metadat item. + int where ///< Location to be retrieved. ); @@ -204,6 +204,6 @@ * @return void: void. */ -bool psMetadataSetIterator(psMetadata * restrict md, // /< Metadata collection to iterate. - int where // /< Location of iterator. +bool psMetadataSetIterator(psMetadata * restrict md, ///< Metadata collection to iterate. + int where ///< Location of iterator. ); @@ -214,7 +214,7 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataGetNext(psMetadata * restrict md, // /< Metadata collection to iterate. - const char *restrict match, // /< Beginning of key name. - int which // /< Iterator to be used. +psMetadataItem *psMetadataGetNext(psMetadata * restrict md, ///< Metadata collection to iterate. + const char *restrict match, ///< Beginning of key name. + int which ///< Iterator to be used. ); @@ -225,7 +225,7 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataGetPrevious(psMetadata * restrict md, // /< Metadata collection to iterate. - const char *restrict match, // /< Beginning of key name. - int which // /< Iterator to be used. +psMetadataItem *psMetadataGetPrevious(psMetadata * restrict md, ///< Metadata collection to iterate. + const char *restrict match, ///< Beginning of key name. + int which ///< Iterator to be used. ); @@ -240,7 +240,7 @@ * @return psMetadataItem*: Pointer metadata item. */ -void psMetadataItemPrint(FILE * fd, // /< Pointer to file to write metadata item. - const char *format, // /< Format to print metadata item. - const psMetadataItem * restrict metadataItem // /< Metadata item to print. +void psMetadataItemPrint(FILE * fd, ///< Pointer to file to write metadata item. + const char *format, ///< Format to print metadata item. + const psMetadataItem * restrict metadataItem ///< Metadata item to print. ); @@ -252,8 +252,8 @@ * @return psMetadata*: Pointer metadata. */ -psMetadata *psMetadataReadHeader(psMetadata * output, // /< Resulting metadata from read. - char *extname, // /< File name extension string. - int extnum, // /< File name extension number. Starts at 1. - char *filename // /< Name of file to read. +psMetadata *psMetadataReadHeader(psMetadata * output, ///< Resulting metadata from read. + char *extname, ///< File name extension string. + int extnum, ///< File name extension number. Starts at 1. + char *filename ///< Name of file to read. ); @@ -264,8 +264,8 @@ * @return psMetadata*: Pointer metadata. */ -psMetadata *psMetadataFReadHeader(psMetadata * output, // /< Resulting metadata from read. - char *extName, // /< File name extension string. - int extNum, // /< File name extension number. - fitsfile * fd // /< Pointer to file to read. +psMetadata *psMetadataFReadHeader(psMetadata * output, ///< Resulting metadata from read. + char *extName, ///< File name extension string. + int extNum, ///< File name extension number. + fitsfile * fd ///< Pointer to file to read. ); Index: /trunk/psLib/src/collections/psScalar.h =================================================================== --- /trunk/psLib/src/collections/psScalar.h (revision 1425) +++ /trunk/psLib/src/collections/psScalar.h (revision 1426) @@ -11,6 +11,6 @@ * @author Ross Harman, MHPCC * - * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -32,20 +32,20 @@ typedef struct { - psType type; // /< Type of data. + psType type; ///< Type of data. union { - psU8 U8; // /< Unsigned 8-bit integer data. - psU16 U16; // /< Unsigned 16-bit integer data. - psU32 U32; // /< Unsigned 32-bit integer data. - psU64 U64; // /< Unsigned 64-bit integer data. - psS8 S8; // /< Signed 8-bit integer data. - psS16 S16; // /< Signed 16-bit integer data. - psS32 S32; // /< Signed 32-bit integer data. - psS64 S64; // /< Signed 64-bit integer data. - psF32 F32; // /< Single-precision float data. - psF64 F64; // /< Double-precision float data. - psC32 C32; // /< Single-precision complex data. - psC64 C64; // /< Double-precision complex data. - } data; // /< Union for data types. + psU8 U8; ///< Unsigned 8-bit integer data. + psU16 U16; ///< Unsigned 16-bit integer data. + psU32 U32; ///< Unsigned 32-bit integer data. + psU64 U64; ///< Unsigned 64-bit integer data. + psS8 S8; ///< Signed 8-bit integer data. + psS16 S16; ///< Signed 16-bit integer data. + psS32 S32; ///< Signed 32-bit integer data. + psS64 S64; ///< Signed 64-bit integer data. + psF32 F32; ///< Single-precision float data. + psF64 F64; ///< Double-precision float data. + psC32 C32; ///< Single-precision complex data. + psC64 C64; ///< Double-precision complex data. + } data; ///< Union for data types. } psScalar; @@ -65,6 +65,6 @@ * */ -psScalar *psScalarAlloc(psC64 value, // /< Data to be put into psScalar. - psElemType dataType // /< Type of data to be held by psScalar. +psScalar *psScalarAlloc(psC64 value, ///< Data to be put into psScalar. + psElemType dataType ///< Type of data to be held by psScalar. ); @@ -76,5 +76,5 @@ * */ -void psScalarFree(psScalar * restrict scalar // /< Scalar to free. +void psScalarFree(psScalar * restrict scalar ///< Scalar to free. ); Index: /trunk/psLib/src/collections/psVector.h =================================================================== --- /trunk/psLib/src/collections/psVector.h (revision 1425) +++ /trunk/psLib/src/collections/psVector.h (revision 1426) @@ -12,6 +12,6 @@ * @author Ross Harman, MHPCC * - * @version $Revision: 1.16 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.17 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -33,23 +33,23 @@ typedef struct { - psType type; // /< Type of data. - unsigned int nalloc; // /< Total number of elements available. - unsigned int n; // /< Number of elements in use. + psType type; ///< Type of data. + unsigned int nalloc; ///< Total number of elements available. + unsigned int n; ///< Number of elements in use. union { - psU8 *U8; // /< Unsigned 8-bit integer data. - psU16 *U16; // /< Unsigned 16-bit integer data. - psU32 *U32; // /< Unsigned 32-bit integer data. - psU64 *U64; // /< Unsigned 64-bit integer data. - psS8 *S8; // /< Signed 8-bit integer data. - psS16 *S16; // /< Signed 16-bit integer data. - psS32 *S32; // /< Signed 32-bit integer data. - psS64 *S64; // /< Signed 64-bit integer data. - psF32 *F32; // /< Single-precision float data. - psF64 *F64; // /< Double-precision float data. - psC32 *C32; // /< Single-precision complex data. - psC64 *C64; // /< Double-precision complex data. - psPTR V; // /< Pointer to data. - } data; // /< Union for data types. + psU8 *U8; ///< Unsigned 8-bit integer data. + psU16 *U16; ///< Unsigned 16-bit integer data. + psU32 *U32; ///< Unsigned 32-bit integer data. + psU64 *U64; ///< Unsigned 64-bit integer data. + psS8 *S8; ///< Signed 8-bit integer data. + psS16 *S16; ///< Signed 16-bit integer data. + psS32 *S32; ///< Signed 32-bit integer data. + psS64 *S64; ///< Signed 64-bit integer data. + psF32 *F32; ///< Single-precision float data. + psF64 *F64; ///< Double-precision float data. + psC32 *C32; ///< Single-precision complex data. + psC64 *C64; ///< Double-precision complex data. + psPTR V; ///< Pointer to data. + } data; ///< Union for data types. } psVector; @@ -68,6 +68,6 @@ * */ -psVector *psVectorAlloc(unsigned int nalloc, // /< Total number of elements to make available. - psElemType dataType // /< Type of data to be held by vector. +psVector *psVectorAlloc(unsigned int nalloc, ///< Total number of elements to make available. + psElemType dataType ///< Type of data to be held by vector. ); @@ -80,6 +80,6 @@ * */ -psVector *psVectorRealloc(unsigned int nalloc, // /< Total number of elements to make available. - psVector * restrict psVec // /< Vector to reallocate. +psVector *psVectorRealloc(unsigned int nalloc, ///< Total number of elements to make available. + psVector * restrict psVec ///< Vector to reallocate. ); @@ -93,8 +93,8 @@ */ psVector *psVectorRecycle(psVector * restrict psVec, - // /< Vector to recycle. If NULL, a new vector is created. No effort taken to + ///< Vector to recycle. If NULL, a new vector is created. No effort taken to // preserve the values. - unsigned int nalloc, // /< Total number of elements to make available. - psElemType type // /< the datatype of the returned vector + unsigned int nalloc, ///< Total number of elements to make available. + psElemType type ///< the datatype of the returned vector ); @@ -107,7 +107,7 @@ */ -psVector *psVectorSort(psVector * restrict outVector, // /< the output vector to recycle, or NULL if new +psVector *psVectorSort(psVector * restrict outVector, ///< the output vector to recycle, or NULL if new // vector desired. - const psVector * restrict inVector // /< the vector to sort. + const psVector * restrict inVector ///< the vector to sort. ); Index: /trunk/psLib/src/dataManip/psFFT.h =================================================================== --- /trunk/psLib/src/dataManip/psFFT.h (revision 1425) +++ /trunk/psLib/src/dataManip/psFFT.h (revision 1426) @@ -8,6 +8,6 @@ * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.9 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -29,5 +29,5 @@ PS_FFT_FORWARD = (-1), - // /< psImageFFT/psVectorFFT should perform a reverse FFT. + ///< psImageFFT/psVectorFFT should perform a reverse FFT. PS_FFT_REVERSE = (+1) } psFftDirection; Index: /trunk/psLib/src/dataManip/psFunctions.h =================================================================== --- /trunk/psLib/src/dataManip/psFunctions.h (revision 1425) +++ /trunk/psLib/src/dataManip/psFunctions.h (revision 1426) @@ -13,6 +13,6 @@ * @author George Gusciora, MHPCC * -* @version $Revision: 1.15 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-07 00:06:06 $ +* @version $Revision: 1.16 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -34,23 +34,23 @@ evaluated Gaussian is: \f[ exp(-\frac{(x-mean)^2}{2\sigma^2}) \f] */ -float psGaussian(float x, // /< Value at which to evaluate - float mean, // /< Mean for the Gaussian - float stddev, // /< Standard deviation for the Gaussian - bool normal // /< Indicates whether result should be normalized +float psGaussian(float x, ///< Value at which to evaluate + float mean, ///< Mean for the Gaussian + float stddev, ///< Standard deviation for the Gaussian + bool normal ///< Indicates whether result should be normalized ); /** Produce a vector of random numbers from a Gaussian distribution with the specified mean and sigma */ -psVector *psGaussianDev(float mean, // /< The mean of the Gaussian - float sigma, // /< The sigma of the Gaussian - int Npts); // /< The size of the vector +psVector *psGaussianDev(float mean, ///< The mean of the Gaussian + float sigma, ///< The sigma of the Gaussian + int Npts); ///< The size of the vector /** One-dimensional polynomial */ typedef struct { - int n; // /< Number of terms - float *coeff; // /< Coefficients - float *coeffErr; // /< Error in coefficients - char *mask; // /< Coefficient mask + int n; ///< Number of terms + float *coeff; ///< Coefficients + float *coeffErr; ///< Error in coefficients + char *mask; ///< Coefficient mask } psPolynomial1D; @@ -60,8 +60,8 @@ { int nX, - nY; // /< Number of terms in x and y - float **coeff; // /< Coefficients - float **coeffErr; // /< Error in coefficients - char **mask; // /< Coefficients mask + nY; ///< Number of terms in x and y + float **coeff; ///< Coefficients + float **coeffErr; ///< Error in coefficients + char **mask; ///< Coefficients mask } psPolynomial2D; @@ -72,8 +72,8 @@ int nX, nY, - nZ; // /< Number of terms in x, y and z - float ***coeff; // /< Coefficients - float ***coeffErr; // /< Error in coefficients - char ***mask; // /< Coefficients mask + nZ; ///< Number of terms in x, y and z + float ***coeff; ///< Coefficients + float ***coeffErr; ///< Error in coefficients + char ***mask; ///< Coefficients mask } psPolynomial3D; @@ -85,8 +85,8 @@ nX, nY, - nZ; // /< Number of terms in w, x, y and z - float ****coeff; // /< Coefficients - float ****coeffErr; // /< Error in coefficients - char ****mask; // /< Coefficients mask + nZ; ///< Number of terms in w, x, y and z + float ****coeff; ///< Coefficients + float ****coeffErr; ///< Error in coefficients + char ****mask; ///< Coefficients mask } psPolynomial4D; @@ -95,44 +95,44 @@ /** Constructor */ -psPolynomial1D *psPolynomial1DAlloc(int n // /< Number of terms - ); - -/** Constructor */ -psPolynomial2D *psPolynomial2DAlloc(int nX, int nY // /< Number of terms in x and y - ); - -/** Constructor */ -psPolynomial3D *psPolynomial3DAlloc(int nX, int nY, int nZ // /< Number of terms in x, y and z - ); - -/** Constructor */ -psPolynomial4D *psPolynomial4DAlloc(int nW, int nX, int nY, int nZ // /< Number of terms in w, x, y and +psPolynomial1D *psPolynomial1DAlloc(int n ///< Number of terms + ); + +/** Constructor */ +psPolynomial2D *psPolynomial2DAlloc(int nX, int nY ///< Number of terms in x and y + ); + +/** Constructor */ +psPolynomial3D *psPolynomial3DAlloc(int nX, int nY, int nZ ///< Number of terms in x, y and z + ); + +/** Constructor */ +psPolynomial4D *psPolynomial4DAlloc(int nW, int nX, int nY, int nZ ///< Number of terms in w, x, y and // z ); /** Evaluate 1D polynomial */ -float psPolynomial1DEval(float x, // /< Value at which to evaluate - const psPolynomial1D * myPoly // /< Coefficients for the polynomial +float psPolynomial1DEval(float x, ///< Value at which to evaluate + const psPolynomial1D * myPoly ///< Coefficients for the polynomial ); /** Evaluate 2D polynomial */ -float psPolynomial2DEval(float x, // /< Value x at which to evaluate - float y, // /< Value y at which to evaluate - const psPolynomial2D * myPoly // /< Coefficients for the polynomial +float psPolynomial2DEval(float x, ///< Value x at which to evaluate + float y, ///< Value y at which to evaluate + const psPolynomial2D * myPoly ///< Coefficients for the polynomial ); /** Evaluate 3D polynomial */ -float psPolynomial3DEval(float x, // /< Value x at which to evaluate - float y, // /< Value y at which to evaluate - float z, // /< Value z at which to evaluate - const psPolynomial3D * myPoly // /< Coefficients for the polynomial +float psPolynomial3DEval(float x, ///< Value x at which to evaluate + float y, ///< Value y at which to evaluate + float z, ///< Value z at which to evaluate + const psPolynomial3D * myPoly ///< Coefficients for the polynomial ); /** Evaluate 4D polynomial */ -float psPolynomial4DEval(float w, // /< Value w at which to evaluate - float x, // /< Value x at which to evaluate - float y, // /< Value y at which to evaluate - float z, // /< Value z at which to evaluate - const psPolynomial4D * myPoly // /< Coefficients for the polynomial +float psPolynomial4DEval(float w, ///< Value w at which to evaluate + float x, ///< Value x at which to evaluate + float y, ///< Value y at which to evaluate + float z, ///< Value z at which to evaluate + const psPolynomial4D * myPoly ///< Coefficients for the polynomial ); @@ -144,8 +144,8 @@ typedef struct { - int n; // /< Number of terms - double *coeff; // /< Coefficients - double *coeffErr; // /< Error in coefficients - char *mask; // /< Coefficient mask + int n; ///< Number of terms + double *coeff; ///< Coefficients + double *coeffErr; ///< Error in coefficients + char *mask; ///< Coefficient mask } psDPolynomial1D; @@ -155,8 +155,8 @@ { int nX, - nY; // /< Number of terms in x and y - double **coeff; // /< Coefficients - double **coeffErr; // /< Error in coefficients - char **mask; // /< Coefficients mask + nY; ///< Number of terms in x and y + double **coeff; ///< Coefficients + double **coeffErr; ///< Error in coefficients + char **mask; ///< Coefficients mask } psDPolynomial2D; @@ -167,8 +167,8 @@ int nX, nY, - nZ; // /< Number of terms in x, y and z - double ***coeff; // /< Coefficients - double ***coeffErr; // /< Error in coefficients - char ***mask; // /< Coefficient mask + nZ; ///< Number of terms in x, y and z + double ***coeff; ///< Coefficients + double ***coeffErr; ///< Error in coefficients + char ***mask; ///< Coefficient mask } psDPolynomial3D; @@ -180,52 +180,52 @@ nX, nY, - nZ; // /< Number of terms in w, x, y and z - double ****coeff; // /< Coefficients - double ****coeffErr; // /< Error in coefficients - char ****mask; // /< Coefficients mask + nZ; ///< Number of terms in w, x, y and z + double ****coeff; ///< Coefficients + double ****coeffErr; ///< Error in coefficients + char ****mask; ///< Coefficients mask } psDPolynomial4D; /** Constructor */ -psDPolynomial1D *psDPolynomial1DAlloc(int n // /< Number of terms - ); - -/** Constructor */ -psDPolynomial2D *psDPolynomial2DAlloc(int nX, int nY // /< Number of terms in x and y - ); - -/** Constructor */ -psDPolynomial3D *psDPolynomial3DAlloc(int nX, int nY, int nZ // /< Number of terms in x, y and z - ); - -/** Constructor */ -psDPolynomial4D *psDPolynomial4DAlloc(int nW, int nX, int nY, int nZ // /< Number of terms in w, x, y and +psDPolynomial1D *psDPolynomial1DAlloc(int n ///< Number of terms + ); + +/** Constructor */ +psDPolynomial2D *psDPolynomial2DAlloc(int nX, int nY ///< Number of terms in x and y + ); + +/** Constructor */ +psDPolynomial3D *psDPolynomial3DAlloc(int nX, int nY, int nZ ///< Number of terms in x, y and z + ); + +/** Constructor */ +psDPolynomial4D *psDPolynomial4DAlloc(int nW, int nX, int nY, int nZ ///< Number of terms in w, x, y and // z ); /** Evaluate 1D polynomial (double precision) */ -double psDPolynomial1DEval(double x, // /< Value at which to evaluate - const psDPolynomial1D * myPoly // /< Coefficients for the polynomial +double psDPolynomial1DEval(double x, ///< Value at which to evaluate + const psDPolynomial1D * myPoly ///< Coefficients for the polynomial ); /** Evaluate 2D polynomial (double precision) */ -double psDPolynomial2DEval(double x, // /< Value x at which to evaluate - double y, // /< Value y at which to evaluate - const psDPolynomial2D * myPoly // /< Coefficients for the polynomial +double psDPolynomial2DEval(double x, ///< Value x at which to evaluate + double y, ///< Value y at which to evaluate + const psDPolynomial2D * myPoly ///< Coefficients for the polynomial ); /** Evaluate 3D polynomial (double precision) */ -double psDPolynomial3DEval(double x, // /< Value x at which to evaluate - double y, // /< Value y at which to evaluate - double z, // /< Value z at which to evaluate - const psDPolynomial3D * myPoly // /< Coefficients for the polynomial +double psDPolynomial3DEval(double x, ///< Value x at which to evaluate + double y, ///< Value y at which to evaluate + double z, ///< Value z at which to evaluate + const psDPolynomial3D * myPoly ///< Coefficients for the polynomial ); /** Evaluate 4D polynomial (double precision) */ -double psDPolynomial4DEval(double w, // /< Value w at which to evaluate - double x, // /< Value x at which to evaluate - double y, // /< Value y at which to evaluate - double z, // /< Value z at which to evaluate - const psDPolynomial4D * myPoly // /< Coefficients for the polynomial +double psDPolynomial4DEval(double w, ///< Value w at which to evaluate + double x, ///< Value x at which to evaluate + double y, ///< Value y at which to evaluate + double z, ///< Value z at which to evaluate + const psDPolynomial4D * myPoly ///< Coefficients for the polynomial ); Index: /trunk/psLib/src/dataManip/psMatrix.h =================================================================== --- /trunk/psLib/src/dataManip/psMatrix.h (revision 1425) +++ /trunk/psLib/src/dataManip/psMatrix.h (revision 1426) @@ -22,6 +22,6 @@ * @author Ross Harman, MHPCC * - * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -43,7 +43,7 @@ * @return psImage*: Pointer to LU decomposed psImage. */ -psImage *psMatrixLUD(psImage * outImage, // /< Image to return, or NULL. - psVector * outPerm, // /< Output permutation vector used by psMatrixLUSolve. - psImage * inImage // /< Image to decompose. +psImage *psMatrixLUD(psImage * outImage, ///< Image to return, or NULL. + psVector * outPerm, ///< Output permutation vector used by psMatrixLUSolve. + psImage * inImage ///< Image to decompose. ); @@ -57,8 +57,8 @@ * @return psVector*: Pointer to psVector solution of matrix equation. */ -psVector *psMatrixLUSolve(psVector * outVector, // /< Vector to return, or NULL. - const psImage * luImage, // /< LU-decomposed matrix. - const psVector * inVector, // /< Vector right-hand-side of equation. - const psVector * inPerm // /< Permutation vector resulting from psMatrixLUD +psVector *psMatrixLUSolve(psVector * outVector, ///< Vector to return, or NULL. + const psImage * luImage, ///< LU-decomposed matrix. + const psVector * inVector, ///< Vector right-hand-side of equation. + const psVector * inPerm ///< Permutation vector resulting from psMatrixLUD // function. ); @@ -73,7 +73,7 @@ * @return psImage*: Pointer to inverted psImage. */ -psImage *psMatrixInvert(psImage * outImage, // /< Image to return, or NULL for in-place substitution. - const psImage * inImage, // /< Image to be inverted - float *restrict det // /< Determinant to return, or NULL +psImage *psMatrixInvert(psImage * outImage, ///< Image to return, or NULL for in-place substitution. + const psImage * inImage, ///< Image to be inverted + float *restrict det ///< Determinant to return, or NULL ); @@ -86,5 +86,5 @@ * @return float: Determinant from psImage. */ -float *psMatrixDeterminant(const psImage * restrict inMatrix // /< Image used to calculate determinant. +float *psMatrixDeterminant(const psImage * restrict inMatrix ///< Image used to calculate determinant. ); @@ -98,7 +98,7 @@ * @return psImage*: Pointer to resulting psImage. */ -psImage *psMatrixMultiply(psImage * outImage, // /< Matrix to return, or NULL. - psImage * inImage1, // /< First input image. - psImage * inImage2 // /< Second input image. +psImage *psMatrixMultiply(psImage * outImage, ///< Matrix to return, or NULL. + psImage * inImage1, ///< First input image. + psImage * inImage2 ///< Second input image. ); @@ -112,6 +112,6 @@ * @return psImage*: Pointer to transposed psImage. */ -psImage *psMatrixTranspose(psImage * outImage, // /< Image to return, or NULL - const psImage * inImage // /< Image to transpose +psImage *psMatrixTranspose(psImage * outImage, ///< Image to return, or NULL + const psImage * inImage ///< Image to transpose ); @@ -124,6 +124,6 @@ * @return psImage*: Pointer to matrix of Eigenvectors. */ -psImage *psMatrixEigenvectors(psImage * outImage, // /< Eigenvectors to return, or NULL. - psImage * inImage // /< Input image. +psImage *psMatrixEigenvectors(psImage * outImage, ///< Eigenvectors to return, or NULL. + psImage * inImage ///< Input image. ); @@ -137,6 +137,6 @@ * @return psVector*: Pointer to psVector. */ -psVector *psMatrixToVector(psVector * outVector, // /< Vector to return, or NULL. - psImage * inImage // /< Image to convert. +psVector *psMatrixToVector(psVector * outVector, ///< Vector to return, or NULL. + psImage * inImage ///< Image to convert. ); @@ -150,6 +150,6 @@ * @return psVector*: Pointer to psIamge. */ -psImage *psVectorToMatrix(psImage * outImage, // /< Matrix to return, or NULL. - psVector * inVector // /< Vector to convert. +psImage *psVectorToMatrix(psImage * outImage, ///< Matrix to return, or NULL. + psVector * inVector ///< Vector to convert. ); Index: /trunk/psLib/src/dataManip/psMinimize.h =================================================================== --- /trunk/psLib/src/dataManip/psMinimize.h (revision 1425) +++ /trunk/psLib/src/dataManip/psMinimize.h (revision 1426) @@ -22,5 +22,5 @@ /** Minimize chi^2 for input data */ -psVector *psMinimizeChi2(float (*evalModel) (const psVector * restrict, const psVector * restrict), // /< +psVector *psMinimizeChi2(float (*evalModel) (const psVector * restrict, const psVector * restrict), ///< // Model // to @@ -29,5 +29,5 @@ // and // params) - float (*DevalModel) (const psVector * restrict, const psVector * restrict, int), // /< + float (*DevalModel) (const psVector * restrict, const psVector * restrict, int), ///< // Derivative // of @@ -38,19 +38,19 @@ // and // params) - const psImage * restrict domain, // /< The domain values for the corresponding + const psImage * restrict domain, ///< The domain values for the corresponding // measurements - const psVector * restrict data, // /< Data to fit - const psVector * restrict errors, // /< Errors in the data - psVector * restrict initialGuess, // /< Initial guess - const psVector * restrict paramMask, // /< 1 = fit for parameter, 0 = hold + const psVector * restrict data, ///< Data to fit + const psVector * restrict errors, ///< Errors in the data + psVector * restrict initialGuess, ///< Initial guess + const psVector * restrict paramMask, ///< 1 = fit for parameter, 0 = hold // parameter constant float *chiSq); /** Derive a polynomial fit by chi^2 minimisation (analytically) */ -psPolynomial1D *psVectorFitPolynomial1D(psPolynomial1D * myPoly, // /< Polynomial to fit - const psVector * restrict x, // /< Ordinates (or NULL to just use +psPolynomial1D *psVectorFitPolynomial1D(psPolynomial1D * myPoly, ///< Polynomial to fit + const psVector * restrict x, ///< Ordinates (or NULL to just use // the indices) - const psVector * restrict y, // /< Coordinates - const psVector * restrict yErr // /< Errors in coordinates, or NULL + const psVector * restrict y, ///< Coordinates + const psVector * restrict yErr ///< Errors in coordinates, or NULL ); Index: /trunk/psLib/src/dataManip/psStats.h =================================================================== --- /trunk/psLib/src/dataManip/psStats.h (revision 1425) +++ /trunk/psLib/src/dataManip/psStats.h (revision 1426) @@ -10,6 +10,6 @@ * @author George Gusciora, MHPCC * - * @version $Revision: 1.21 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.22 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -50,41 +50,41 @@ typedef struct { - double sampleMean; // /< formal mean of sample - double sampleMedian; // /< formal median of sample - double sampleStdev; // /< standard deviation of sample - double sampleUQ; // /< upper quartile of sample - double sampleLQ; // /< lower quartile of sample - double sampleLimit; // /< - double robustMean; // /< robust mean of array - double robustMedian; // /< robust median of array - double robustMode; // /< Robust mode of array - double robustStdev; // /< robust standard deviation of array - double robustUQ; // /< robust upper quartile - double robustLQ; // /< robust lower quartile + double sampleMean; ///< formal mean of sample + double sampleMedian; ///< formal median of sample + double sampleStdev; ///< standard deviation of sample + double sampleUQ; ///< upper quartile of sample + double sampleLQ; ///< lower quartile of sample + double sampleLimit; ///< + double robustMean; ///< robust mean of array + double robustMedian; ///< robust median of array + double robustMode; ///< Robust mode of array + double robustStdev; ///< robust standard deviation of array + double robustUQ; ///< robust upper quartile + double robustLQ; ///< robust lower quartile double XXX; - double robustN50; // /< - double robustNfit; // /< - double clippedMean; // /< Nsigma clipped mean - double clippedStdev; // /< standard deviation after clipping - double clipSigma; // /< Nsigma used for clipping; user input - int clipIter; // /< Number of clipping iterations; user input - double min; // /< minimum data value in array - double max; // /< maximum data value in array - double binsize; // /< - psStatsOptions options; // /< bitmask of calculated values + double robustN50; ///< + double robustNfit; ///< + double clippedMean; ///< Nsigma clipped mean + double clippedStdev; ///< standard deviation after clipping + double clipSigma; ///< Nsigma used for clipping; user input + int clipIter; ///< Number of clipping iterations; user input + double min; ///< minimum data value in array + double max; ///< maximum data value in array + double binsize; ///< + psStatsOptions options; ///< bitmask of calculated values } psStats; /** Do Statistics on an array. Returns a status value. \ingroup MathGroup */ -psStats *psVectorStats(psStats * stats, // /< stats structure defines stats to be calculated and how - psVector * in, // /< Vector to be analysed: must be F32 - psVector * mask, // /< Ignore elements where (maskVector & maskVal) != 0: must be INT +psStats *psVectorStats(psStats * stats, ///< stats structure defines stats to be calculated and how + psVector * in, ///< Vector to be analysed: must be F32 + psVector * mask, ///< Ignore elements where (maskVector & maskVal) != 0: must be INT // or NULL - unsigned int maskVal // /< Only mask elements with one of these bits set in + unsigned int maskVal ///< Only mask elements with one of these bits set in // maskVector ); /** A constructor for the stats structure.*/ -psStats *psStatsAlloc(psStatsOptions options); // /< Statistics to measure +psStats *psStatsAlloc(psStatsOptions options); ///< Statistics to measure /****************************************************************************** @@ -95,25 +95,25 @@ typedef struct { - psVector *bounds; // /< Bounds for the bins (type F32) - psVector *nums; // /< Number in each of the bins (INT) - int minNum; // /< Number below the minimum - int maxNum; // /< Number above the maximum - bool uniform; // /< Is it a uniform distribution? + psVector *bounds; ///< Bounds for the bins (type F32) + psVector *nums; ///< Number in each of the bins (INT) + int minNum; ///< Number below the minimum + int maxNum; ///< Number above the maximum + bool uniform; ///< Is it a uniform distribution? } psHistogram; /** Constructor \ingroup MathGroup */ -psHistogram *psHistogramAlloc(float lower, // /< Lower limit for the bins - float upper, // /< Upper limit for the bins - int n); // /< Number of bins +psHistogram *psHistogramAlloc(float lower, ///< Lower limit for the bins + float upper, ///< Upper limit for the bins + int n); ///< Number of bins /** Generic constructor \ingroup MathGroup */ -psHistogram *psHistogramAllocGeneric(const psVector * restrict bounds); // /< Bounds for the bins +psHistogram *psHistogramAllocGeneric(const psVector * restrict bounds); ///< Bounds for the bins /** Calculate a histogram \ingroup MathGroup **/ -psHistogram *psVectorHistogram(psHistogram * out, // /< Histogram data - const psVector * restrict in, // /< Vector to analyse - const psVector * restrict mask, // /< Mask dat for input vector - unsigned int maskVal); // /< Mask value +psHistogram *psVectorHistogram(psHistogram * out, ///< Histogram data + const psVector * restrict in, ///< Vector to analyse + const psVector * restrict mask, ///< Mask dat for input vector + unsigned int maskVal); ///< Mask value bool p_psGetStatValue(const psStats * stats, double *value); Index: /trunk/psLib/src/dataManip/psVectorFFT.h =================================================================== --- /trunk/psLib/src/dataManip/psVectorFFT.h (revision 1425) +++ /trunk/psLib/src/dataManip/psVectorFFT.h (revision 1426) @@ -8,6 +8,6 @@ * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.9 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -29,5 +29,5 @@ PS_FFT_FORWARD = (-1), - // /< psImageFFT/psVectorFFT should perform a reverse FFT. + ///< psImageFFT/psVectorFFT should perform a reverse FFT. PS_FFT_REVERSE = (+1) } psFftDirection; Index: /trunk/psLib/src/fft/psVectorFFT.h =================================================================== --- /trunk/psLib/src/fft/psVectorFFT.h (revision 1425) +++ /trunk/psLib/src/fft/psVectorFFT.h (revision 1426) @@ -8,6 +8,6 @@ * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.9 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -29,5 +29,5 @@ PS_FFT_FORWARD = (-1), - // /< psImageFFT/psVectorFFT should perform a reverse FFT. + ///< psImageFFT/psVectorFFT should perform a reverse FFT. PS_FFT_REVERSE = (+1) } psFftDirection; Index: /trunk/psLib/src/image/psImage.h =================================================================== --- /trunk/psLib/src/image/psImage.h (revision 1425) +++ /trunk/psLib/src/image/psImage.h (revision 1426) @@ -12,22 +12,25 @@ * @author Ross Harman, MHPCC * - * @version $Revision: 1.28 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.29 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ #ifndef PS_IMAGE_H -# define PS_IMAGE_H +#define PS_IMAGE_H -# include +#include -# include "psType.h" +#include "psType.h" /// @addtogroup Image /// @{ +/** enumeration of options in interpolation + * + */ typedef enum { - PS_INTERPOLATE_FLAT, - PS_INTERPOLATE_BILINEAR + PS_INTERPOLATE_FLAT, ///< 'flat' interpolation (nearest pixel) + PS_INTERPOLATE_BILINEAR ///< bi-linear interpolation } psImageInterpolateMode; @@ -40,29 +43,29 @@ typedef struct psImage { - const psType type; // /< Image data type and dimension. - const unsigned int numCols; // /< Number of columns in image - const unsigned int numRows; // /< Number of rows in image. - const int col0; // /< Column position relative to parent. - const int row0; // /< Row position relative to parent. + const psType type; ///< Image data type and dimension. + const unsigned int numCols; ///< Number of columns in image + const unsigned int numRows; ///< Number of rows in image. + const int col0; ///< Column position relative to parent. + const int row0; ///< Row position relative to parent. union { - psU8 **U8; // /< Unsigned 8-bit integer data. - psU16 **U16; // /< Unsigned 16-bit integer data. - psU32 **U32; // /< Unsigned 32-bit integer data. - psU64 **U64; // /< Unsigned 64-bit integer data. - psS8 **S8; // /< Signed 8-bit integer data. - psS16 **S16; // /< Signed 16-bit integer data. - psS32 **S32; // /< Signed 32-bit integer data. - psS64 **S64; // /< Signed 64-bit integer data. - psF32 **F32; // /< Single-precision float data. - psF64 **F64; // /< Double-precision float data. - psC32 **C32; // /< Single-precision complex data. - psC64 **C64; // /< Double-precision complex data. - psPTR **PTR; // /< Void pointers. - psPTR *V; // /< Pointer to data. - } data; // /< Union for data types. - const struct psImage *parent; // /< Parent, if a subimage. - int nChildren; // /< Number of subimages. - struct psImage **children; // /< Children of this region. + psU8 **U8; ///< Unsigned 8-bit integer data. + psU16 **U16; ///< Unsigned 16-bit integer data. + psU32 **U32; ///< Unsigned 32-bit integer data. + psU64 **U64; ///< Unsigned 64-bit integer data. + psS8 **S8; ///< Signed 8-bit integer data. + psS16 **S16; ///< Signed 16-bit integer data. + psS32 **S32; ///< Signed 32-bit integer data. + psS64 **S64; ///< Signed 64-bit integer data. + psF32 **F32; ///< Single-precision float data. + psF64 **F64; ///< Double-precision float data. + psC32 **C32; ///< Single-precision complex data. + psC64 **C64; ///< Double-precision complex data. + psPTR **PTR; ///< Void pointers. + psPTR *V; ///< Pointer to data. + } data; ///< Union for data types. + const struct psImage *parent; ///< Parent, if a subimage. + int nChildren; ///< Number of subimages. + struct psImage **children; ///< Children of this region. } psImage; @@ -82,7 +85,7 @@ * */ -psImage *psImageAlloc(unsigned int numCols, // /< Number of rows in image. - unsigned int numRows, // /< Number of columns in image. - const psElemType type // /< Type of data for image. +psImage *psImageAlloc(unsigned int numCols, ///< Number of rows in image. + unsigned int numRows, ///< Number of columns in image. + const psElemType type ///< Type of data for image. ); @@ -92,8 +95,8 @@ * */ -psImage *psImageRecycle(psImage * old, // /< the psImage to recycle by resizing image buffer - unsigned int numCols, // /< the desired number of columns in image - unsigned int numRows, // /< the desired number of rows in image - const psElemType type // /< the desired datatype of the image +psImage *psImageRecycle(psImage * old, ///< the psImage to recycle by resizing image buffer + unsigned int numCols, ///< the desired number of columns in image + unsigned int numRows, ///< the desired number of rows in image + const psElemType type ///< the desired datatype of the image ); Index: /trunk/psLib/src/image/psImageExtraction.h =================================================================== --- /trunk/psLib/src/image/psImageExtraction.h (revision 1425) +++ /trunk/psLib/src/image/psImageExtraction.h (revision 1426) @@ -10,6 +10,6 @@ * @author Robert DeSonia, MHPCC * -* @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-07 00:06:06 $ +* @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -26,26 +26,29 @@ /// @{ +/* Cut direction flag. Used with psImageCut function. + */ typedef enum { - PS_CUT_X_POS, - PS_CUT_X_NEG, - PS_CUT_Y_POS, - PS_CUT_Y_NEG, + PS_CUT_X_POS, ///< Cut in the x dimension from left to right + PS_CUT_X_NEG, ///< Cut in the x dimension from rigth to left + PS_CUT_Y_POS, ///< Cut in the y dimension from bottom up + PS_CUT_Y_NEG, ///< Cut in the y dimension from top down. } psImageCutDirection; /** Create a subimage of the specified area. -* -* Uses psLib memory allocation functions to create an image based on a larger -* one. -* -* @return psImage*: Pointer to psImage. -* -*/ -psImage *psImageSubset(psImage * out, // /< Subimage to return, or NULL. - psImage * image, // /< Parent image. - unsigned int numCols, // /< Subimage width (<= image.nCols - col0). - unsigned int numRows, // /< Subimage height (<= image.nRows - row0). - unsigned int col0, // /< Subimage col-offset (0 <= col0 < nCol). - unsigned int row0 // /< Subimage row-offset (0 <= row0 < nCol). - ); + * + * Uses psLib memory allocation functions to create an image based on a larger + * one. + * + * @return psImage*: Pointer to psImage. + * + */ +psImage* psImageSubset( + psImage* out, ///< image to recycle, or NULL. + psImage* image, ///< Parent image. + unsigned int numCols, ///< Subimage width (<= image.nCols - col0). + unsigned int numRows, ///< Subimage height (<= image.nRows - row0). + unsigned int col0, ///< Subimage col-offset (0 <= col0 < nCol). + unsigned int row0 ///< Subimage row-offset (0 <= row0 < nCol). +); /** Makes a copy of a psImage @@ -55,39 +58,93 @@ * */ -psImage *psImageCopy(psImage * restrict output, +psImage* psImageCopy( + psImage* restrict output, ///< if not NULL, a psImage that could be recycled. + const psImage* input, ///< the psImage to copy + psElemType type ///< the desired datatype of the returned copy +); - /**< if not NULL, a psImage that could be recycled. If it can not be used, - * it will be freed via psImageFree - */ - const psImage * input, - /**< the psImage to copy */ - psElemType type +/** Extract pixels from rectlinear region to a vector (array of floats). + * + * The output vector contains either nx or ny elements, based on the value of + * the direction: e.g., if direction is PS_CUT_X_POS, there are nx elements. + * The input region is collapsed in the perpendicular direction, and each + * element of the output vectors is derived from the statistics of the pixels + * at that direction coordinate. The statistic used to derive the output + * vector value is specified by stats. Only one of the statistics choices may + * be specified, otherwise the function must return an error. This function + * must be defined for the following types: psS8, psU16, psF32, psF64. + * + * @return psVector the resulting vector + */ +psVector *psImageSlice( + psVector* out, ///< psVector to recycle, or NULL. + psVector* slicePositions, + ///< If not NULL, it is populated with the coordinate in the slice dimension + ///< coorsponding to the output vector's value of the same position in the + ///< vector. This vector maybe resized and retyped as appropriate. + const psImage* restrict input, ///< the input image in which to perform the slice + const psImage* restrict mask, ///< the mask for the input image. + unsigned int maskVal, ///< the mask value to apply to the mask + unsigned int col, ///< the leftmost column of the slice region + unsigned int row, ///< the bottommost row of the slice region + unsigned int numCols, ///< the number of columns in the slice region + unsigned int numRows, ///< the number of rows in the slice region + psImageCutDirection direction, ///< the slice dimension and direction + const psStats* stats ///< the statistic to perform in slice operation +); - /**< the desired datatype of the returned copy */ - ); +/** Extract pixels from an image along a line to a vector (array of floats). + * + * The vector (xs,ys) - (xe,ye) forms the basis of the output vector. Pixels + * are considered in a rectangular region of width dw about this vector. The + * input region is collapsed in the perpendicular direction, and each element + * of the output vector represents pixel-sized boxes, where the value is + * derived from the statistics of the pixels interpolated along the + * perpendicular direction. The specific algorithm which must be used is + * described in the PSLib ADD (PSDC-430-006). The statistic used to derive + * the output vector value is specified by stats. Only one of the statistics + * choices may be specified, otherwise the function must return an error. + * This function must be defined for the following types: psS8, psU16, psF32, + * psF64. + * + * @return psVector resulting vector + */ +psVector *psImageCut( + psVector* out, ///< psVector to recycle, or NULL. + const psImage* input, ///< the input image in which to perform the cut + const psImage* restrict mask, ///< the mask for the input image. + unsigned int maskVal, ///< the mask value to apply to the mask + float startCol, ///< the column of the start of the cut line + float startRow, ///< the row of the start of the cut line + float endCol, ///< the column of the end of the cut line + float endRow, ///< the row of the end of the cut line + float width, ///< the distance about the line to perform the statistics + const psStats* stats ///< the statistic to perform in operation +); -psVector *psImageSlice(psVector * out, - psVector * slicePositions, - const psImage * restrict input, - const psImage * restrict mask, - unsigned int maskVal, - unsigned int col, - unsigned int row, - unsigned int numCols, - unsigned int numRows, psImageCutDirection direction, const psStats * stats); - -psVector *psImageCut(psVector * out, - const psImage * input, - const psImage * restrict mask, - unsigned int maskVal, - float startCol, - float startRow, float endCol, float endRow, float width, const psStats * stats); - -psVector *psImageRadialCut(psVector * out, - const psImage * input, - const psImage * restrict mask, - unsigned int maskVal, - float centerCol, float centerRow, const psVector * radii, const psStats * stats); +/** Extract radial region data to a vector. A vector is constructed where each + * vector elements is derived from the statistics of the pixels which land + * within one of a sequence of radii. The radii are centered on the image + * pixel coordinate x,y, and are defined by the sequence of values in the + * vector radii. The specific algorithm which must be used is described in + * the PSLib ADD (PSDC-430-006). The statistic used to derive the output + * vector value is specified by stats. Only one of the statistics choices + * may be specified, otherwise the function must return an error. This + * function must be defined for the following types: psS8, psU16, psF32, + * psF64. + * + * @return psVector resulting vector + */ +psVector* psImageRadialCut( + psVector* out, ///< psVector to recycle, or NULL. + const psImage* input, ///< the input image in which to perform the cut + const psImage* restrict mask, ///< the mask for the input image. + unsigned int maskVal, ///< the mask value to apply to the mask + float centerCol, ///< the column of the center of the cut circle + float centerRow, ///< the row of the center of the cut circle + const psVector* radii, ///< the radii of the cut circle + const psStats* stats ///< the statistic to perform in operation +); /// @} Index: /trunk/psLib/src/image/psImageManip.h =================================================================== --- /trunk/psLib/src/image/psImageManip.h (revision 1425) +++ /trunk/psLib/src/image/psImageManip.h (revision 1426) @@ -11,6 +11,6 @@ * @author Ross Harman, MHPCC * - * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -32,9 +32,9 @@ * @return int The number of clipped pixels */ -int psImageClip(psImage * input, // /< the image to clip - psF64 min, // /< the minimum image value allowed - psF64 vmin, // /< the value pixels < min are set to - psF64 max, // /< the maximum image value allowed - psF64 vmax // /< the value pixels > max are set to +int psImageClip(psImage * input, ///< the image to clip + psF64 min, ///< the minimum image value allowed + psF64 vmin, ///< the value pixels < min are set to + psF64 max, ///< the maximum image value allowed + psF64 vmax ///< the value pixels > max are set to ); @@ -48,9 +48,9 @@ * @return int The number of clipped pixels */ -int psImageClipComplexRegion(psImage * input, // /< the image to clip - psC64 min, // /< the minimum image value allowed - psC64 vmin, // /< the value pixels < min are set to - psC64 max, // /< the maximum image value allowed - psC64 vmax // /< the value pixels > max are set to +int psImageClipComplexRegion(psImage * input, ///< the image to clip + psC64 min, ///< the minimum image value allowed + psC64 vmin, ///< the value pixels < min are set to + psC64 max, ///< the maximum image value allowed + psC64 vmax ///< the value pixels > max are set to ); @@ -62,6 +62,6 @@ * @return int The number of clipped pixels */ -int psImageClipNaN(psImage * input, // /< the image to clip - psF64 value // /< the value to set all NaN/Inf values to +int psImageClipNaN(psImage * input, ///< the image to clip + psF64 value ///< the value to set all NaN/Inf values to ); @@ -77,9 +77,9 @@ * @return int 0 if success, non-zero if failed. */ -int psImageOverlaySection(psImage * image, // /< target image - const psImage * overlay, // /< the overlay image - int col0, // /< the column to start overlay - int row0, // /< the row to start overlay - const char *op // /< the operation to perform for overlay +int psImageOverlaySection(psImage * image, ///< target image + const psImage * overlay, ///< the overlay image + int col0, ///< the column to start overlay + int row0, ///< the row to start overlay + const char *op ///< the operation to perform for overlay ); @@ -94,21 +94,21 @@ * @return psImage new image formed by rebinning input image. */ -psImage *psImageRebin(psImage * out, // /< an psImage to recycle. If NULL, a new image is created - const psImage * in, // /< input image - unsigned int scale, // /< the scale to rebin for each dimension - const psStats * stats // /< the statistic to perform when rebinning. Only one +psImage *psImageRebin(psImage * out, ///< an psImage to recycle. If NULL, a new image is created + const psImage * in, ///< input image + unsigned int scale, ///< the scale to rebin for each dimension + const psStats * stats ///< the statistic to perform when rebinning. Only one // method should be set. ); -psImage *psImageResample(psImage * out, // /< an psImage to recycle. If NULL, a new image is created - const psImage * in, // /< input image +psImage *psImageResample(psImage * out, ///< an psImage to recycle. If NULL, a new image is created + const psImage * in, ///< input image int scale, psImageInterpolateMode mode); -psImage *psImageRotate(psImage * out, // /< an psImage to recycle. If NULL, a new image is created - const psImage * in, // /< input image +psImage *psImageRotate(psImage * out, ///< an psImage to recycle. If NULL, a new image is created + const psImage * in, ///< input image float angle, float unexposedValue, psImageInterpolateMode mode); -psImage *psImageShift(psImage * out, // /< an psImage to recycle. If NULL, a new image is created - const psImage * in, // /< input image +psImage *psImageShift(psImage * out, ///< an psImage to recycle. If NULL, a new image is created + const psImage * in, ///< input image float dx, float dy, float unexposedValue, psImageInterpolateMode mode); @@ -121,8 +121,8 @@ * @return psImage* the rolled version of the input image. */ -psImage *psImageRoll(psImage * out, // /< an psImage to recycle. If NULL, a new image is created - const psImage * in, // /< input image - int dx, // /< number of pixels to roll in the x-dimension - int dy // /< number of pixels to roll in the y-dimension +psImage *psImageRoll(psImage * out, ///< an psImage to recycle. If NULL, a new image is created + const psImage * in, ///< input image + int dx, ///< number of pixels to roll in the x-dimension + int dy ///< number of pixels to roll in the y-dimension ); Index: /trunk/psLib/src/image/psImageStats.h =================================================================== --- /trunk/psLib/src/image/psImageStats.h (revision 1425) +++ /trunk/psLib/src/image/psImageStats.h (revision 1426) @@ -10,6 +10,6 @@ * @author George Gusciora, MHPCC * -* @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-07 00:06:06 $ +* @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -28,23 +28,23 @@ /// This routine must determine the various statistics for the image. -psStats *psImageStats(psStats * stats, // /< defines statistics to be calculated - psImage * in, // /< image (or subimage) to calculate stats - psImage * mask, // /< mask data for image (NULL ok) - int maskVal); // /< mask Mask for mask +psStats *psImageStats(psStats * stats, ///< defines statistics to be calculated + psImage * in, ///< image (or subimage) to calculate stats + psImage * mask, ///< mask data for image (NULL ok) + int maskVal); ///< mask Mask for mask -psHistogram *psImageHistogram(psHistogram * out, // /< input histogram description & target - psImage * in, // /< Image data to be histogramed. - psImage * mask, // /< mask data for image (NULL ok) - unsigned int maskVal); // /< mask Mask for mask +psHistogram *psImageHistogram(psHistogram * out, ///< input histogram description & target + psImage * in, ///< Image data to be histogramed. + psImage * mask, ///< mask data for image (NULL ok) + unsigned int maskVal); ///< mask Mask for mask /// Fit a 2-D polynomial surface to an image. -psPolynomial2D *psImageFitPolynomial(const psImage * input, // /< image to fit - psPolynomial2D * coeffs // /< coefficient structure carries in +psPolynomial2D *psImageFitPolynomial(const psImage * input, ///< image to fit + psPolynomial2D * coeffs ///< coefficient structure carries in // desired terms & target ); /// Evaluate a 2-D polynomial surface to image pixels. -int psImageEvalPolynomial(const psImage * input, // /< image to fit - const psPolynomial2D * coeffs // /< coefficient structure carries in desired terms +int psImageEvalPolynomial(const psImage * input, ///< image to fit + const psPolynomial2D * coeffs ///< coefficient structure carries in desired terms ); Index: /trunk/psLib/src/imageops/psImageStats.h =================================================================== --- /trunk/psLib/src/imageops/psImageStats.h (revision 1425) +++ /trunk/psLib/src/imageops/psImageStats.h (revision 1426) @@ -10,6 +10,6 @@ * @author George Gusciora, MHPCC * -* @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-07 00:06:06 $ +* @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -28,23 +28,23 @@ /// This routine must determine the various statistics for the image. -psStats *psImageStats(psStats * stats, // /< defines statistics to be calculated - psImage * in, // /< image (or subimage) to calculate stats - psImage * mask, // /< mask data for image (NULL ok) - int maskVal); // /< mask Mask for mask +psStats *psImageStats(psStats * stats, ///< defines statistics to be calculated + psImage * in, ///< image (or subimage) to calculate stats + psImage * mask, ///< mask data for image (NULL ok) + int maskVal); ///< mask Mask for mask -psHistogram *psImageHistogram(psHistogram * out, // /< input histogram description & target - psImage * in, // /< Image data to be histogramed. - psImage * mask, // /< mask data for image (NULL ok) - unsigned int maskVal); // /< mask Mask for mask +psHistogram *psImageHistogram(psHistogram * out, ///< input histogram description & target + psImage * in, ///< Image data to be histogramed. + psImage * mask, ///< mask data for image (NULL ok) + unsigned int maskVal); ///< mask Mask for mask /// Fit a 2-D polynomial surface to an image. -psPolynomial2D *psImageFitPolynomial(const psImage * input, // /< image to fit - psPolynomial2D * coeffs // /< coefficient structure carries in +psPolynomial2D *psImageFitPolynomial(const psImage * input, ///< image to fit + psPolynomial2D * coeffs ///< coefficient structure carries in // desired terms & target ); /// Evaluate a 2-D polynomial surface to image pixels. -int psImageEvalPolynomial(const psImage * input, // /< image to fit - const psPolynomial2D * coeffs // /< coefficient structure carries in desired terms +int psImageEvalPolynomial(const psImage * input, ///< image to fit + const psPolynomial2D * coeffs ///< coefficient structure carries in desired terms ); Index: /trunk/psLib/src/math/psMatrix.h =================================================================== --- /trunk/psLib/src/math/psMatrix.h (revision 1425) +++ /trunk/psLib/src/math/psMatrix.h (revision 1426) @@ -22,6 +22,6 @@ * @author Ross Harman, MHPCC * - * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -43,7 +43,7 @@ * @return psImage*: Pointer to LU decomposed psImage. */ -psImage *psMatrixLUD(psImage * outImage, // /< Image to return, or NULL. - psVector * outPerm, // /< Output permutation vector used by psMatrixLUSolve. - psImage * inImage // /< Image to decompose. +psImage *psMatrixLUD(psImage * outImage, ///< Image to return, or NULL. + psVector * outPerm, ///< Output permutation vector used by psMatrixLUSolve. + psImage * inImage ///< Image to decompose. ); @@ -57,8 +57,8 @@ * @return psVector*: Pointer to psVector solution of matrix equation. */ -psVector *psMatrixLUSolve(psVector * outVector, // /< Vector to return, or NULL. - const psImage * luImage, // /< LU-decomposed matrix. - const psVector * inVector, // /< Vector right-hand-side of equation. - const psVector * inPerm // /< Permutation vector resulting from psMatrixLUD +psVector *psMatrixLUSolve(psVector * outVector, ///< Vector to return, or NULL. + const psImage * luImage, ///< LU-decomposed matrix. + const psVector * inVector, ///< Vector right-hand-side of equation. + const psVector * inPerm ///< Permutation vector resulting from psMatrixLUD // function. ); @@ -73,7 +73,7 @@ * @return psImage*: Pointer to inverted psImage. */ -psImage *psMatrixInvert(psImage * outImage, // /< Image to return, or NULL for in-place substitution. - const psImage * inImage, // /< Image to be inverted - float *restrict det // /< Determinant to return, or NULL +psImage *psMatrixInvert(psImage * outImage, ///< Image to return, or NULL for in-place substitution. + const psImage * inImage, ///< Image to be inverted + float *restrict det ///< Determinant to return, or NULL ); @@ -86,5 +86,5 @@ * @return float: Determinant from psImage. */ -float *psMatrixDeterminant(const psImage * restrict inMatrix // /< Image used to calculate determinant. +float *psMatrixDeterminant(const psImage * restrict inMatrix ///< Image used to calculate determinant. ); @@ -98,7 +98,7 @@ * @return psImage*: Pointer to resulting psImage. */ -psImage *psMatrixMultiply(psImage * outImage, // /< Matrix to return, or NULL. - psImage * inImage1, // /< First input image. - psImage * inImage2 // /< Second input image. +psImage *psMatrixMultiply(psImage * outImage, ///< Matrix to return, or NULL. + psImage * inImage1, ///< First input image. + psImage * inImage2 ///< Second input image. ); @@ -112,6 +112,6 @@ * @return psImage*: Pointer to transposed psImage. */ -psImage *psMatrixTranspose(psImage * outImage, // /< Image to return, or NULL - const psImage * inImage // /< Image to transpose +psImage *psMatrixTranspose(psImage * outImage, ///< Image to return, or NULL + const psImage * inImage ///< Image to transpose ); @@ -124,6 +124,6 @@ * @return psImage*: Pointer to matrix of Eigenvectors. */ -psImage *psMatrixEigenvectors(psImage * outImage, // /< Eigenvectors to return, or NULL. - psImage * inImage // /< Input image. +psImage *psMatrixEigenvectors(psImage * outImage, ///< Eigenvectors to return, or NULL. + psImage * inImage ///< Input image. ); @@ -137,6 +137,6 @@ * @return psVector*: Pointer to psVector. */ -psVector *psMatrixToVector(psVector * outVector, // /< Vector to return, or NULL. - psImage * inImage // /< Image to convert. +psVector *psMatrixToVector(psVector * outVector, ///< Vector to return, or NULL. + psImage * inImage ///< Image to convert. ); @@ -150,6 +150,6 @@ * @return psVector*: Pointer to psIamge. */ -psImage *psVectorToMatrix(psImage * outImage, // /< Matrix to return, or NULL. - psVector * inVector // /< Vector to convert. +psImage *psVectorToMatrix(psImage * outImage, ///< Matrix to return, or NULL. + psVector * inVector ///< Vector to convert. ); Index: /trunk/psLib/src/math/psMinimize.h =================================================================== --- /trunk/psLib/src/math/psMinimize.h (revision 1425) +++ /trunk/psLib/src/math/psMinimize.h (revision 1426) @@ -22,5 +22,5 @@ /** Minimize chi^2 for input data */ -psVector *psMinimizeChi2(float (*evalModel) (const psVector * restrict, const psVector * restrict), // /< +psVector *psMinimizeChi2(float (*evalModel) (const psVector * restrict, const psVector * restrict), ///< // Model // to @@ -29,5 +29,5 @@ // and // params) - float (*DevalModel) (const psVector * restrict, const psVector * restrict, int), // /< + float (*DevalModel) (const psVector * restrict, const psVector * restrict, int), ///< // Derivative // of @@ -38,19 +38,19 @@ // and // params) - const psImage * restrict domain, // /< The domain values for the corresponding + const psImage * restrict domain, ///< The domain values for the corresponding // measurements - const psVector * restrict data, // /< Data to fit - const psVector * restrict errors, // /< Errors in the data - psVector * restrict initialGuess, // /< Initial guess - const psVector * restrict paramMask, // /< 1 = fit for parameter, 0 = hold + const psVector * restrict data, ///< Data to fit + const psVector * restrict errors, ///< Errors in the data + psVector * restrict initialGuess, ///< Initial guess + const psVector * restrict paramMask, ///< 1 = fit for parameter, 0 = hold // parameter constant float *chiSq); /** Derive a polynomial fit by chi^2 minimisation (analytically) */ -psPolynomial1D *psVectorFitPolynomial1D(psPolynomial1D * myPoly, // /< Polynomial to fit - const psVector * restrict x, // /< Ordinates (or NULL to just use +psPolynomial1D *psVectorFitPolynomial1D(psPolynomial1D * myPoly, ///< Polynomial to fit + const psVector * restrict x, ///< Ordinates (or NULL to just use // the indices) - const psVector * restrict y, // /< Coordinates - const psVector * restrict yErr // /< Errors in coordinates, or NULL + const psVector * restrict y, ///< Coordinates + const psVector * restrict yErr ///< Errors in coordinates, or NULL ); Index: /trunk/psLib/src/math/psPolynomial.h =================================================================== --- /trunk/psLib/src/math/psPolynomial.h (revision 1425) +++ /trunk/psLib/src/math/psPolynomial.h (revision 1426) @@ -13,6 +13,6 @@ * @author George Gusciora, MHPCC * -* @version $Revision: 1.15 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-07 00:06:06 $ +* @version $Revision: 1.16 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -34,23 +34,23 @@ evaluated Gaussian is: \f[ exp(-\frac{(x-mean)^2}{2\sigma^2}) \f] */ -float psGaussian(float x, // /< Value at which to evaluate - float mean, // /< Mean for the Gaussian - float stddev, // /< Standard deviation for the Gaussian - bool normal // /< Indicates whether result should be normalized +float psGaussian(float x, ///< Value at which to evaluate + float mean, ///< Mean for the Gaussian + float stddev, ///< Standard deviation for the Gaussian + bool normal ///< Indicates whether result should be normalized ); /** Produce a vector of random numbers from a Gaussian distribution with the specified mean and sigma */ -psVector *psGaussianDev(float mean, // /< The mean of the Gaussian - float sigma, // /< The sigma of the Gaussian - int Npts); // /< The size of the vector +psVector *psGaussianDev(float mean, ///< The mean of the Gaussian + float sigma, ///< The sigma of the Gaussian + int Npts); ///< The size of the vector /** One-dimensional polynomial */ typedef struct { - int n; // /< Number of terms - float *coeff; // /< Coefficients - float *coeffErr; // /< Error in coefficients - char *mask; // /< Coefficient mask + int n; ///< Number of terms + float *coeff; ///< Coefficients + float *coeffErr; ///< Error in coefficients + char *mask; ///< Coefficient mask } psPolynomial1D; @@ -60,8 +60,8 @@ { int nX, - nY; // /< Number of terms in x and y - float **coeff; // /< Coefficients - float **coeffErr; // /< Error in coefficients - char **mask; // /< Coefficients mask + nY; ///< Number of terms in x and y + float **coeff; ///< Coefficients + float **coeffErr; ///< Error in coefficients + char **mask; ///< Coefficients mask } psPolynomial2D; @@ -72,8 +72,8 @@ int nX, nY, - nZ; // /< Number of terms in x, y and z - float ***coeff; // /< Coefficients - float ***coeffErr; // /< Error in coefficients - char ***mask; // /< Coefficients mask + nZ; ///< Number of terms in x, y and z + float ***coeff; ///< Coefficients + float ***coeffErr; ///< Error in coefficients + char ***mask; ///< Coefficients mask } psPolynomial3D; @@ -85,8 +85,8 @@ nX, nY, - nZ; // /< Number of terms in w, x, y and z - float ****coeff; // /< Coefficients - float ****coeffErr; // /< Error in coefficients - char ****mask; // /< Coefficients mask + nZ; ///< Number of terms in w, x, y and z + float ****coeff; ///< Coefficients + float ****coeffErr; ///< Error in coefficients + char ****mask; ///< Coefficients mask } psPolynomial4D; @@ -95,44 +95,44 @@ /** Constructor */ -psPolynomial1D *psPolynomial1DAlloc(int n // /< Number of terms - ); - -/** Constructor */ -psPolynomial2D *psPolynomial2DAlloc(int nX, int nY // /< Number of terms in x and y - ); - -/** Constructor */ -psPolynomial3D *psPolynomial3DAlloc(int nX, int nY, int nZ // /< Number of terms in x, y and z - ); - -/** Constructor */ -psPolynomial4D *psPolynomial4DAlloc(int nW, int nX, int nY, int nZ // /< Number of terms in w, x, y and +psPolynomial1D *psPolynomial1DAlloc(int n ///< Number of terms + ); + +/** Constructor */ +psPolynomial2D *psPolynomial2DAlloc(int nX, int nY ///< Number of terms in x and y + ); + +/** Constructor */ +psPolynomial3D *psPolynomial3DAlloc(int nX, int nY, int nZ ///< Number of terms in x, y and z + ); + +/** Constructor */ +psPolynomial4D *psPolynomial4DAlloc(int nW, int nX, int nY, int nZ ///< Number of terms in w, x, y and // z ); /** Evaluate 1D polynomial */ -float psPolynomial1DEval(float x, // /< Value at which to evaluate - const psPolynomial1D * myPoly // /< Coefficients for the polynomial +float psPolynomial1DEval(float x, ///< Value at which to evaluate + const psPolynomial1D * myPoly ///< Coefficients for the polynomial ); /** Evaluate 2D polynomial */ -float psPolynomial2DEval(float x, // /< Value x at which to evaluate - float y, // /< Value y at which to evaluate - const psPolynomial2D * myPoly // /< Coefficients for the polynomial +float psPolynomial2DEval(float x, ///< Value x at which to evaluate + float y, ///< Value y at which to evaluate + const psPolynomial2D * myPoly ///< Coefficients for the polynomial ); /** Evaluate 3D polynomial */ -float psPolynomial3DEval(float x, // /< Value x at which to evaluate - float y, // /< Value y at which to evaluate - float z, // /< Value z at which to evaluate - const psPolynomial3D * myPoly // /< Coefficients for the polynomial +float psPolynomial3DEval(float x, ///< Value x at which to evaluate + float y, ///< Value y at which to evaluate + float z, ///< Value z at which to evaluate + const psPolynomial3D * myPoly ///< Coefficients for the polynomial ); /** Evaluate 4D polynomial */ -float psPolynomial4DEval(float w, // /< Value w at which to evaluate - float x, // /< Value x at which to evaluate - float y, // /< Value y at which to evaluate - float z, // /< Value z at which to evaluate - const psPolynomial4D * myPoly // /< Coefficients for the polynomial +float psPolynomial4DEval(float w, ///< Value w at which to evaluate + float x, ///< Value x at which to evaluate + float y, ///< Value y at which to evaluate + float z, ///< Value z at which to evaluate + const psPolynomial4D * myPoly ///< Coefficients for the polynomial ); @@ -144,8 +144,8 @@ typedef struct { - int n; // /< Number of terms - double *coeff; // /< Coefficients - double *coeffErr; // /< Error in coefficients - char *mask; // /< Coefficient mask + int n; ///< Number of terms + double *coeff; ///< Coefficients + double *coeffErr; ///< Error in coefficients + char *mask; ///< Coefficient mask } psDPolynomial1D; @@ -155,8 +155,8 @@ { int nX, - nY; // /< Number of terms in x and y - double **coeff; // /< Coefficients - double **coeffErr; // /< Error in coefficients - char **mask; // /< Coefficients mask + nY; ///< Number of terms in x and y + double **coeff; ///< Coefficients + double **coeffErr; ///< Error in coefficients + char **mask; ///< Coefficients mask } psDPolynomial2D; @@ -167,8 +167,8 @@ int nX, nY, - nZ; // /< Number of terms in x, y and z - double ***coeff; // /< Coefficients - double ***coeffErr; // /< Error in coefficients - char ***mask; // /< Coefficient mask + nZ; ///< Number of terms in x, y and z + double ***coeff; ///< Coefficients + double ***coeffErr; ///< Error in coefficients + char ***mask; ///< Coefficient mask } psDPolynomial3D; @@ -180,52 +180,52 @@ nX, nY, - nZ; // /< Number of terms in w, x, y and z - double ****coeff; // /< Coefficients - double ****coeffErr; // /< Error in coefficients - char ****mask; // /< Coefficients mask + nZ; ///< Number of terms in w, x, y and z + double ****coeff; ///< Coefficients + double ****coeffErr; ///< Error in coefficients + char ****mask; ///< Coefficients mask } psDPolynomial4D; /** Constructor */ -psDPolynomial1D *psDPolynomial1DAlloc(int n // /< Number of terms - ); - -/** Constructor */ -psDPolynomial2D *psDPolynomial2DAlloc(int nX, int nY // /< Number of terms in x and y - ); - -/** Constructor */ -psDPolynomial3D *psDPolynomial3DAlloc(int nX, int nY, int nZ // /< Number of terms in x, y and z - ); - -/** Constructor */ -psDPolynomial4D *psDPolynomial4DAlloc(int nW, int nX, int nY, int nZ // /< Number of terms in w, x, y and +psDPolynomial1D *psDPolynomial1DAlloc(int n ///< Number of terms + ); + +/** Constructor */ +psDPolynomial2D *psDPolynomial2DAlloc(int nX, int nY ///< Number of terms in x and y + ); + +/** Constructor */ +psDPolynomial3D *psDPolynomial3DAlloc(int nX, int nY, int nZ ///< Number of terms in x, y and z + ); + +/** Constructor */ +psDPolynomial4D *psDPolynomial4DAlloc(int nW, int nX, int nY, int nZ ///< Number of terms in w, x, y and // z ); /** Evaluate 1D polynomial (double precision) */ -double psDPolynomial1DEval(double x, // /< Value at which to evaluate - const psDPolynomial1D * myPoly // /< Coefficients for the polynomial +double psDPolynomial1DEval(double x, ///< Value at which to evaluate + const psDPolynomial1D * myPoly ///< Coefficients for the polynomial ); /** Evaluate 2D polynomial (double precision) */ -double psDPolynomial2DEval(double x, // /< Value x at which to evaluate - double y, // /< Value y at which to evaluate - const psDPolynomial2D * myPoly // /< Coefficients for the polynomial +double psDPolynomial2DEval(double x, ///< Value x at which to evaluate + double y, ///< Value y at which to evaluate + const psDPolynomial2D * myPoly ///< Coefficients for the polynomial ); /** Evaluate 3D polynomial (double precision) */ -double psDPolynomial3DEval(double x, // /< Value x at which to evaluate - double y, // /< Value y at which to evaluate - double z, // /< Value z at which to evaluate - const psDPolynomial3D * myPoly // /< Coefficients for the polynomial +double psDPolynomial3DEval(double x, ///< Value x at which to evaluate + double y, ///< Value y at which to evaluate + double z, ///< Value z at which to evaluate + const psDPolynomial3D * myPoly ///< Coefficients for the polynomial ); /** Evaluate 4D polynomial (double precision) */ -double psDPolynomial4DEval(double w, // /< Value w at which to evaluate - double x, // /< Value x at which to evaluate - double y, // /< Value y at which to evaluate - double z, // /< Value z at which to evaluate - const psDPolynomial4D * myPoly // /< Coefficients for the polynomial +double psDPolynomial4DEval(double w, ///< Value w at which to evaluate + double x, ///< Value x at which to evaluate + double y, ///< Value y at which to evaluate + double z, ///< Value z at which to evaluate + const psDPolynomial4D * myPoly ///< Coefficients for the polynomial ); Index: /trunk/psLib/src/math/psSpline.h =================================================================== --- /trunk/psLib/src/math/psSpline.h (revision 1425) +++ /trunk/psLib/src/math/psSpline.h (revision 1426) @@ -13,6 +13,6 @@ * @author George Gusciora, MHPCC * -* @version $Revision: 1.15 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-07 00:06:06 $ +* @version $Revision: 1.16 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -34,23 +34,23 @@ evaluated Gaussian is: \f[ exp(-\frac{(x-mean)^2}{2\sigma^2}) \f] */ -float psGaussian(float x, // /< Value at which to evaluate - float mean, // /< Mean for the Gaussian - float stddev, // /< Standard deviation for the Gaussian - bool normal // /< Indicates whether result should be normalized +float psGaussian(float x, ///< Value at which to evaluate + float mean, ///< Mean for the Gaussian + float stddev, ///< Standard deviation for the Gaussian + bool normal ///< Indicates whether result should be normalized ); /** Produce a vector of random numbers from a Gaussian distribution with the specified mean and sigma */ -psVector *psGaussianDev(float mean, // /< The mean of the Gaussian - float sigma, // /< The sigma of the Gaussian - int Npts); // /< The size of the vector +psVector *psGaussianDev(float mean, ///< The mean of the Gaussian + float sigma, ///< The sigma of the Gaussian + int Npts); ///< The size of the vector /** One-dimensional polynomial */ typedef struct { - int n; // /< Number of terms - float *coeff; // /< Coefficients - float *coeffErr; // /< Error in coefficients - char *mask; // /< Coefficient mask + int n; ///< Number of terms + float *coeff; ///< Coefficients + float *coeffErr; ///< Error in coefficients + char *mask; ///< Coefficient mask } psPolynomial1D; @@ -60,8 +60,8 @@ { int nX, - nY; // /< Number of terms in x and y - float **coeff; // /< Coefficients - float **coeffErr; // /< Error in coefficients - char **mask; // /< Coefficients mask + nY; ///< Number of terms in x and y + float **coeff; ///< Coefficients + float **coeffErr; ///< Error in coefficients + char **mask; ///< Coefficients mask } psPolynomial2D; @@ -72,8 +72,8 @@ int nX, nY, - nZ; // /< Number of terms in x, y and z - float ***coeff; // /< Coefficients - float ***coeffErr; // /< Error in coefficients - char ***mask; // /< Coefficients mask + nZ; ///< Number of terms in x, y and z + float ***coeff; ///< Coefficients + float ***coeffErr; ///< Error in coefficients + char ***mask; ///< Coefficients mask } psPolynomial3D; @@ -85,8 +85,8 @@ nX, nY, - nZ; // /< Number of terms in w, x, y and z - float ****coeff; // /< Coefficients - float ****coeffErr; // /< Error in coefficients - char ****mask; // /< Coefficients mask + nZ; ///< Number of terms in w, x, y and z + float ****coeff; ///< Coefficients + float ****coeffErr; ///< Error in coefficients + char ****mask; ///< Coefficients mask } psPolynomial4D; @@ -95,44 +95,44 @@ /** Constructor */ -psPolynomial1D *psPolynomial1DAlloc(int n // /< Number of terms - ); - -/** Constructor */ -psPolynomial2D *psPolynomial2DAlloc(int nX, int nY // /< Number of terms in x and y - ); - -/** Constructor */ -psPolynomial3D *psPolynomial3DAlloc(int nX, int nY, int nZ // /< Number of terms in x, y and z - ); - -/** Constructor */ -psPolynomial4D *psPolynomial4DAlloc(int nW, int nX, int nY, int nZ // /< Number of terms in w, x, y and +psPolynomial1D *psPolynomial1DAlloc(int n ///< Number of terms + ); + +/** Constructor */ +psPolynomial2D *psPolynomial2DAlloc(int nX, int nY ///< Number of terms in x and y + ); + +/** Constructor */ +psPolynomial3D *psPolynomial3DAlloc(int nX, int nY, int nZ ///< Number of terms in x, y and z + ); + +/** Constructor */ +psPolynomial4D *psPolynomial4DAlloc(int nW, int nX, int nY, int nZ ///< Number of terms in w, x, y and // z ); /** Evaluate 1D polynomial */ -float psPolynomial1DEval(float x, // /< Value at which to evaluate - const psPolynomial1D * myPoly // /< Coefficients for the polynomial +float psPolynomial1DEval(float x, ///< Value at which to evaluate + const psPolynomial1D * myPoly ///< Coefficients for the polynomial ); /** Evaluate 2D polynomial */ -float psPolynomial2DEval(float x, // /< Value x at which to evaluate - float y, // /< Value y at which to evaluate - const psPolynomial2D * myPoly // /< Coefficients for the polynomial +float psPolynomial2DEval(float x, ///< Value x at which to evaluate + float y, ///< Value y at which to evaluate + const psPolynomial2D * myPoly ///< Coefficients for the polynomial ); /** Evaluate 3D polynomial */ -float psPolynomial3DEval(float x, // /< Value x at which to evaluate - float y, // /< Value y at which to evaluate - float z, // /< Value z at which to evaluate - const psPolynomial3D * myPoly // /< Coefficients for the polynomial +float psPolynomial3DEval(float x, ///< Value x at which to evaluate + float y, ///< Value y at which to evaluate + float z, ///< Value z at which to evaluate + const psPolynomial3D * myPoly ///< Coefficients for the polynomial ); /** Evaluate 4D polynomial */ -float psPolynomial4DEval(float w, // /< Value w at which to evaluate - float x, // /< Value x at which to evaluate - float y, // /< Value y at which to evaluate - float z, // /< Value z at which to evaluate - const psPolynomial4D * myPoly // /< Coefficients for the polynomial +float psPolynomial4DEval(float w, ///< Value w at which to evaluate + float x, ///< Value x at which to evaluate + float y, ///< Value y at which to evaluate + float z, ///< Value z at which to evaluate + const psPolynomial4D * myPoly ///< Coefficients for the polynomial ); @@ -144,8 +144,8 @@ typedef struct { - int n; // /< Number of terms - double *coeff; // /< Coefficients - double *coeffErr; // /< Error in coefficients - char *mask; // /< Coefficient mask + int n; ///< Number of terms + double *coeff; ///< Coefficients + double *coeffErr; ///< Error in coefficients + char *mask; ///< Coefficient mask } psDPolynomial1D; @@ -155,8 +155,8 @@ { int nX, - nY; // /< Number of terms in x and y - double **coeff; // /< Coefficients - double **coeffErr; // /< Error in coefficients - char **mask; // /< Coefficients mask + nY; ///< Number of terms in x and y + double **coeff; ///< Coefficients + double **coeffErr; ///< Error in coefficients + char **mask; ///< Coefficients mask } psDPolynomial2D; @@ -167,8 +167,8 @@ int nX, nY, - nZ; // /< Number of terms in x, y and z - double ***coeff; // /< Coefficients - double ***coeffErr; // /< Error in coefficients - char ***mask; // /< Coefficient mask + nZ; ///< Number of terms in x, y and z + double ***coeff; ///< Coefficients + double ***coeffErr; ///< Error in coefficients + char ***mask; ///< Coefficient mask } psDPolynomial3D; @@ -180,52 +180,52 @@ nX, nY, - nZ; // /< Number of terms in w, x, y and z - double ****coeff; // /< Coefficients - double ****coeffErr; // /< Error in coefficients - char ****mask; // /< Coefficients mask + nZ; ///< Number of terms in w, x, y and z + double ****coeff; ///< Coefficients + double ****coeffErr; ///< Error in coefficients + char ****mask; ///< Coefficients mask } psDPolynomial4D; /** Constructor */ -psDPolynomial1D *psDPolynomial1DAlloc(int n // /< Number of terms - ); - -/** Constructor */ -psDPolynomial2D *psDPolynomial2DAlloc(int nX, int nY // /< Number of terms in x and y - ); - -/** Constructor */ -psDPolynomial3D *psDPolynomial3DAlloc(int nX, int nY, int nZ // /< Number of terms in x, y and z - ); - -/** Constructor */ -psDPolynomial4D *psDPolynomial4DAlloc(int nW, int nX, int nY, int nZ // /< Number of terms in w, x, y and +psDPolynomial1D *psDPolynomial1DAlloc(int n ///< Number of terms + ); + +/** Constructor */ +psDPolynomial2D *psDPolynomial2DAlloc(int nX, int nY ///< Number of terms in x and y + ); + +/** Constructor */ +psDPolynomial3D *psDPolynomial3DAlloc(int nX, int nY, int nZ ///< Number of terms in x, y and z + ); + +/** Constructor */ +psDPolynomial4D *psDPolynomial4DAlloc(int nW, int nX, int nY, int nZ ///< Number of terms in w, x, y and // z ); /** Evaluate 1D polynomial (double precision) */ -double psDPolynomial1DEval(double x, // /< Value at which to evaluate - const psDPolynomial1D * myPoly // /< Coefficients for the polynomial +double psDPolynomial1DEval(double x, ///< Value at which to evaluate + const psDPolynomial1D * myPoly ///< Coefficients for the polynomial ); /** Evaluate 2D polynomial (double precision) */ -double psDPolynomial2DEval(double x, // /< Value x at which to evaluate - double y, // /< Value y at which to evaluate - const psDPolynomial2D * myPoly // /< Coefficients for the polynomial +double psDPolynomial2DEval(double x, ///< Value x at which to evaluate + double y, ///< Value y at which to evaluate + const psDPolynomial2D * myPoly ///< Coefficients for the polynomial ); /** Evaluate 3D polynomial (double precision) */ -double psDPolynomial3DEval(double x, // /< Value x at which to evaluate - double y, // /< Value y at which to evaluate - double z, // /< Value z at which to evaluate - const psDPolynomial3D * myPoly // /< Coefficients for the polynomial +double psDPolynomial3DEval(double x, ///< Value x at which to evaluate + double y, ///< Value y at which to evaluate + double z, ///< Value z at which to evaluate + const psDPolynomial3D * myPoly ///< Coefficients for the polynomial ); /** Evaluate 4D polynomial (double precision) */ -double psDPolynomial4DEval(double w, // /< Value w at which to evaluate - double x, // /< Value x at which to evaluate - double y, // /< Value y at which to evaluate - double z, // /< Value z at which to evaluate - const psDPolynomial4D * myPoly // /< Coefficients for the polynomial +double psDPolynomial4DEval(double w, ///< Value w at which to evaluate + double x, ///< Value x at which to evaluate + double y, ///< Value y at which to evaluate + double z, ///< Value z at which to evaluate + const psDPolynomial4D * myPoly ///< Coefficients for the polynomial ); Index: /trunk/psLib/src/math/psStats.h =================================================================== --- /trunk/psLib/src/math/psStats.h (revision 1425) +++ /trunk/psLib/src/math/psStats.h (revision 1426) @@ -10,6 +10,6 @@ * @author George Gusciora, MHPCC * - * @version $Revision: 1.21 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.22 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -50,41 +50,41 @@ typedef struct { - double sampleMean; // /< formal mean of sample - double sampleMedian; // /< formal median of sample - double sampleStdev; // /< standard deviation of sample - double sampleUQ; // /< upper quartile of sample - double sampleLQ; // /< lower quartile of sample - double sampleLimit; // /< - double robustMean; // /< robust mean of array - double robustMedian; // /< robust median of array - double robustMode; // /< Robust mode of array - double robustStdev; // /< robust standard deviation of array - double robustUQ; // /< robust upper quartile - double robustLQ; // /< robust lower quartile + double sampleMean; ///< formal mean of sample + double sampleMedian; ///< formal median of sample + double sampleStdev; ///< standard deviation of sample + double sampleUQ; ///< upper quartile of sample + double sampleLQ; ///< lower quartile of sample + double sampleLimit; ///< + double robustMean; ///< robust mean of array + double robustMedian; ///< robust median of array + double robustMode; ///< Robust mode of array + double robustStdev; ///< robust standard deviation of array + double robustUQ; ///< robust upper quartile + double robustLQ; ///< robust lower quartile double XXX; - double robustN50; // /< - double robustNfit; // /< - double clippedMean; // /< Nsigma clipped mean - double clippedStdev; // /< standard deviation after clipping - double clipSigma; // /< Nsigma used for clipping; user input - int clipIter; // /< Number of clipping iterations; user input - double min; // /< minimum data value in array - double max; // /< maximum data value in array - double binsize; // /< - psStatsOptions options; // /< bitmask of calculated values + double robustN50; ///< + double robustNfit; ///< + double clippedMean; ///< Nsigma clipped mean + double clippedStdev; ///< standard deviation after clipping + double clipSigma; ///< Nsigma used for clipping; user input + int clipIter; ///< Number of clipping iterations; user input + double min; ///< minimum data value in array + double max; ///< maximum data value in array + double binsize; ///< + psStatsOptions options; ///< bitmask of calculated values } psStats; /** Do Statistics on an array. Returns a status value. \ingroup MathGroup */ -psStats *psVectorStats(psStats * stats, // /< stats structure defines stats to be calculated and how - psVector * in, // /< Vector to be analysed: must be F32 - psVector * mask, // /< Ignore elements where (maskVector & maskVal) != 0: must be INT +psStats *psVectorStats(psStats * stats, ///< stats structure defines stats to be calculated and how + psVector * in, ///< Vector to be analysed: must be F32 + psVector * mask, ///< Ignore elements where (maskVector & maskVal) != 0: must be INT // or NULL - unsigned int maskVal // /< Only mask elements with one of these bits set in + unsigned int maskVal ///< Only mask elements with one of these bits set in // maskVector ); /** A constructor for the stats structure.*/ -psStats *psStatsAlloc(psStatsOptions options); // /< Statistics to measure +psStats *psStatsAlloc(psStatsOptions options); ///< Statistics to measure /****************************************************************************** @@ -95,25 +95,25 @@ typedef struct { - psVector *bounds; // /< Bounds for the bins (type F32) - psVector *nums; // /< Number in each of the bins (INT) - int minNum; // /< Number below the minimum - int maxNum; // /< Number above the maximum - bool uniform; // /< Is it a uniform distribution? + psVector *bounds; ///< Bounds for the bins (type F32) + psVector *nums; ///< Number in each of the bins (INT) + int minNum; ///< Number below the minimum + int maxNum; ///< Number above the maximum + bool uniform; ///< Is it a uniform distribution? } psHistogram; /** Constructor \ingroup MathGroup */ -psHistogram *psHistogramAlloc(float lower, // /< Lower limit for the bins - float upper, // /< Upper limit for the bins - int n); // /< Number of bins +psHistogram *psHistogramAlloc(float lower, ///< Lower limit for the bins + float upper, ///< Upper limit for the bins + int n); ///< Number of bins /** Generic constructor \ingroup MathGroup */ -psHistogram *psHistogramAllocGeneric(const psVector * restrict bounds); // /< Bounds for the bins +psHistogram *psHistogramAllocGeneric(const psVector * restrict bounds); ///< Bounds for the bins /** Calculate a histogram \ingroup MathGroup **/ -psHistogram *psVectorHistogram(psHistogram * out, // /< Histogram data - const psVector * restrict in, // /< Vector to analyse - const psVector * restrict mask, // /< Mask dat for input vector - unsigned int maskVal); // /< Mask value +psHistogram *psVectorHistogram(psHistogram * out, ///< Histogram data + const psVector * restrict in, ///< Vector to analyse + const psVector * restrict mask, ///< Mask dat for input vector + unsigned int maskVal); ///< Mask value bool p_psGetStatValue(const psStats * stats, double *value); Index: /trunk/psLib/src/mathtypes/psImage.h =================================================================== --- /trunk/psLib/src/mathtypes/psImage.h (revision 1425) +++ /trunk/psLib/src/mathtypes/psImage.h (revision 1426) @@ -12,22 +12,25 @@ * @author Ross Harman, MHPCC * - * @version $Revision: 1.28 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.29 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ #ifndef PS_IMAGE_H -# define PS_IMAGE_H +#define PS_IMAGE_H -# include +#include -# include "psType.h" +#include "psType.h" /// @addtogroup Image /// @{ +/** enumeration of options in interpolation + * + */ typedef enum { - PS_INTERPOLATE_FLAT, - PS_INTERPOLATE_BILINEAR + PS_INTERPOLATE_FLAT, ///< 'flat' interpolation (nearest pixel) + PS_INTERPOLATE_BILINEAR ///< bi-linear interpolation } psImageInterpolateMode; @@ -40,29 +43,29 @@ typedef struct psImage { - const psType type; // /< Image data type and dimension. - const unsigned int numCols; // /< Number of columns in image - const unsigned int numRows; // /< Number of rows in image. - const int col0; // /< Column position relative to parent. - const int row0; // /< Row position relative to parent. + const psType type; ///< Image data type and dimension. + const unsigned int numCols; ///< Number of columns in image + const unsigned int numRows; ///< Number of rows in image. + const int col0; ///< Column position relative to parent. + const int row0; ///< Row position relative to parent. union { - psU8 **U8; // /< Unsigned 8-bit integer data. - psU16 **U16; // /< Unsigned 16-bit integer data. - psU32 **U32; // /< Unsigned 32-bit integer data. - psU64 **U64; // /< Unsigned 64-bit integer data. - psS8 **S8; // /< Signed 8-bit integer data. - psS16 **S16; // /< Signed 16-bit integer data. - psS32 **S32; // /< Signed 32-bit integer data. - psS64 **S64; // /< Signed 64-bit integer data. - psF32 **F32; // /< Single-precision float data. - psF64 **F64; // /< Double-precision float data. - psC32 **C32; // /< Single-precision complex data. - psC64 **C64; // /< Double-precision complex data. - psPTR **PTR; // /< Void pointers. - psPTR *V; // /< Pointer to data. - } data; // /< Union for data types. - const struct psImage *parent; // /< Parent, if a subimage. - int nChildren; // /< Number of subimages. - struct psImage **children; // /< Children of this region. + psU8 **U8; ///< Unsigned 8-bit integer data. + psU16 **U16; ///< Unsigned 16-bit integer data. + psU32 **U32; ///< Unsigned 32-bit integer data. + psU64 **U64; ///< Unsigned 64-bit integer data. + psS8 **S8; ///< Signed 8-bit integer data. + psS16 **S16; ///< Signed 16-bit integer data. + psS32 **S32; ///< Signed 32-bit integer data. + psS64 **S64; ///< Signed 64-bit integer data. + psF32 **F32; ///< Single-precision float data. + psF64 **F64; ///< Double-precision float data. + psC32 **C32; ///< Single-precision complex data. + psC64 **C64; ///< Double-precision complex data. + psPTR **PTR; ///< Void pointers. + psPTR *V; ///< Pointer to data. + } data; ///< Union for data types. + const struct psImage *parent; ///< Parent, if a subimage. + int nChildren; ///< Number of subimages. + struct psImage **children; ///< Children of this region. } psImage; @@ -82,7 +85,7 @@ * */ -psImage *psImageAlloc(unsigned int numCols, // /< Number of rows in image. - unsigned int numRows, // /< Number of columns in image. - const psElemType type // /< Type of data for image. +psImage *psImageAlloc(unsigned int numCols, ///< Number of rows in image. + unsigned int numRows, ///< Number of columns in image. + const psElemType type ///< Type of data for image. ); @@ -92,8 +95,8 @@ * */ -psImage *psImageRecycle(psImage * old, // /< the psImage to recycle by resizing image buffer - unsigned int numCols, // /< the desired number of columns in image - unsigned int numRows, // /< the desired number of rows in image - const psElemType type // /< the desired datatype of the image +psImage *psImageRecycle(psImage * old, ///< the psImage to recycle by resizing image buffer + unsigned int numCols, ///< the desired number of columns in image + unsigned int numRows, ///< the desired number of rows in image + const psElemType type ///< the desired datatype of the image ); Index: /trunk/psLib/src/mathtypes/psScalar.h =================================================================== --- /trunk/psLib/src/mathtypes/psScalar.h (revision 1425) +++ /trunk/psLib/src/mathtypes/psScalar.h (revision 1426) @@ -11,6 +11,6 @@ * @author Ross Harman, MHPCC * - * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -32,20 +32,20 @@ typedef struct { - psType type; // /< Type of data. + psType type; ///< Type of data. union { - psU8 U8; // /< Unsigned 8-bit integer data. - psU16 U16; // /< Unsigned 16-bit integer data. - psU32 U32; // /< Unsigned 32-bit integer data. - psU64 U64; // /< Unsigned 64-bit integer data. - psS8 S8; // /< Signed 8-bit integer data. - psS16 S16; // /< Signed 16-bit integer data. - psS32 S32; // /< Signed 32-bit integer data. - psS64 S64; // /< Signed 64-bit integer data. - psF32 F32; // /< Single-precision float data. - psF64 F64; // /< Double-precision float data. - psC32 C32; // /< Single-precision complex data. - psC64 C64; // /< Double-precision complex data. - } data; // /< Union for data types. + psU8 U8; ///< Unsigned 8-bit integer data. + psU16 U16; ///< Unsigned 16-bit integer data. + psU32 U32; ///< Unsigned 32-bit integer data. + psU64 U64; ///< Unsigned 64-bit integer data. + psS8 S8; ///< Signed 8-bit integer data. + psS16 S16; ///< Signed 16-bit integer data. + psS32 S32; ///< Signed 32-bit integer data. + psS64 S64; ///< Signed 64-bit integer data. + psF32 F32; ///< Single-precision float data. + psF64 F64; ///< Double-precision float data. + psC32 C32; ///< Single-precision complex data. + psC64 C64; ///< Double-precision complex data. + } data; ///< Union for data types. } psScalar; @@ -65,6 +65,6 @@ * */ -psScalar *psScalarAlloc(psC64 value, // /< Data to be put into psScalar. - psElemType dataType // /< Type of data to be held by psScalar. +psScalar *psScalarAlloc(psC64 value, ///< Data to be put into psScalar. + psElemType dataType ///< Type of data to be held by psScalar. ); @@ -76,5 +76,5 @@ * */ -void psScalarFree(psScalar * restrict scalar // /< Scalar to free. +void psScalarFree(psScalar * restrict scalar ///< Scalar to free. ); Index: /trunk/psLib/src/mathtypes/psVector.h =================================================================== --- /trunk/psLib/src/mathtypes/psVector.h (revision 1425) +++ /trunk/psLib/src/mathtypes/psVector.h (revision 1426) @@ -12,6 +12,6 @@ * @author Ross Harman, MHPCC * - * @version $Revision: 1.16 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.17 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -33,23 +33,23 @@ typedef struct { - psType type; // /< Type of data. - unsigned int nalloc; // /< Total number of elements available. - unsigned int n; // /< Number of elements in use. + psType type; ///< Type of data. + unsigned int nalloc; ///< Total number of elements available. + unsigned int n; ///< Number of elements in use. union { - psU8 *U8; // /< Unsigned 8-bit integer data. - psU16 *U16; // /< Unsigned 16-bit integer data. - psU32 *U32; // /< Unsigned 32-bit integer data. - psU64 *U64; // /< Unsigned 64-bit integer data. - psS8 *S8; // /< Signed 8-bit integer data. - psS16 *S16; // /< Signed 16-bit integer data. - psS32 *S32; // /< Signed 32-bit integer data. - psS64 *S64; // /< Signed 64-bit integer data. - psF32 *F32; // /< Single-precision float data. - psF64 *F64; // /< Double-precision float data. - psC32 *C32; // /< Single-precision complex data. - psC64 *C64; // /< Double-precision complex data. - psPTR V; // /< Pointer to data. - } data; // /< Union for data types. + psU8 *U8; ///< Unsigned 8-bit integer data. + psU16 *U16; ///< Unsigned 16-bit integer data. + psU32 *U32; ///< Unsigned 32-bit integer data. + psU64 *U64; ///< Unsigned 64-bit integer data. + psS8 *S8; ///< Signed 8-bit integer data. + psS16 *S16; ///< Signed 16-bit integer data. + psS32 *S32; ///< Signed 32-bit integer data. + psS64 *S64; ///< Signed 64-bit integer data. + psF32 *F32; ///< Single-precision float data. + psF64 *F64; ///< Double-precision float data. + psC32 *C32; ///< Single-precision complex data. + psC64 *C64; ///< Double-precision complex data. + psPTR V; ///< Pointer to data. + } data; ///< Union for data types. } psVector; @@ -68,6 +68,6 @@ * */ -psVector *psVectorAlloc(unsigned int nalloc, // /< Total number of elements to make available. - psElemType dataType // /< Type of data to be held by vector. +psVector *psVectorAlloc(unsigned int nalloc, ///< Total number of elements to make available. + psElemType dataType ///< Type of data to be held by vector. ); @@ -80,6 +80,6 @@ * */ -psVector *psVectorRealloc(unsigned int nalloc, // /< Total number of elements to make available. - psVector * restrict psVec // /< Vector to reallocate. +psVector *psVectorRealloc(unsigned int nalloc, ///< Total number of elements to make available. + psVector * restrict psVec ///< Vector to reallocate. ); @@ -93,8 +93,8 @@ */ psVector *psVectorRecycle(psVector * restrict psVec, - // /< Vector to recycle. If NULL, a new vector is created. No effort taken to + ///< Vector to recycle. If NULL, a new vector is created. No effort taken to // preserve the values. - unsigned int nalloc, // /< Total number of elements to make available. - psElemType type // /< the datatype of the returned vector + unsigned int nalloc, ///< Total number of elements to make available. + psElemType type ///< the datatype of the returned vector ); @@ -107,7 +107,7 @@ */ -psVector *psVectorSort(psVector * restrict outVector, // /< the output vector to recycle, or NULL if new +psVector *psVectorSort(psVector * restrict outVector, ///< the output vector to recycle, or NULL if new // vector desired. - const psVector * restrict inVector // /< the vector to sort. + const psVector * restrict inVector ///< the vector to sort. ); Index: /trunk/psLib/src/sys/psAbort.h =================================================================== --- /trunk/psLib/src/sys/psAbort.h (revision 1425) +++ /trunk/psLib/src/sys/psAbort.h (revision 1426) @@ -12,6 +12,6 @@ * @author Eric Van Alst, MHPCC * - * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -37,6 +37,6 @@ * */ -void psAbort(const char *name, // /< Source of abort such as file or function detected - const char *fmt, // /< A printf style formatting statement defining msg +void psAbort(const char *name, ///< Source of abort such as file or function detected + const char *fmt, ///< A printf style formatting statement defining msg ... ); Index: /trunk/psLib/src/sys/psError.h =================================================================== --- /trunk/psLib/src/sys/psError.h (revision 1425) +++ /trunk/psLib/src/sys/psError.h (revision 1426) @@ -13,6 +13,6 @@ * @author Eric Van Alst, MHPCC * - * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -35,6 +35,6 @@ * */ -void psError(const char *name, // /< Source of error such as file or function detected - const char *fmt, // /< A printf style formatting statement defining msg +void psError(const char *name, ///< Source of error such as file or function detected + const char *fmt, ///< A printf style formatting statement defining msg ... ); Index: /trunk/psLib/src/sys/psLogMsg.h =================================================================== --- /trunk/psLib/src/sys/psLogMsg.h (revision 1425) +++ /trunk/psLib/src/sys/psLogMsg.h (revision 1426) @@ -12,6 +12,6 @@ * @author George Gusciora, MHPCC * - * @version $Revision: 1.13 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.14 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -30,5 +30,5 @@ /// In future versions, this procedure will take a character string as an /// argument which can specify more general log destinations. -int psLogSetDestination(const char *dest // /< Specifies where to send messages. +int psLogSetDestination(const char *dest ///< Specifies where to send messages. ); @@ -38,5 +38,5 @@ /// Ie. higher values set by this procedure will cause more log messages to /// be displayed. -int psLogSetLevel(int level // /< Specifies the system log level +int psLogSetLevel(int level ///< Specifies the system log level ); @@ -46,5 +46,5 @@ /// Deleting a letter from the string will cause the associated information /// to not be logged. -void psLogSetFormat(const char *fmt // /< Specifies the system log format +void psLogSetFormat(const char *fmt ///< Specifies the system log format ); @@ -53,15 +53,15 @@ /// specified by a prior call to psLogSetLevel(). The message is specified /// with a printf-stype string an arguments. -void psLogMsg(const char *name, // /< name of the log source - int myLevel, // /< severity level of this log message - const char *fmt, ... // /< printf-style format command +void psLogMsg(const char *name, ///< name of the log source + int myLevel, ///< severity level of this log message + const char *fmt, ... ///< printf-style format command ); /// This procedure is functionally equivalent to psLogMsg(), except that /// it takes a va_list as the message parameter, not a printf-style string. -void psLogMsgV(const char *name, // /< name of the log source - int myLevel, // /< severity level of this log message - const char *fmt, // /< printf-style format command - va_list ap // /< varargs argument list +void psLogMsgV(const char *name, ///< name of the log source + int myLevel, ///< severity level of this log message + const char *fmt, ///< printf-style format command + va_list ap ///< varargs argument list ); Index: /trunk/psLib/src/sys/psMemory.h =================================================================== --- /trunk/psLib/src/sys/psMemory.h (revision 1425) +++ /trunk/psLib/src/sys/psMemory.h (revision 1426) @@ -15,6 +15,6 @@ * @ingroup MemoryManagement * - * @version $Revision: 1.24 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.25 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -63,15 +63,15 @@ typedef struct psMemBlock { - const void *startblock; // /< initialised to p_psMEMMAGIC - struct psMemBlock *previousBlock; // /< previous block in allocation list - struct psMemBlock *nextBlock; // /< next block allocation list - psFreeFcn freeFcn; // /< deallocator. If NULL, use generic deallocation. - size_t userMemorySize; // /< the size of the user-portion of the memory block - const psMemoryId id; // /< a unique ID for this allocation - const char *file; // /< set from __FILE__ in e.g. p_psAlloc - const int lineno; // /< set from __LINE__ in e.g. p_psAlloc - pthread_mutex_t refCounterMutex; // /< mutex to ensure exclusive access to reference counter - psReferenceCount refCounter; // /< how many times pointer is referenced - const void *endblock; // /< initialised to p_psMEMMAGIC + const void *startblock; ///< initialised to p_psMEMMAGIC + struct psMemBlock *previousBlock; ///< previous block in allocation list + struct psMemBlock *nextBlock; ///< next block allocation list + psFreeFcn freeFcn; ///< deallocator. If NULL, use generic deallocation. + size_t userMemorySize; ///< the size of the user-portion of the memory block + const psMemoryId id; ///< a unique ID for this allocation + const char *file; ///< set from __FILE__ in e.g. p_psAlloc + const int lineno; ///< set from __LINE__ in e.g. p_psAlloc + pthread_mutex_t refCounterMutex; ///< mutex to ensure exclusive access to reference counter + psReferenceCount refCounter; ///< how many times pointer is referenced + const void *endblock; ///< initialised to p_psMEMMAGIC } psMemBlock; @@ -82,5 +82,5 @@ * @ingroup memCallback */ -typedef psMemoryId(*psMemAllocateCallback) (const psMemBlock * ptr // /< the psMemBlock just allocated +typedef psMemoryId(*psMemAllocateCallback) (const psMemBlock * ptr ///< the psMemBlock just allocated ); @@ -90,5 +90,5 @@ * @ingroup memCallback */ -typedef psMemoryId(*psMemFreeCallback) (const psMemBlock * ptr // /< the psMemBlock being freed +typedef psMemoryId(*psMemFreeCallback) (const psMemBlock * ptr ///< the psMemBlock being freed ); @@ -100,8 +100,8 @@ * @ingroup memCallback */ -typedef void (*psMemProblemCallback) (const psMemBlock * ptr, // /< the pointer to the problematic memory +typedef void (*psMemProblemCallback) (const psMemBlock * ptr, ///< the pointer to the problematic memory // block. - const char *file, // /< the file in which the problem originated - int lineno // /< the line number in which the problem originated + const char *file, ///< the file in which the problem originated + int lineno ///< the line number in which the problem originated ); @@ -123,10 +123,11 @@ */ # ifdef DOXYGEN -void *psAlloc(size_t size // /< Size required +void *psAlloc(size_t size ///< Size required ); # else - void *p_psAlloc(size_t size, // /< Size required - const char *file, // /< File of call - int lineno // /< Line number of call + + void *p_psAlloc(size_t size, ///< Size required + const char *file, ///< File of call + int lineno ///< Line number of call ); @@ -144,12 +145,13 @@ */ # ifdef DOXYGEN -void *psRealloc(void *ptr // /< Pointer to re-allocate - size_t size, // /< Size required +void *psRealloc(void *ptr ///< Pointer to re-allocate + size_t size, ///< Size required ); # else - void *p_psRealloc(void *ptr, // /< Pointer to re-allocate - size_t size, // /< Size required - const char *file, // /< File of call - int lineno // /< Line number of call + + void *p_psRealloc(void *ptr, ///< Pointer to re-allocate + size_t size, ///< Size required + const char *file, ///< File of call + int lineno ///< Line number of call ); @@ -164,10 +166,11 @@ */ # ifdef DOXYGEN -void psFree(void *ptr, // /< Pointer to free, if NULL, function returns immediately. +void psFree(void *ptr, ///< Pointer to free, if NULL, function returns immediately. ); # else - void p_psFree(void *ptr, // /< Pointer to free - const char *file, // /< File of call - int lineno // /< Line number of call + + void p_psFree(void *ptr, ///< Pointer to free + const char *file, ///< File of call + int lineno ///< Line number of call ); @@ -191,7 +194,7 @@ * @ingroup memTracing */ -int psMemCheckLeaks(psMemoryId id0, // /< don't list blocks with id < id0 - psMemBlock *** arr, // /< pointer to array of pointers to leaked blocks, or NULL - FILE * fd // /< print list of leaks to fd (or NULL) +int psMemCheckLeaks(psMemoryId id0, ///< don't list blocks with id < id0 + psMemBlock *** arr, ///< pointer to array of pointers to leaked blocks, or NULL + FILE * fd ///< print list of leaks to fd (or NULL) ); @@ -201,5 +204,5 @@ * @ingroup memTracing */ -int psMemCheckCorruption(bool abort_on_error // /< Abort on detecting corruption? +int psMemCheckCorruption(bool abort_on_error ///< Abort on detecting corruption? ); @@ -208,5 +211,5 @@ * @ingroup memRefCount */ -psReferenceCount psMemGetRefCounter(void *vptr // /< Pointer to get refCounter for +psReferenceCount psMemGetRefCounter(void *vptr ///< Pointer to get refCounter for ); @@ -216,10 +219,11 @@ */ # ifdef DOXYGEN -void *psMemIncrRefCounter(void *vptr // /< Pointer to increment refCounter, and return +void *psMemIncrRefCounter(void *vptr ///< Pointer to increment refCounter, and return ); # else - void *p_psMemIncrRefCounter(void *vptr, // /< Pointer to increment refCounter, and return - const char *file, // /< File of call - int lineno // /< Line number of call + + void *p_psMemIncrRefCounter(void *vptr, ///< Pointer to increment refCounter, and return + const char *file, ///< File of call + int lineno ///< Line number of call ); @@ -232,10 +236,11 @@ */ # ifdef DOXYGEN -void *psMemDecrRefCounter(void *vptr // /< Pointer to decrement refCounter, and return +void *psMemDecrRefCounter(void *vptr ///< Pointer to decrement refCounter, and return ); # else - void *p_psMemDecrRefCounter(void *vptr, // /< Pointer to decrement refCounter, and return - const char *file, // /< File of call - int lineno // /< Line number of call + + void *p_psMemDecrRefCounter(void *vptr, ///< Pointer to decrement refCounter, and return + const char *file, ///< File of call + int lineno ///< Line number of call ); @@ -246,5 +251,5 @@ * @ingroup memCallback */ -psMemProblemCallback psMemProblemCallbackSet(psMemProblemCallback func // /< Function to run +psMemProblemCallback psMemProblemCallbackSet(psMemProblemCallback func ///< Function to run ); @@ -253,5 +258,5 @@ * @ingroup memCallback */ -psMemExhaustedCallback psMemExhaustedCallbackSet(psMemExhaustedCallback func // /< Function to run +psMemExhaustedCallback psMemExhaustedCallbackSet(psMemExhaustedCallback func ///< Function to run ); @@ -260,5 +265,5 @@ * @ingroup memCallback */ -psMemAllocateCallback psMemAllocateCallbackSet(psMemAllocateCallback func // /< Function to run +psMemAllocateCallback psMemAllocateCallbackSet(psMemAllocateCallback func ///< Function to run ); @@ -267,5 +272,5 @@ * @ingroup memCallback */ -psMemFreeCallback psMemFreeCallbackSet(psMemFreeCallback func // /< Function to run +psMemFreeCallback psMemFreeCallbackSet(psMemFreeCallback func ///< Function to run ); @@ -280,5 +285,5 @@ * @ingroup memCallback */ -psMemoryId psMemAllocateCallbackSetID(psMemoryId id // /< ID to set +psMemoryId psMemAllocateCallbackSetID(psMemoryId id ///< ID to set ); @@ -287,5 +292,5 @@ * @ingroup memCallback */ -psMemoryId psMemFreeCallbackSetID(psMemoryId id // /< ID to set +psMemoryId psMemFreeCallbackSetID(psMemoryId id ///< ID to set ); Index: /trunk/psLib/src/sys/psTrace.h =================================================================== --- /trunk/psLib/src/sys/psTrace.h (revision 1425) +++ /trunk/psLib/src/sys/psTrace.h (revision 1426) @@ -10,6 +10,6 @@ * @author George Gusciora, MHPCC * - * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.13 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -59,17 +59,17 @@ # ifndef DOXYGEN /// Send a trace message -void p_psTrace(const char *facil, // /< facilty of interest - int myLevel, // /< desired trace level - ...) // /< trace message arguments +void p_psTrace(const char *facil, ///< facilty of interest + int myLevel, ///< desired trace level + ...) ///< trace message arguments ; # endif /// Set trace level -int psTraceSetLevel(const char *facil, // /< facilty of interest - int level) // /< desired trace level +int psTraceSetLevel(const char *facil, ///< facilty of interest + int level) ///< desired trace level ; /// Get the trace level -int psTraceGetLevel(const char *facil) // /< facilty of interest +int psTraceGetLevel(const char *facil) ///< facilty of interest ; Index: /trunk/psLib/src/sys/psType.h =================================================================== --- /trunk/psLib/src/sys/psType.h (revision 1425) +++ /trunk/psLib/src/sys/psType.h (revision 1426) @@ -11,6 +11,6 @@ * @author Ross Harman, MHPCC * -* @version $Revision: 1.17 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-07 00:06:06 $ +* @version $Revision: 1.18 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -40,40 +40,40 @@ */ -typedef uint8_t psU8; // /< 8-bit unsigned int -typedef uint16_t psU16; // /< 16-bit unsigned int -typedef uint32_t psU32; // /< 32-bit unsigned int -typedef uint64_t psU64; // /< 64-bit unsigned int -typedef int8_t psS8; // /< 8-bit signed int -typedef int16_t psS16; // /< 16-bit signed int -typedef int32_t psS32; // /< 32-bit signed int -typedef int64_t psS64; // /< 64-bit signed int -typedef float psF32; // /< 32-bit floating point -typedef double psF64; // /< 64-bit floating point -typedef complex float psC32; // /< complex with 32-bit floating point Real and Imagary numbers -typedef complex double psC64; // /< complex with 64-bit floating point Real and Imagary numbers -typedef void *psPTR; // /< void pointer +typedef uint8_t psU8; ///< 8-bit unsigned int +typedef uint16_t psU16; ///< 16-bit unsigned int +typedef uint32_t psU32; ///< 32-bit unsigned int +typedef uint64_t psU64; ///< 64-bit unsigned int +typedef int8_t psS8; ///< 8-bit signed int +typedef int16_t psS16; ///< 16-bit signed int +typedef int32_t psS32; ///< 32-bit signed int +typedef int64_t psS64; ///< 64-bit signed int +typedef float psF32; ///< 32-bit floating point +typedef double psF64; ///< 64-bit floating point +typedef complex float psC32; ///< complex with 32-bit floating point Real and Imagary numbers +typedef complex double psC64; ///< complex with 64-bit floating point Real and Imagary numbers +typedef void *psPTR; ///< void pointer typedef enum { - PS_TYPE_S8 = 0x0101, // /< Character. - PS_TYPE_S16 = 0x0102, // /< Short integer. - PS_TYPE_S32 = 0x0104, // /< Integer. - PS_TYPE_S64 = 0x0108, // /< Long integer. - PS_TYPE_U8 = 0x0301, // /< Unsigned character. - PS_TYPE_U16 = 0x0302, // /< Unsigned short integer. - PS_TYPE_U32 = 0x0304, // /< Unsigned integer. - PS_TYPE_U64 = 0x0308, // /< Unsigned long integer. - PS_TYPE_F32 = 0x0404, // /< Single-precision Floating point. - PS_TYPE_F64 = 0x0408, // /< Double-precision floating point. - PS_TYPE_C32 = 0x0808, // /< Complex numbers consisting of single-precision floating + PS_TYPE_S8 = 0x0101, ///< Character. + PS_TYPE_S16 = 0x0102, ///< Short integer. + PS_TYPE_S32 = 0x0104, ///< Integer. + PS_TYPE_S64 = 0x0108, ///< Long integer. + PS_TYPE_U8 = 0x0301, ///< Unsigned character. + PS_TYPE_U16 = 0x0302, ///< Unsigned short integer. + PS_TYPE_U32 = 0x0304, ///< Unsigned integer. + PS_TYPE_U64 = 0x0308, ///< Unsigned long integer. + PS_TYPE_F32 = 0x0404, ///< Single-precision Floating point. + PS_TYPE_F64 = 0x0408, ///< Double-precision floating point. + PS_TYPE_C32 = 0x0808, ///< Complex numbers consisting of single-precision floating // point. - PS_TYPE_C64 = 0x0810, // /< Complex numbers consisting of double-precision floating + PS_TYPE_C64 = 0x0810, ///< Complex numbers consisting of double-precision floating // point. - PS_TYPE_PTR = 0x0000 // /< Something else that's not supported for arithmetic. + PS_TYPE_PTR = 0x0000 ///< Something else that's not supported for arithmetic. } psElemType; -# define PS_TYPE_MASK PS_TYPE_U8 // /< the psElemType to use for mask image -# define PS_TYPE_MASK_DATA U8 // /< the data member to use for mask image +# define PS_TYPE_MASK PS_TYPE_U8 ///< the psElemType to use for mask image +# define PS_TYPE_MASK_DATA U8 ///< the data member to use for mask image # define PS_TYPE_MASK_NAME "psU8" -typedef psU8 psMaskType; // /< the C datatype for a mask image +typedef psU8 psMaskType; ///< the C datatype for a mask image # define PS_MIN_S8 INT8_MIN @@ -132,9 +132,9 @@ */ typedef enum { - PS_DIMEN_SCALAR, // /< Scalar. - PS_DIMEN_VECTOR, // /< Vector. - PS_DIMEN_TRANSV, // /< Transposed vector. - PS_DIMEN_IMAGE, // /< Image. - PS_DIMEN_OTHER // /< Something else that's not supported for arithmetic. + PS_DIMEN_SCALAR, ///< Scalar. + PS_DIMEN_VECTOR, ///< Vector. + PS_DIMEN_TRANSV, ///< Transposed vector. + PS_DIMEN_IMAGE, ///< Image. + PS_DIMEN_OTHER ///< Something else that's not supported for arithmetic. } psDimen; @@ -147,6 +147,6 @@ typedef struct { - psElemType type; // /< Primitive type. - psDimen dimen; // /< Dimensionality. + psElemType type; ///< Primitive type. + psDimen dimen; ///< Dimensionality. } psType; Index: /trunk/psLib/src/sysUtils/psAbort.h =================================================================== --- /trunk/psLib/src/sysUtils/psAbort.h (revision 1425) +++ /trunk/psLib/src/sysUtils/psAbort.h (revision 1426) @@ -12,6 +12,6 @@ * @author Eric Van Alst, MHPCC * - * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -37,6 +37,6 @@ * */ -void psAbort(const char *name, // /< Source of abort such as file or function detected - const char *fmt, // /< A printf style formatting statement defining msg +void psAbort(const char *name, ///< Source of abort such as file or function detected + const char *fmt, ///< A printf style formatting statement defining msg ... ); Index: /trunk/psLib/src/sysUtils/psError.h =================================================================== --- /trunk/psLib/src/sysUtils/psError.h (revision 1425) +++ /trunk/psLib/src/sysUtils/psError.h (revision 1426) @@ -13,6 +13,6 @@ * @author Eric Van Alst, MHPCC * - * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -35,6 +35,6 @@ * */ -void psError(const char *name, // /< Source of error such as file or function detected - const char *fmt, // /< A printf style formatting statement defining msg +void psError(const char *name, ///< Source of error such as file or function detected + const char *fmt, ///< A printf style formatting statement defining msg ... ); Index: /trunk/psLib/src/sysUtils/psLogMsg.h =================================================================== --- /trunk/psLib/src/sysUtils/psLogMsg.h (revision 1425) +++ /trunk/psLib/src/sysUtils/psLogMsg.h (revision 1426) @@ -12,6 +12,6 @@ * @author George Gusciora, MHPCC * - * @version $Revision: 1.13 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.14 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -30,5 +30,5 @@ /// In future versions, this procedure will take a character string as an /// argument which can specify more general log destinations. -int psLogSetDestination(const char *dest // /< Specifies where to send messages. +int psLogSetDestination(const char *dest ///< Specifies where to send messages. ); @@ -38,5 +38,5 @@ /// Ie. higher values set by this procedure will cause more log messages to /// be displayed. -int psLogSetLevel(int level // /< Specifies the system log level +int psLogSetLevel(int level ///< Specifies the system log level ); @@ -46,5 +46,5 @@ /// Deleting a letter from the string will cause the associated information /// to not be logged. -void psLogSetFormat(const char *fmt // /< Specifies the system log format +void psLogSetFormat(const char *fmt ///< Specifies the system log format ); @@ -53,15 +53,15 @@ /// specified by a prior call to psLogSetLevel(). The message is specified /// with a printf-stype string an arguments. -void psLogMsg(const char *name, // /< name of the log source - int myLevel, // /< severity level of this log message - const char *fmt, ... // /< printf-style format command +void psLogMsg(const char *name, ///< name of the log source + int myLevel, ///< severity level of this log message + const char *fmt, ... ///< printf-style format command ); /// This procedure is functionally equivalent to psLogMsg(), except that /// it takes a va_list as the message parameter, not a printf-style string. -void psLogMsgV(const char *name, // /< name of the log source - int myLevel, // /< severity level of this log message - const char *fmt, // /< printf-style format command - va_list ap // /< varargs argument list +void psLogMsgV(const char *name, ///< name of the log source + int myLevel, ///< severity level of this log message + const char *fmt, ///< printf-style format command + va_list ap ///< varargs argument list ); Index: /trunk/psLib/src/sysUtils/psMemory.h =================================================================== --- /trunk/psLib/src/sysUtils/psMemory.h (revision 1425) +++ /trunk/psLib/src/sysUtils/psMemory.h (revision 1426) @@ -15,6 +15,6 @@ * @ingroup MemoryManagement * - * @version $Revision: 1.24 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.25 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -63,15 +63,15 @@ typedef struct psMemBlock { - const void *startblock; // /< initialised to p_psMEMMAGIC - struct psMemBlock *previousBlock; // /< previous block in allocation list - struct psMemBlock *nextBlock; // /< next block allocation list - psFreeFcn freeFcn; // /< deallocator. If NULL, use generic deallocation. - size_t userMemorySize; // /< the size of the user-portion of the memory block - const psMemoryId id; // /< a unique ID for this allocation - const char *file; // /< set from __FILE__ in e.g. p_psAlloc - const int lineno; // /< set from __LINE__ in e.g. p_psAlloc - pthread_mutex_t refCounterMutex; // /< mutex to ensure exclusive access to reference counter - psReferenceCount refCounter; // /< how many times pointer is referenced - const void *endblock; // /< initialised to p_psMEMMAGIC + const void *startblock; ///< initialised to p_psMEMMAGIC + struct psMemBlock *previousBlock; ///< previous block in allocation list + struct psMemBlock *nextBlock; ///< next block allocation list + psFreeFcn freeFcn; ///< deallocator. If NULL, use generic deallocation. + size_t userMemorySize; ///< the size of the user-portion of the memory block + const psMemoryId id; ///< a unique ID for this allocation + const char *file; ///< set from __FILE__ in e.g. p_psAlloc + const int lineno; ///< set from __LINE__ in e.g. p_psAlloc + pthread_mutex_t refCounterMutex; ///< mutex to ensure exclusive access to reference counter + psReferenceCount refCounter; ///< how many times pointer is referenced + const void *endblock; ///< initialised to p_psMEMMAGIC } psMemBlock; @@ -82,5 +82,5 @@ * @ingroup memCallback */ -typedef psMemoryId(*psMemAllocateCallback) (const psMemBlock * ptr // /< the psMemBlock just allocated +typedef psMemoryId(*psMemAllocateCallback) (const psMemBlock * ptr ///< the psMemBlock just allocated ); @@ -90,5 +90,5 @@ * @ingroup memCallback */ -typedef psMemoryId(*psMemFreeCallback) (const psMemBlock * ptr // /< the psMemBlock being freed +typedef psMemoryId(*psMemFreeCallback) (const psMemBlock * ptr ///< the psMemBlock being freed ); @@ -100,8 +100,8 @@ * @ingroup memCallback */ -typedef void (*psMemProblemCallback) (const psMemBlock * ptr, // /< the pointer to the problematic memory +typedef void (*psMemProblemCallback) (const psMemBlock * ptr, ///< the pointer to the problematic memory // block. - const char *file, // /< the file in which the problem originated - int lineno // /< the line number in which the problem originated + const char *file, ///< the file in which the problem originated + int lineno ///< the line number in which the problem originated ); @@ -123,10 +123,11 @@ */ # ifdef DOXYGEN -void *psAlloc(size_t size // /< Size required +void *psAlloc(size_t size ///< Size required ); # else - void *p_psAlloc(size_t size, // /< Size required - const char *file, // /< File of call - int lineno // /< Line number of call + + void *p_psAlloc(size_t size, ///< Size required + const char *file, ///< File of call + int lineno ///< Line number of call ); @@ -144,12 +145,13 @@ */ # ifdef DOXYGEN -void *psRealloc(void *ptr // /< Pointer to re-allocate - size_t size, // /< Size required +void *psRealloc(void *ptr ///< Pointer to re-allocate + size_t size, ///< Size required ); # else - void *p_psRealloc(void *ptr, // /< Pointer to re-allocate - size_t size, // /< Size required - const char *file, // /< File of call - int lineno // /< Line number of call + + void *p_psRealloc(void *ptr, ///< Pointer to re-allocate + size_t size, ///< Size required + const char *file, ///< File of call + int lineno ///< Line number of call ); @@ -164,10 +166,11 @@ */ # ifdef DOXYGEN -void psFree(void *ptr, // /< Pointer to free, if NULL, function returns immediately. +void psFree(void *ptr, ///< Pointer to free, if NULL, function returns immediately. ); # else - void p_psFree(void *ptr, // /< Pointer to free - const char *file, // /< File of call - int lineno // /< Line number of call + + void p_psFree(void *ptr, ///< Pointer to free + const char *file, ///< File of call + int lineno ///< Line number of call ); @@ -191,7 +194,7 @@ * @ingroup memTracing */ -int psMemCheckLeaks(psMemoryId id0, // /< don't list blocks with id < id0 - psMemBlock *** arr, // /< pointer to array of pointers to leaked blocks, or NULL - FILE * fd // /< print list of leaks to fd (or NULL) +int psMemCheckLeaks(psMemoryId id0, ///< don't list blocks with id < id0 + psMemBlock *** arr, ///< pointer to array of pointers to leaked blocks, or NULL + FILE * fd ///< print list of leaks to fd (or NULL) ); @@ -201,5 +204,5 @@ * @ingroup memTracing */ -int psMemCheckCorruption(bool abort_on_error // /< Abort on detecting corruption? +int psMemCheckCorruption(bool abort_on_error ///< Abort on detecting corruption? ); @@ -208,5 +211,5 @@ * @ingroup memRefCount */ -psReferenceCount psMemGetRefCounter(void *vptr // /< Pointer to get refCounter for +psReferenceCount psMemGetRefCounter(void *vptr ///< Pointer to get refCounter for ); @@ -216,10 +219,11 @@ */ # ifdef DOXYGEN -void *psMemIncrRefCounter(void *vptr // /< Pointer to increment refCounter, and return +void *psMemIncrRefCounter(void *vptr ///< Pointer to increment refCounter, and return ); # else - void *p_psMemIncrRefCounter(void *vptr, // /< Pointer to increment refCounter, and return - const char *file, // /< File of call - int lineno // /< Line number of call + + void *p_psMemIncrRefCounter(void *vptr, ///< Pointer to increment refCounter, and return + const char *file, ///< File of call + int lineno ///< Line number of call ); @@ -232,10 +236,11 @@ */ # ifdef DOXYGEN -void *psMemDecrRefCounter(void *vptr // /< Pointer to decrement refCounter, and return +void *psMemDecrRefCounter(void *vptr ///< Pointer to decrement refCounter, and return ); # else - void *p_psMemDecrRefCounter(void *vptr, // /< Pointer to decrement refCounter, and return - const char *file, // /< File of call - int lineno // /< Line number of call + + void *p_psMemDecrRefCounter(void *vptr, ///< Pointer to decrement refCounter, and return + const char *file, ///< File of call + int lineno ///< Line number of call ); @@ -246,5 +251,5 @@ * @ingroup memCallback */ -psMemProblemCallback psMemProblemCallbackSet(psMemProblemCallback func // /< Function to run +psMemProblemCallback psMemProblemCallbackSet(psMemProblemCallback func ///< Function to run ); @@ -253,5 +258,5 @@ * @ingroup memCallback */ -psMemExhaustedCallback psMemExhaustedCallbackSet(psMemExhaustedCallback func // /< Function to run +psMemExhaustedCallback psMemExhaustedCallbackSet(psMemExhaustedCallback func ///< Function to run ); @@ -260,5 +265,5 @@ * @ingroup memCallback */ -psMemAllocateCallback psMemAllocateCallbackSet(psMemAllocateCallback func // /< Function to run +psMemAllocateCallback psMemAllocateCallbackSet(psMemAllocateCallback func ///< Function to run ); @@ -267,5 +272,5 @@ * @ingroup memCallback */ -psMemFreeCallback psMemFreeCallbackSet(psMemFreeCallback func // /< Function to run +psMemFreeCallback psMemFreeCallbackSet(psMemFreeCallback func ///< Function to run ); @@ -280,5 +285,5 @@ * @ingroup memCallback */ -psMemoryId psMemAllocateCallbackSetID(psMemoryId id // /< ID to set +psMemoryId psMemAllocateCallbackSetID(psMemoryId id ///< ID to set ); @@ -287,5 +292,5 @@ * @ingroup memCallback */ -psMemoryId psMemFreeCallbackSetID(psMemoryId id // /< ID to set +psMemoryId psMemFreeCallbackSetID(psMemoryId id ///< ID to set ); Index: /trunk/psLib/src/sysUtils/psTrace.h =================================================================== --- /trunk/psLib/src/sysUtils/psTrace.h (revision 1425) +++ /trunk/psLib/src/sysUtils/psTrace.h (revision 1426) @@ -10,6 +10,6 @@ * @author George Gusciora, MHPCC * - * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.13 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -59,17 +59,17 @@ # ifndef DOXYGEN /// Send a trace message -void p_psTrace(const char *facil, // /< facilty of interest - int myLevel, // /< desired trace level - ...) // /< trace message arguments +void p_psTrace(const char *facil, ///< facilty of interest + int myLevel, ///< desired trace level + ...) ///< trace message arguments ; # endif /// Set trace level -int psTraceSetLevel(const char *facil, // /< facilty of interest - int level) // /< desired trace level +int psTraceSetLevel(const char *facil, ///< facilty of interest + int level) ///< desired trace level ; /// Get the trace level -int psTraceGetLevel(const char *facil) // /< facilty of interest +int psTraceGetLevel(const char *facil) ///< facilty of interest ; Index: /trunk/psLib/src/sysUtils/psType.h =================================================================== --- /trunk/psLib/src/sysUtils/psType.h (revision 1425) +++ /trunk/psLib/src/sysUtils/psType.h (revision 1426) @@ -11,6 +11,6 @@ * @author Ross Harman, MHPCC * -* @version $Revision: 1.17 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-07 00:06:06 $ +* @version $Revision: 1.18 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -40,40 +40,40 @@ */ -typedef uint8_t psU8; // /< 8-bit unsigned int -typedef uint16_t psU16; // /< 16-bit unsigned int -typedef uint32_t psU32; // /< 32-bit unsigned int -typedef uint64_t psU64; // /< 64-bit unsigned int -typedef int8_t psS8; // /< 8-bit signed int -typedef int16_t psS16; // /< 16-bit signed int -typedef int32_t psS32; // /< 32-bit signed int -typedef int64_t psS64; // /< 64-bit signed int -typedef float psF32; // /< 32-bit floating point -typedef double psF64; // /< 64-bit floating point -typedef complex float psC32; // /< complex with 32-bit floating point Real and Imagary numbers -typedef complex double psC64; // /< complex with 64-bit floating point Real and Imagary numbers -typedef void *psPTR; // /< void pointer +typedef uint8_t psU8; ///< 8-bit unsigned int +typedef uint16_t psU16; ///< 16-bit unsigned int +typedef uint32_t psU32; ///< 32-bit unsigned int +typedef uint64_t psU64; ///< 64-bit unsigned int +typedef int8_t psS8; ///< 8-bit signed int +typedef int16_t psS16; ///< 16-bit signed int +typedef int32_t psS32; ///< 32-bit signed int +typedef int64_t psS64; ///< 64-bit signed int +typedef float psF32; ///< 32-bit floating point +typedef double psF64; ///< 64-bit floating point +typedef complex float psC32; ///< complex with 32-bit floating point Real and Imagary numbers +typedef complex double psC64; ///< complex with 64-bit floating point Real and Imagary numbers +typedef void *psPTR; ///< void pointer typedef enum { - PS_TYPE_S8 = 0x0101, // /< Character. - PS_TYPE_S16 = 0x0102, // /< Short integer. - PS_TYPE_S32 = 0x0104, // /< Integer. - PS_TYPE_S64 = 0x0108, // /< Long integer. - PS_TYPE_U8 = 0x0301, // /< Unsigned character. - PS_TYPE_U16 = 0x0302, // /< Unsigned short integer. - PS_TYPE_U32 = 0x0304, // /< Unsigned integer. - PS_TYPE_U64 = 0x0308, // /< Unsigned long integer. - PS_TYPE_F32 = 0x0404, // /< Single-precision Floating point. - PS_TYPE_F64 = 0x0408, // /< Double-precision floating point. - PS_TYPE_C32 = 0x0808, // /< Complex numbers consisting of single-precision floating + PS_TYPE_S8 = 0x0101, ///< Character. + PS_TYPE_S16 = 0x0102, ///< Short integer. + PS_TYPE_S32 = 0x0104, ///< Integer. + PS_TYPE_S64 = 0x0108, ///< Long integer. + PS_TYPE_U8 = 0x0301, ///< Unsigned character. + PS_TYPE_U16 = 0x0302, ///< Unsigned short integer. + PS_TYPE_U32 = 0x0304, ///< Unsigned integer. + PS_TYPE_U64 = 0x0308, ///< Unsigned long integer. + PS_TYPE_F32 = 0x0404, ///< Single-precision Floating point. + PS_TYPE_F64 = 0x0408, ///< Double-precision floating point. + PS_TYPE_C32 = 0x0808, ///< Complex numbers consisting of single-precision floating // point. - PS_TYPE_C64 = 0x0810, // /< Complex numbers consisting of double-precision floating + PS_TYPE_C64 = 0x0810, ///< Complex numbers consisting of double-precision floating // point. - PS_TYPE_PTR = 0x0000 // /< Something else that's not supported for arithmetic. + PS_TYPE_PTR = 0x0000 ///< Something else that's not supported for arithmetic. } psElemType; -# define PS_TYPE_MASK PS_TYPE_U8 // /< the psElemType to use for mask image -# define PS_TYPE_MASK_DATA U8 // /< the data member to use for mask image +# define PS_TYPE_MASK PS_TYPE_U8 ///< the psElemType to use for mask image +# define PS_TYPE_MASK_DATA U8 ///< the data member to use for mask image # define PS_TYPE_MASK_NAME "psU8" -typedef psU8 psMaskType; // /< the C datatype for a mask image +typedef psU8 psMaskType; ///< the C datatype for a mask image # define PS_MIN_S8 INT8_MIN @@ -132,9 +132,9 @@ */ typedef enum { - PS_DIMEN_SCALAR, // /< Scalar. - PS_DIMEN_VECTOR, // /< Vector. - PS_DIMEN_TRANSV, // /< Transposed vector. - PS_DIMEN_IMAGE, // /< Image. - PS_DIMEN_OTHER // /< Something else that's not supported for arithmetic. + PS_DIMEN_SCALAR, ///< Scalar. + PS_DIMEN_VECTOR, ///< Vector. + PS_DIMEN_TRANSV, ///< Transposed vector. + PS_DIMEN_IMAGE, ///< Image. + PS_DIMEN_OTHER ///< Something else that's not supported for arithmetic. } psDimen; @@ -147,6 +147,6 @@ typedef struct { - psElemType type; // /< Primitive type. - psDimen dimen; // /< Dimensionality. + psElemType type; ///< Primitive type. + psDimen dimen; ///< Dimensionality. } psType; Index: /trunk/psLib/src/types/psArray.h =================================================================== --- /trunk/psLib/src/types/psArray.h (revision 1425) +++ /trunk/psLib/src/types/psArray.h (revision 1426) @@ -12,6 +12,6 @@ * @author Ross Harman, MHPCC * - * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.13 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -34,7 +34,7 @@ typedef struct { - unsigned int nalloc; // /< Total number of elements available. - unsigned int n; // /< Number of elements in use. - psPTR *data; // /< An Array of pointer elements + unsigned int nalloc; ///< Total number of elements available. + unsigned int n; ///< Number of elements in use. + psPTR *data; ///< An Array of pointer elements } psArray; @@ -54,5 +54,5 @@ * */ -psArray *psArrayAlloc(unsigned int nalloc // /< Total number of elements to make available. +psArray *psArrayAlloc(unsigned int nalloc ///< Total number of elements to make available. ); @@ -65,6 +65,6 @@ * */ -psArray *psArrayRealloc(unsigned int nalloc, // /< Total number of elements to make available. - psArray * restrict psArr // /< array to reallocate. +psArray *psArrayRealloc(unsigned int nalloc, ///< Total number of elements to make available. + psArray * restrict psArr ///< array to reallocate. ); @@ -76,5 +76,5 @@ * */ -void psArrayElementFree(psArray * restrict psArr // /< Void pointer array to destroy. +void psArrayElementFree(psArray * restrict psArr ///< Void pointer array to destroy. ); Index: /trunk/psLib/src/types/psHash.h =================================================================== --- /trunk/psLib/src/types/psHash.h (revision 1425) +++ /trunk/psLib/src/types/psHash.h (revision 1426) @@ -11,6 +11,6 @@ * @author George Gusciora, MHPCC * - * @version $Revision: 1.1 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-09 20:29:43 $ + * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -29,7 +29,7 @@ typedef struct psHashBucket { - char *key; // /< key for this item of data - void *data; // /< the data itself - struct psHashBucket *next; // /< list of other possible keys + char *key; ///< key for this item of data + void *data; ///< the data itself + struct psHashBucket *next; ///< list of other possible keys } psHashBucket; @@ -40,31 +40,31 @@ typedef struct psHash { - int nbucket; // /< Number of buckets in hash table. - psHashBucket **buckets; // /< The bucket data. + int nbucket; ///< Number of buckets in hash table. + psHashBucket **buckets; ///< The bucket data. } psHash; /// Allocate hash buckets in table. -psHash *psHashAlloc(int nbucket // /< The number of buckets to allocate. +psHash *psHashAlloc(int nbucket ///< The number of buckets to allocate. ); /// Insert entry into table. -bool psHashAdd(psHash * table, // /< table to insert in - const char *key, // /< key to use - void *data // /< data to insert +bool psHashAdd(psHash * table, ///< table to insert in + const char *key, ///< key to use + void *data ///< data to insert ); /// Lookup key in table. -void *psHashLookup(psHash * table, // /< table to lookup key in - const char *key // /< key to lookup +void *psHashLookup(psHash * table, ///< table to lookup key in + const char *key ///< key to lookup ); /// Remove key from table. -bool psHashRemove(psHash * table, // /< table to lookup key in - const char *key // /< key to lookup +bool psHashRemove(psHash * table, ///< table to lookup key in + const char *key ///< key to lookup ); /// List all keys in table. -psList *psHashKeyList(psHash * table // /< table to list keys from. +psList *psHashKeyList(psHash * table ///< table to list keys from. ); Index: /trunk/psLib/src/types/psList.h =================================================================== --- /trunk/psLib/src/types/psList.h (revision 1425) +++ /trunk/psLib/src/types/psList.h (revision 1426) @@ -10,6 +10,6 @@ * @ingroup LinkedList * - * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-07 00:06:06 $ + * @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -33,10 +33,10 @@ */ enum { - PS_LIST_HEAD = 0, // /< at head - PS_LIST_TAIL = -1, // /< at tail - PS_LIST_PREVIOUS = -2, // /< previous element - PS_LIST_CURRENT = -3, // /< current element - PS_LIST_NEXT = -4, // /< next element - PS_LIST_UNKNOWN = -5 // /< unknown position (should be last in enum list) + PS_LIST_HEAD = 0, ///< at head + PS_LIST_TAIL = -1, ///< at tail + PS_LIST_PREVIOUS = -2, ///< previous element + PS_LIST_CURRENT = -3, ///< current element + PS_LIST_NEXT = -4, ///< next element + PS_LIST_UNKNOWN = -5 ///< unknown position (should be last in enum list) }; @@ -44,7 +44,7 @@ typedef struct psListElem { - struct psListElem *prev; // /< previous link in list - struct psListElem *next; // /< next link in list - void *data; // /< real data item + struct psListElem *prev; ///< previous link in list + struct psListElem *next; ///< next link in list + void *data; ///< real data item } psListElem; @@ -57,10 +57,10 @@ typedef struct { - unsigned int size; // /< number of elements on list - psListElem *head; // /< first element on list (may be NULL) - psListElem *tail; // /< last element on list (may be NULL) - psListElem *iter; // /< iteration cursor - unsigned int iterIndex; // /< the numeric position of the iteration cursor in the list - pthread_mutex_t lock; // /< mutex to lock a node during changes + unsigned int size; ///< number of elements on list + psListElem *head; ///< first element on list (may be NULL) + psListElem *tail; ///< last element on list (may be NULL) + psListElem *iter; ///< iteration cursor + unsigned int iterIndex; ///< the numeric position of the iteration cursor in the list + pthread_mutex_t lock; ///< mutex to lock a node during changes } psList; @@ -71,5 +71,5 @@ */ psList *psListAlloc(void *data - // /< initial data item; may be NULL if no an empty psList is desired + ///< initial data item; may be NULL if no an empty psList is desired ) ; @@ -80,7 +80,7 @@ * NULL, the return value will also be NULL. */ -bool psListAdd(psList * restrict list, // /< list to add to (if NULL, nothing is done) - void *data, // /< data item to add. If NULL, list is not modified. - int where // /< index, PS_LIST_HEAD, PS_LIST_TAIL, or numbered location. +bool psListAdd(psList * restrict list, ///< list to add to (if NULL, nothing is done) + void *data, ///< data item to add. If NULL, list is not modified. + int where ///< index, PS_LIST_HEAD, PS_LIST_TAIL, or numbered location. ); @@ -90,9 +90,9 @@ */ bool psListRemove(psList * restrict list, - // /< list to remove element from + ///< list to remove element from void *data, - // /< if which is PS_LIST_UNKNOWN, data item to find and remove, otherwise this is ignored. + ///< if which is PS_LIST_UNKNOWN, data item to find and remove, otherwise this is ignored. int which - // /< index of item, or PS_LIST_UNKNOWN, PS_LIST_NEXT, PS_LIST_PREV, or numbered location. + ///< index of item, or PS_LIST_UNKNOWN, PS_LIST_NEXT, PS_LIST_PREV, or numbered location. ); @@ -104,6 +104,6 @@ * NULL is returned. */ -void *psListGet(psList * restrict list, // /< list to retrieve element from - int which // /< index number, or PS_LIST_NEXT, PS_LIST_PREV, PS_LIST_UNKNOWN +void *psListGet(psList * restrict list, ///< list to retrieve element from + int which ///< index number, or PS_LIST_NEXT, PS_LIST_PREV, PS_LIST_UNKNOWN ); @@ -112,6 +112,6 @@ * */ -void psListSetIterator(psList * restrict list, // /< list to retrieve element from - int where // /< index number, PS_LIST_HEAD, or PS_LIST_TAIL +void psListSetIterator(psList * restrict list, ///< list to retrieve element from + int where ///< index number, PS_LIST_HEAD, or PS_LIST_TAIL ); @@ -123,5 +123,5 @@ * parameter was NULL. */ -void *psListGetNext(psList * restrict list // /< list to retrieve element from +void *psListGetNext(psList * restrict list ///< list to retrieve element from ); @@ -133,5 +133,5 @@ * iterator is not valid or list parameter was NULL. */ -void *psListGetCurrent(psList * restrict list // /< list to retrieve element from +void *psListGetCurrent(psList * restrict list ///< list to retrieve element from ); @@ -143,5 +143,5 @@ * parameter was NULL. */ -void *psListGetPrevious(psList * restrict list // /< list to retrieve element from +void *psListGetPrevious(psList * restrict list ///< list to retrieve element from ); @@ -151,5 +151,5 @@ * or NULL if the given dlist parameter is NULL. */ -psArray *psListToArray(psList * dlist // /< List to convert +psArray *psListToArray(psList * dlist ///< List to convert ); @@ -159,5 +159,5 @@ * or NULL is the given arr parameter is NULL. */ -psList *psArrayToList(psArray * arr // /< vector to convert +psList *psArrayToList(psArray * arr ///< vector to convert ); Index: /trunk/psLib/src/types/psMetadata.h =================================================================== --- /trunk/psLib/src/types/psMetadata.h (revision 1425) +++ /trunk/psLib/src/types/psMetadata.h (revision 1426) @@ -11,6 +11,6 @@ * @author Ross Harman, MHPCC * -* @version $Revision: 1.16 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-07 00:06:06 $ +* @version $Revision: 1.17 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-09 22:44:25 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -34,16 +34,16 @@ */ typedef enum { - PS_META_ITEM_SET = 0, // /< Null. Metadata is in psMetadataItem.items - PS_META_BOOL, // /< Boolean data. - PS_META_S32, // /< Signed 32-bit integer data. - PS_META_F32, // /< Single-precision float data. - PS_META_F64, // /< Double-precision float data. - PS_META_STR, // /< String data (Stored in as void *). - PS_META_IMG, // /< Image data (Stored in as void *). - PS_META_JPEG, // /< JPEG data (Stored in as void . - PS_META_PNG, // /< PNG data (Stored in as void *). - PS_META_ASTROM, // /< Astrometric coefficients (Stored in as void *). - PS_META_UNKNOWN, // /< Other data (Stored in as void *). - PS_META_NTYPE // /< Number of types. Must be last. + PS_META_ITEM_SET = 0, ///< Null. Metadata is in psMetadataItem.items + PS_META_BOOL, ///< Boolean data. + PS_META_S32, ///< Signed 32-bit integer data. + PS_META_F32, ///< Single-precision float data. + PS_META_F64, ///< Double-precision float data. + PS_META_STR, ///< String data (Stored in as void *). + PS_META_IMG, ///< Image data (Stored in as void *). + PS_META_JPEG, ///< JPEG data (Stored in as void . + PS_META_PNG, ///< PNG data (Stored in as void *). + PS_META_ASTROM, ///< Astrometric coefficients (Stored in as void *). + PS_META_UNKNOWN, ///< Other data (Stored in as void *). + PS_META_NTYPE ///< Number of types. Must be last. } psMetadataType; @@ -55,16 +55,16 @@ typedef struct psMetadataItem { - const int id; // /< Unique ID for metadata item. - char *restrict name; // /< Name of metadata item. - psMetadataType type; // /< Type of metadata item. + const int id; ///< Unique ID for metadata item. + char *restrict name; ///< Name of metadata item. + psMetadataType type; ///< Type of metadata item. union { bool B; - psS32 S32; // /< Signed 32-bit integer data. - psF32 F32; // /< Single-precision float data. - psF64 F64; // /< Double-precision float data. - psPTR V; // /< Pointer to other type of data. - } data; // /< Union for data types. - char *comment; // /< Optional comment ("", not NULL). - psList *restrict items; // /< List of psMetadataItems with same name. + psS32 S32; ///< Signed 32-bit integer data. + psF32 F32; ///< Single-precision float data. + psF64 F64; ///< Double-precision float data. + psPTR V; ///< Pointer to other type of data. + } data; ///< Union for data types. + char *comment; ///< Optional comment ("", not NULL). + psList *restrict items; ///< List of psMetadataItems with same name. } psMetadataItem; @@ -102,8 +102,8 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataItemAlloc(const char *name, // /< Name of metadata item. - psMetadataType type, // /< Type of metadata item. - const char *comment, // /< Comment for metadata item. - ... // /< Arguments for name formatting and metadata item data. +psMetadataItem *psMetadataItemAlloc(const char *name, ///< Name of metadata item. + psMetadataType type, ///< Type of metadata item. + const char *comment, ///< Comment for metadata item. + ... ///< Arguments for name formatting and metadata item data. ); @@ -121,8 +121,8 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataItemAllocV(const char *name, // /< Name of metadata item. - psMetadataType type, // /< Type of metadata item. - const char *comment, // /< Comment for metadata item. - va_list list // /< Arguments for name formatting and metadata item +psMetadataItem *psMetadataItemAllocV(const char *name, ///< Name of metadata item. + psMetadataType type, ///< Type of metadata item. + const char *comment, ///< Comment for metadata item. + va_list list ///< Arguments for name formatting and metadata item // data. ); @@ -134,5 +134,5 @@ * @return psMetadata*: Pointer metadata. */ -psMetadata *psMetadataAlloc(void // /< Void. +psMetadata *psMetadataAlloc(void ///< Void. ); @@ -143,7 +143,7 @@ * @return bool: True for success, false for failure. */ -bool psMetadataAddItem(psMetadata * restrict md, // /< Metadata collection to insert metadat item. - int where, // /< Location to be added. - psMetadataItem * restrict item // /< Metadata item to be added. +bool psMetadataAddItem(psMetadata * restrict md, ///< Metadata collection to insert metadat item. + int where, ///< Location to be added. + psMetadataItem * restrict item ///< Metadata item to be added. ); @@ -154,10 +154,10 @@ * @return bool: True for success, false for failure. */ -bool psMetadataAdd(psMetadata * restrict md, // /< Metadata collection to insert metadat item. - int where, // /< Location to be added. - const char *name, // /< Name of metadata item. - psMetadataType type, // /< Type of metadata item. - const char *comment, // /< Comment for metadata item. - ... // /< Arguments for name formatting and metadata item data. +bool psMetadataAdd(psMetadata * restrict md, ///< Metadata collection to insert metadat item. + int where, ///< Location to be added. + const char *name, ///< Name of metadata item. + psMetadataType type, ///< Type of metadata item. + const char *comment, ///< Comment for metadata item. + ... ///< Arguments for name formatting and metadata item data. ); @@ -171,7 +171,7 @@ * @return bool: True for success, false for failure. */ -bool psMetadataRemove(psMetadata * restrict md, // /< Metadata collection to insert metadat item. - int where, // /< Location to be removed. - const char *restrict key // /< Name of metadata key. +bool psMetadataRemove(psMetadata * restrict md, ///< Metadata collection to insert metadat item. + int where, ///< Location to be removed. + const char *restrict key ///< Name of metadata key. ); @@ -183,7 +183,7 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataLookup(psMetadata * restrict md, // /< Metadata collection to insert metadat +psMetadataItem *psMetadataLookup(psMetadata * restrict md, ///< Metadata collection to insert metadat // item. - const char *restrict key // /< Name of metadata key. + const char *restrict key ///< Name of metadata key. ); @@ -194,6 +194,6 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataGet(psMetadata * restrict md, // /< Metadata collection to insert metadat item. - int where // /< Location to be retrieved. +psMetadataItem *psMetadataGet(psMetadata * restrict md, ///< Metadata collection to insert metadat item. + int where ///< Location to be retrieved. ); @@ -204,6 +204,6 @@ * @return void: void. */ -bool psMetadataSetIterator(psMetadata * restrict md, // /< Metadata collection to iterate. - int where // /< Location of iterator. +bool psMetadataSetIterator(psMetadata * restrict md, ///< Metadata collection to iterate. + int where ///< Location of iterator. ); @@ -214,7 +214,7 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataGetNext(psMetadata * restrict md, // /< Metadata collection to iterate. - const char *restrict match, // /< Beginning of key name. - int which // /< Iterator to be used. +psMetadataItem *psMetadataGetNext(psMetadata * restrict md, ///< Metadata collection to iterate. + const char *restrict match, ///< Beginning of key name. + int which ///< Iterator to be used. ); @@ -225,7 +225,7 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataGetPrevious(psMetadata * restrict md, // /< Metadata collection to iterate. - const char *restrict match, // /< Beginning of key name. - int which // /< Iterator to be used. +psMetadataItem *psMetadataGetPrevious(psMetadata * restrict md, ///< Metadata collection to iterate. + const char *restrict match, ///< Beginning of key name. + int which ///< Iterator to be used. ); @@ -240,7 +240,7 @@ * @return psMetadataItem*: Pointer metadata item. */ -void psMetadataItemPrint(FILE * fd, // /< Pointer to file to write metadata item. - const char *format, // /< Format to print metadata item. - const psMetadataItem * restrict metadataItem // /< Metadata item to print. +void psMetadataItemPrint(FILE * fd, ///< Pointer to file to write metadata item. + const char *format, ///< Format to print metadata item. + const psMetadataItem * restrict metadataItem ///< Metadata item to print. ); @@ -252,8 +252,8 @@ * @return psMetadata*: Pointer metadata. */ -psMetadata *psMetadataReadHeader(psMetadata * output, // /< Resulting metadata from read. - char *extname, // /< File name extension string. - int extnum, // /< File name extension number. Starts at 1. - char *filename // /< Name of file to read. +psMetadata *psMetadataReadHeader(psMetadata * output, ///< Resulting metadata from read. + char *extname, ///< File name extension string. + int extnum, ///< File name extension number. Starts at 1. + char *filename ///< Name of file to read. ); @@ -264,8 +264,8 @@ * @return psMetadata*: Pointer metadata. */ -psMetadata *psMetadataFReadHeader(psMetadata * output, // /< Resulting metadata from read. - char *extName, // /< File name extension string. - int extNum, // /< File name extension number. - fitsfile * fd // /< Pointer to file to read. +psMetadata *psMetadataFReadHeader(psMetadata * output, ///< Resulting metadata from read. + char *extName, ///< File name extension string. + int extNum, ///< File name extension number. + fitsfile * fd ///< Pointer to file to read. );