Index: /trunk/psModules/src/pmObjects.h =================================================================== --- /trunk/psModules/src/pmObjects.h (revision 3599) +++ /trunk/psModules/src/pmObjects.h (revision 3600) @@ -5,6 +5,6 @@ * @author GLG, MHPCC * - * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-03-25 23:18:35 $ + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-03-31 23:45:22 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -26,16 +26,16 @@ typedef enum { - PM_PEAK_LONE, // Isolated peak. - PM_PEAK_EDGE, // Peak on edge. - PM_PEAK_FLAT, // Peak has equal-value neighbors. - PM_PEAK_UNDEF // Undefined. + PM_PEAK_LONE, ///< Isolated peak. + PM_PEAK_EDGE, ///< Peak on edge. + PM_PEAK_FLAT, ///< Peak has equal-value neighbors. + PM_PEAK_UNDEF ///< Undefined. } psPeakType; typedef struct { - psS32 x; // X-coordinate of peak pixel. - psS32 y; // Y-coordinate of peak pixel. - psF32 counts; // Value of peak pixel (above sky?). - psPeakType class; // Description of peak. + psS32 x; ///< X-coordinate of peak pixel. + psS32 y; ///< Y-coordinate of peak pixel. + psF32 counts; ///< Value of peak pixel (above sky?). + psPeakType class; ///< Description of peak. } psPeak; @@ -43,24 +43,24 @@ typedef struct { - psF32 x; // X-coord of centroid. - psF32 y; // Y-coord of centroid. - psF32 Sx; // x-second moment. - psF32 Sy; // y-second moment. - psF32 Sxy; // xy cross moment. - psF32 Sum; // Pixel sum above sky (background). - psF32 Peak; // Peak counts above sky. - psF32 Sky; // Sky level (background). - psS32 nPixels; // Number of pixels used. + psF32 x; ///< X-coord of centroid. + psF32 y; ///< Y-coord of centroid. + psF32 Sx; ///< x-second moment. + psF32 Sy; ///< y-second moment. + psF32 Sxy; ///< xy cross moment. + psF32 Sum; ///< Pixel sum above sky (background). + psF32 Peak; ///< Peak counts above sky. + psF32 Sky; ///< Sky level (background). + psS32 nPixels; ///< Number of pixels used. } psMoments; typedef enum { - PS_MODEL_GAUSS, - PS_MODEL_PGAUSS, - PS_MODEL_TWIST_GAUSS, - PS_MODEL_WAUSS, - PS_MODEL_SERSIC, - PS_MODEL_SERSIC_CORE, - PS_MODEL_UNDEFINED + PS_MODEL_GAUSS, ///< Regular 2-D Gaussian + PS_MODEL_PGAUSS, ///< Psuedo 2-D Gaussian + PS_MODEL_TWIST_GAUSS, ///< 2-D Twisted Gaussian + PS_MODEL_WAUSS, ///< 2-D Waussian + PS_MODEL_SERSIC, ///< Sersic + PS_MODEL_SERSIC_CORE, ///< Sersic Core + PS_MODEL_UNDEFINED ///< Undefined } psModelType; @@ -68,9 +68,9 @@ typedef struct { - psModelType type; // Model to be used. - psS32 Nparams; // Number of parameters. - psF32 *params; // Paramater values. - psF32 *dparams; // Parameter errors. - psF32 chisq; // Fit chi-squared. + psModelType type; ///< Model to be used. + psS32 Nparams; ///< Number of parameters. + psF32 *params; ///< Paramater values. + psF32 *dparams; ///< Parameter errors. + psF32 chisq; ///< Fit chi-squared. } psModel; @@ -90,17 +90,19 @@ typedef struct { - psPeak *peak; // Description of peak pixel. - psImage *pixels; // Rectangular region including object pixels. - psImage *mask; // Mask which marks pixels associated with objects. - psMoments *moments; // Basic moments measure for the object. - psModel *models; // Model parameters and type. - psSourceType type; // Best identification of object. + psPeak *peak; ///< Description of peak pixel. + psImage *pixels; ///< Rectangular region including object pixels. + psImage *mask; ///< Mask which marks pixels associated with objects. + psMoments *moments; ///< Basic moments measure for the object. + psModel *models; ///< Model parameters and type. + psSourceType type; ///< Best identification of object. } psSource; -psPeak *pmPeakAlloc(psS32 x, - psS32 y, - psF32 counts, - psPeakType class); +psPeak *pmPeakAlloc(psS32 x, ///< Row-coordinate in image space + psS32 y, ///< Col-coordinate in image space + psF32 counts, ///< The value of the peak pixel + psPeakType class ///< The type of peak pixel + ); + psMoments *pmMomentsAlloc(); psModel *pmModelAlloc(psModelType type); @@ -112,6 +114,7 @@ the location (x value) of all peaks. *****************************************************************************/ -psVector *pmFindVectorPeeks(const psVector *vector, - psF32 threshold); +psVector *pmFindVectorPeeks(const psVector *vector, ///< The input vector (psF32) + psF32 threshold ///< Threshold above which to find a peak + ); /****************************************************************************** @@ -120,6 +123,7 @@ value) of all peaks. *****************************************************************************/ -psList *pmFindImagePeeks(const psImage *image, - psF32 threshold); +psList *pmFindImagePeeks(const psImage *image, ///< The input image where peaks will be found (psF32) + psF32 threshold ///< Threshold above which to find a peak + ); /****************************************************************************** @@ -129,11 +133,8 @@ XXX: Do we free the psList elements of those culled peaks? *****************************************************************************/ -psList *pmCullPeeks(psList *peaks, - psF32 maxValue, - const psRegion *valid); - -//psList *pmCullPeeks(psF32 *peaks, -// psF32 maxValue, -// psF32 *valid); +psList *pmCullPeeks(psList *peaks, ///< The psList of peaks to be culled + psF32 maxValue, ///< Cull peaks above this value + const psRegion *valid ///< Cull peaks otside this psRegion + ); /****************************************************************************** @@ -141,14 +142,16 @@ *****************************************************************************/ -psSource *pmSourceLocalSky(const psImage *image, - const psPeak *peak, - psStatsOptions statsOptions, - psF32 innerRadius, - psF32 outerRadius); - -/****************************************************************************** - *****************************************************************************/ -psSource *pmSourceMoments(psSource *source, - psF32 radius); +psSource *pmSourceLocalSky(const psImage *image, ///< The input image (psF32) + const psPeak *peak, ///< The peak for which the psSource struct is created. + psStatsOptions statsOptions, ///< The statistic used in calculating the background sky + psF32 innerRadius, ///< The inner radius of the suqare annulus for calculating sky + psF32 outerRadius ///< The outer radius of the suqare annulus for calculating sky + ); + +/****************************************************************************** + *****************************************************************************/ +psSource *pmSourceMoments(psSource *source, ///< The input psSource for which moments will be computed + psF32 radius ///< Use a circle of pixels around the peak + ); /****************************************************************************** @@ -156,19 +159,21 @@ source classification. *****************************************************************************/ -bool pmSourceRoughClass(psArray *source, - psMetadata *metadata); +bool pmSourceRoughClass(psArray *source, ///< The input psSource + psMetadata *metadata ///< Contains classification parameters + ); /****************************************************************************** pmSourceSetPixelCircle(source, image, radius) *****************************************************************************/ -bool pmSourceSetPixelCircle(psSource *source, - const psImage *image, - psF32 radius); - - -/****************************************************************************** - *****************************************************************************/ -bool pmSourceModelGuess(psSource *source, - const psImage *image, - psModelType model); +bool pmSourceSetPixelCircle(psSource *source, ///< The input psSource + const psImage *image, ///< The input image (psF32) + psF32 radius ///< The radius of the circle + ); + +/****************************************************************************** + *****************************************************************************/ +bool pmSourceModelGuess(psSource *source, ///< The input psSource + const psImage *image, ///< The input image (psF32) + psModelType model ///< The type of model to be created. + ); /****************************************************************************** @@ -178,69 +183,80 @@ } pmContourType; -psArray *pmSourceContour(psSource *source, - const psImage *image, - psF32 level, - pmContourType mode); - -/****************************************************************************** - *****************************************************************************/ -bool pmSourceFitModel(psSource *source, - const psImage *image); - -/****************************************************************************** - *****************************************************************************/ -bool pmSourceAddModel(psImage *image, - psSource *source, - bool center); - -/****************************************************************************** - *****************************************************************************/ -bool pmSourceSubModel(psImage *image, - psSource *source, - bool center); +psArray *pmSourceContour(psSource *source, ///< The input psSource + const psImage *image, ///< The input image (psF32) (this arg should be removed) + psF32 level, ///< The level of the contour + pmContourType mode ///< Currently this must be PS_CONTOUR_CRUDE + ); + +/****************************************************************************** + *****************************************************************************/ +bool pmSourceFitModel(psSource *source, ///< The input psSource + const psImage *image ///< The input image (psF32) + ); + +/****************************************************************************** + *****************************************************************************/ +bool pmSourceAddModel(psImage *image, ///< The opuut image (psF32) + psSource *source, ///< The input psSource + bool center ///< A boolean flag that determines whether pixels are centered + ); + +/****************************************************************************** + *****************************************************************************/ +bool pmSourceSubModel(psImage *image, ///< The output image (psF32) + psSource *source, ///< The input psSource + bool center ///< A boolean flag that determines whether pixels are centered + ); /****************************************************************************** XXX: Why only *x argument? *****************************************************************************/ -psF32 pmMinLM_Gauss2D(psVector *deriv, - psVector *params, - psVector *x); +psF32 pmMinLM_Gauss2D(psVector *deriv, ///< A possibly-NULL structure for the output derivatives + psVector *params, ///< A psVector which holds the parameters of this function + psVector *x ///< A psVector which holds the row/col coordinate + ); /****************************************************************************** XXX: Why only *x argument? *****************************************************************************/ -psF32 pmMinLM_PsuedoGauss2D(psVector *deriv, - psVector *params, - psVector *x); - -/****************************************************************************** - *****************************************************************************/ -psF32 pmMinLM_Wauss2D(psVector *deriv, - psVector *params, - psVector *x); - -/****************************************************************************** - *****************************************************************************/ -psF32 pmMinLM_TwistGauss2D(psVector *deriv, - psVector *params, - psVector *x); - -/****************************************************************************** - *****************************************************************************/ -psF32 pmMinLM_Sersic(psVector *deriv, - psVector *params, - psVector *x); - -/****************************************************************************** - *****************************************************************************/ -psF32 pmMinLM_SersicCore(psVector *deriv, - psVector *params, - psVector *x); - -/****************************************************************************** - *****************************************************************************/ -psF32 pmMinLM_PsuedoSersic(psVector *deriv, - psVector *params, - psVector *x); +psF32 pmMinLM_PsuedoGauss2D(psVector *deriv, ///< A possibly-NULL structure for the output derivatives + psVector *params, ///< A psVector which holds the parameters of this function + psVector *x ///< A psVector which holds the row/col coordinate + ); + +/****************************************************************************** + *****************************************************************************/ +psF32 pmMinLM_Wauss2D(psVector *deriv, ///< A possibly-NULL structure for the output derivatives + psVector *params, ///< A psVector which holds the parameters of this function + psVector *x ///< A psVector which holds the row/col coordinate + ); + +/****************************************************************************** + *****************************************************************************/ +psF32 pmMinLM_TwistGauss2D(psVector *deriv, ///< A possibly-NULL structure for the output derivatives + psVector *params, ///< A psVector which holds the parameters of this function + psVector *x ///< A psVector which holds the row/col coordinate + ); + +/****************************************************************************** + *****************************************************************************/ +psF32 pmMinLM_Sersic(psVector *deriv, ///< A possibly-NULL structure for the output derivatives + psVector *params, ///< A psVector which holds the parameters of this function + psVector *x ///< A psVector which holds the row/col coordinate + ); + +/****************************************************************************** + *****************************************************************************/ +psF32 pmMinLM_SersicCore(psVector *deriv, ///< A possibly-NULL structure for the output derivatives + psVector *params, ///< A psVector which holds the parameters of this function + psVector *x ///< A psVector which holds the row/col coordinate + ); + +/****************************************************************************** + *****************************************************************************/ +psF32 pmMinLM_PsuedoSersic(psVector *deriv, ///< A possibly-NULL structure for the output derivatives + psVector *params, ///< A psVector which holds the parameters of this function + psVector *x ///< A psVector which holds the row/col coordinate + );