Index: trunk/archive/pslib/include/psObjects.h =================================================================== --- trunk/archive/pslib/include/psObjects.h (revision 149) +++ trunk/archive/pslib/include/psObjects.h (revision 153) @@ -20,24 +20,24 @@ /***********************************************************************************************************/ -/* Object definition, to handle both objects we detect, and catalogues */ +/** Object definition, to handle both objects we detect, and catalogues */ typedef struct { - psOTAPos *otaPos; // Centre position on OTA, with associated error - psSkyPos *skyPos; // Position on the sky, with associated error - float mag, magErr; // Magnitude and associated error - float isoMag, isoMagErr; // Isophotal magnitude and associated error - float fwhm, fwhmErr; // FWHM and associated error - float ellipA, ellipB; // Elliptical semi-major (A) and semi-minor (B) axes - float ellipAngle; // Ellipse position angle - float sky, skyErr; // Local sky level, and associated error - float colour, colourErr; // Colour and associated error, if known - enum psColourRef colourRef; // Colour reference - psBitMask *quality; // Bit mask for quality information + psOTAPos *otaPos; //!< Centre position on OTA, with associated error + psSkyPos *skyPos; //!< Position on the sky, with associated error + float mag, magErr; //!< Magnitude and associated error + float isoMag, isoMagErr; //!< Isophotal magnitude and associated error + float fwhm, fwhmErr; //!< FWHM and associated error + float ellipA, ellipB; //!< Elliptical semi-major (A) and semi-minor (B) axes + float ellipAngle; //!< Ellipse position angle + float sky, skyErr; //!< Local sky level, and associated error + float colour, colourErr; //!< Colour and associated error, if known + enum psColourRef colourRef; //!< Colour reference + psBitMask *quality; //!< Bit mask for quality information } psObject; -/* Constructor */ +/** Constructor */ psObject * psObjectNew(void); -/* Destructor */ +/** Destructor */ void psObjectDel(psObject *restrict myObject); @@ -45,5 +45,5 @@ /***********************************************************************************************************/ -/* An assembly of objects */ +/** An assembly of objects */ PS_DECLARE_ARRAY_TYPE(psObject); PS_CREATE_ARRAY_TYPE(psObject); @@ -51,63 +51,63 @@ /***********************************************************************************************************/ -/* Associates objects on an image with the image */ +/** Associates objects on an image with the image */ typedef struct { - const psImage *image; // Image that produced the objects, which has metadata we need - psObjectArray *objects; // The objects + const psImage *image; //!< Image that produced the objects, which has metadata we need + psObjectArray *objects; //!< The objects } psImageObjects; -/* Constructor */ +/** Constructor */ psImageObjects * -psImageObjectsNew(const psImage *image, // Image that produced the objects, which has metadata we need - psObjectArray *objects // The objects +psImageObjectsNew(const psImage *image, //!< Image that produced the objects, which has metadata we need + psObjectArray *objects //!< The objects ); -/* Destructor */ +/** Destructor */ void -psImageObjectsDel(psImageObjects *restrict myImageObjects // Object to destroy +psImageObjectsDel(psImageObjects *restrict myImageObjects //!< Object to destroy ); /***********************************************************************************************************/ -/* Objects from a catalogue */ +/** Objects from a catalogue */ typedef struct { - enum psCatalogue catalogue; // Source catalogue from which objects come - psObjectArray *object; // The objects + enum psCatalogue catalogue; //!< Source catalogue from which objects come + psObjectArray *object; //!< The objects } psCatalogueObjects; -/* Constructor */ +/** Constructor */ psCatalogueObjects * -psCatalogueObjectsNew(enum psCatalogue *catalogue, // Source catalogue - psObjectArray *objects // The objects +psCatalogueObjectsNew(enum psCatalogue *catalogue, //!< Source catalogue + psObjectArray *objects //!< The objects ); -/* Destructor */ +/** Destructor */ void -psCatalogueObjectsDel(psCatalogeObjects *restrict myCatalogueObjects // Object to destroy +psCatalogueObjectsDel(psCatalogeObjects *restrict myCatalogueObjects //!< Object to destroy ); /***********************************************************************************************************/ -/* A "super" object --- an object with multiple detections in different images */ +/** A "super" object --- an object with multiple detections in different images */ typedef struct { - const psImageArray *images; // Images that provided the different measurements - const psObjectArray *objects; // Individual object measurements + const psImageArray *images; //!< Images that provided the different measurements + const psObjectArray *objects; //!< Individual object measurements /* Derived quantities */ - psSkyPos *meanSkyPos; // Mean position on the sky - double pmRA, pmDec; // Proper motion in RA and Dec - double pmRAErr, pmDecErr; // Errors in proper motion - float posChi2; // chi^2 for position + psSkyPos *meanSkyPos; //!< Mean position on the sky + double pmRA, pmDec; //!< Proper motion in RA and Dec + double pmRAErr, pmDecErr; //!< Errors in proper motion + float posChi2; //!< chi^2 for position } psSuperObject; -/* Constructor */ +/** Constructor */ psSuperObject * -psSuperObjectNew(const psImageArray *images, // The images with the measurements - const psObjectArray *objects // Object measurements +psSuperObjectNew(const psImageArray *images, //!< The images with the measurements + const psObjectArray *objects //!< Object measurements ); -/* Destructor */ +/** Destructor */ void -psSuperObjectDel(psSuperObject *restrict mySuperObject // Object to destroy +psSuperObjectDel(psSuperObject *restrict mySuperObject //!< Object to destroy ); @@ -118,27 +118,27 @@ -/* Correlate two OTA object arrays */ -/* +/** Correlate two OTA object arrays. * Returns an array with the indices of the object in the second bunch that matched the corresponding object * in the first bunch, or -1 if none that match. */ psIntArray * -psCorrelateObjects(const psObjectArray *restrict myObjects1, // First bunch of objects - const psObjectArray *restrict myObjects2, // Second bunch of objects - const psOTADescription *myOTA1, // OTA description for first bunch of objects, or NULL for - // sky - const psOTADescription *myOTA2 // OTA description for second bunch of objects, or NULL for - // sky +psCorrelateObjects(const psObjectArray *restrict myObjects1, //!< First bunch of objects + const psObjectArray *restrict myObjects2, //!< Second bunch of objects + const psOTADescription *myOTA1, //!< OTA description for first bunch of objects, or NULL for + //!< sky + const psOTADescription *myOTA2 //!< OTA description for second bunch of objects, or NULL for + //!< sky ); -/* Get matched lists from a correlated index array */ -/* Returns a status number, and matched1 and matched2 are manipulated to contain matches */ +/** Get matched lists from a correlated index array Returns a status number, and matched1 and matched2 + * are manipulated to contain matches + */ int -psGetCorrelatedMatches(const psIntArray matches, // Index array specifying matches */ - const psObjectArray *restrict myObjects1, // First bunch of objects - const psObjectArray *restrict myObjects2, // Second bunch of objects - psObjectArray *matched1, // Matched objects in first bunch - psObjectArray *matched2 // Matched objects in second bunch +psGetCorrelatedMatches(const psIntArray matches, //!< Index array specifying matches */ + const psObjectArray *restrict myObjects1, //!< First bunch of objects + const psObjectArray *restrict myObjects2, //!< Second bunch of objects + psObjectArray *matched1, //!< Matched objects in first bunch + psObjectArray *matched2 //!< Matched objects in second bunch ); @@ -147,25 +147,25 @@ /* Object selection */ -/* Get objects within a particular magnitude range */ +/** Get objects within a particular magnitude range */ psObjectArray * -psSelectObjectMag(psObjectArray *restrict myArray, // Bunch of objects to select from - float magLower, // Lower bound for magnitude - float magUpper // Upper bound for magnitude +psSelectObjectMag(psObjectArray *restrict myArray, //!< Bunch of objects to select from + float magLower, //!< Lower bound for magnitude + float magUpper //!< Upper bound for magnitude ); -/* Get objects within a radius on the sky */ +/** Get objects within a radius on the sky */ psObjectArray * -psSelectObjectSkyDist(psObjectArray *restrict myArray, // Bunch of objects to select from - psSkyPos *skyPos, // Position on the sky - float radius, // Radius of search - int circleOrSquare // Circle = 1, Square = 2 +psSelectObjectSkyDist(psObjectArray *restrict myArray, //!< Bunch of objects to select from + psSkyPos *skyPos, //!< Position on the sky + float radius, //!< Radius of search + int circleOrSquare //!< Circle = 1, Square = 2 ); -/* Get objects within a particular colour range */ +/** Get objects within a particular colour range */ psObjectArray * -psSelectObjectColour(psObjectArray *restrict myArray, // Bunch of objects to select from - float magLower, // Lower bound for colour - float magUpper, // Upper bound for colour - enum psColourRef colourRef // Only select those with this colour reference +psSelectObjectColour(psObjectArray *restrict myArray, //!< Bunch of objects to select from + float magLower, //!< Lower bound for colour + float magUpper, //!< Upper bound for colour + enum psColourRef colourRef //!< Only select those with this colour reference );