Changeset 17307 for branches/eam_branch_20080324/psModules/src/objects/pmSource.h

Timestamp:

Apr 2, 2008, 8:00:41 PM (18 years ago)

Author:

eugene

Message:

cleanup comments, add modelFits entry, remove modelConv

File:

• branches/eam_branch_20080324/psModules/src/objects/pmSource.h (modified) (5 diffs)

branches/eam_branch_20080324/psModules/src/objects/pmSource.h

@@ -3 +3 @@
  * @author EAM, IfA; GLG, MHPCC
  *
- * @version $Revision: 1.23.2.1 $ $Name: not supported by cvs2svn $
- * @date $Date: 2008-04-02 21:16:16 $
+ * @version $Revision: 1.23.2.2 $ $Name: not supported by cvs2svn $
+ * @date $Date: 2008-04-03 06:00:41 $
  * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
  */
@@ -22 +22 @@
  * source.
  *
- * XXX: The values given below are currently illustrative and will require
- * some modification as the source classification code is developed. (TBD)
- *
  */
 typedef enum {
-    PM_SOURCE_TYPE_UNKNOWN,  ///< a cosmic-ray
-    PM_SOURCE_TYPE_DEFECT,  ///< a cosmic-ray
-    PM_SOURCE_TYPE_SATURATED,  ///< random saturated pixels
-    PM_SOURCE_TYPE_STAR,  ///< a good-quality star
-    PM_SOURCE_TYPE_EXTENDED,  ///< an extended object (eg, galaxy)
+    PM_SOURCE_TYPE_UNKNOWN,             ///< not yet classified
+    PM_SOURCE_TYPE_DEFECT,              ///< a cosmic-ray
+    PM_SOURCE_TYPE_SATURATED,           ///< random saturated pixels (eg, bleed trails)
+    PM_SOURCE_TYPE_STAR,                ///< a good-quality star (subtracted model is PSF)
+    PM_SOURCE_TYPE_EXTENDED,            ///< an extended object (eg, galaxy) (subtracted model is EXT)
 } pmSourceType;
 
@@ -48 +45 @@
     PM_SOURCE_MODE_BADPSF     = 0x0400, ///< Failed to get good estimate of object's PSF
     PM_SOURCE_MODE_DEFECT     = 0x0800, ///< Source is thought to be a defect
-    PM_SOURCE_MODE_SATURATED  = 0x1000, ///< Source is thought to be saturation
+    PM_SOURCE_MODE_SATURATED  = 0x1000, ///< Source is thought to be saturated pixels (bleed trail)
     PM_SOURCE_MODE_CR_LIMIT   = 0x2000, ///< Source has crNsigma above limit
-    PM_SOURCE_MODE_EXT_LIMIT  = 0x4000, ///< Source has crNsigma above limit
+    PM_SOURCE_MODE_EXT_LIMIT  = 0x4000, ///< Source has extNsigma above limit
     PM_SOURCE_MODE_SUBTRACTED = 0x8000, ///< XXX this flag is actually only used internally (move)
 } pmSourceMode;
@@ -69 +66 @@
     const int id;                       ///< Unique ID for object
     int seq;                            ///< ID for output (generated on write)
-    pmPeak *peak;                       ///< Description of peak pixel.
+    pmPeak  *peak;                      ///< Description of peak pixel.
     psImage *pixels;                    ///< Rectangular region including object pixels.
     psImage *weight;                    ///< Image variance.
@@ -76 +73 @@
     psImage *modelFlux;                 ///< cached copy of the best model for this source
     psImage *psfFlux;                   ///< cached copy of the psf model for this source
-    pmMoments *moments;                 ///< Basic moments measure for the object.
+    pmMoments *moments;                 ///< Basic moments measured for the object.
     pmModel *modelPSF;                  ///< PSF Model fit (parameters and type)
-    pmModel *modelEXT;                  ///< EXT (floating) Model fit (parameters and type).
-    pmModel *modelConv;                 ///< PSF-Convolved Model fit (parameters and type).
+    pmModel *modelEXT;                  ///< EXT Model fit used for subtraction (parameters and type)
+    psArray *modelFits;                 ///< collection of extended source models (best == modelEXT)
     pmSourceType type;                  ///< Best identification of object.
-    pmSourceMode mode;                  ///< Best identification of object.
-    psArray *blends;
-    float psfMag;                       ///< calculated from flux in modelPsf
+    pmSourceMode mode;                  ///< analysis flags set for object.
+    psArray *blends;                    ///< collection of sources thought to be confused with object
+    float psfMag;                       ///< calculated from flux in modelPSF
     float extMag;                       ///< calculated from flux in modelEXT
     float errMag;                       ///< error in psfMag OR extMag (depending on type)
     float apMag;                        ///< apMag corresponding to psfMag or extMag (depending on type)
     float pixWeight;                    ///< model-weighted coverage of valid pixels
-    float psfChisq;                      ///< probability of PSF
+    float psfChisq;                     ///< probability of PSF
     float crNsigma;                     ///< Nsigma deviation from PSF to CR
     float extNsigma;                    ///< Nsigma deviation from PSF to EXT
+    float sky, skyErr;                  ///< The sky and its error at the center of the object
     psRegion region;                    ///< area on image covered by selected pixels
-    float sky, skyErr;                  ///< The sky and its error at the center of the object
     pmSourceExtendedPars *extpars;      ///< extended source parameters
 };