Changeset 6448 for branches/rel10_ifa/psModules/src/objects/pmObjects.h

Timestamp:

Feb 17, 2006, 7:13:42 AM (20 years ago)

Author:

magnier

Message:

bulk merge of eam_rel9_p0 onto this branch

File:

• branches/rel10_ifa/psModules/src/objects/pmObjects.h (modified) (15 diffs)

branches/rel10_ifa/psModules/src/objects/pmObjects.h

@@ -10 +10 @@
  *  @author GLG, MHPCC
  *
- *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-12-24 01:24:32 $
+ *  @version $Revision: 1.5.4.1 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-02-17 17:13:42 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -27 +27 @@
 #include <math.h>
 #include "pslib.h"
-#include "pmAstrometry.h"
+#include "pmFPA.h"
 /**
  * In the object analysis process, we will use specific mask values to mark the
@@ -74 +74 @@
     int y;                              ///< Y-coordinate of peak pixel.
     float counts;                       ///< Value of peak pixel (above sky?).
-    pmPeakType class;                   ///< Description of peak.
+    pmPeakType type;                   ///< Description of peak.
 }
 pmPeak;
@@ -88 +88 @@
 typedef struct
 {
-    float x;    ///< X-coord of centroid.
-    float y;    ///< Y-coord of centroid.
+    float x;     ///< X-coord of centroid.
+    float y;     ///< Y-coord of centroid.
     float Sx;    ///< x-second moment.
     float Sy;    ///< y-second moment.
-    float Sxy;    ///< xy cross moment.
-    float Sum;    ///< Pixel sum above sky (background).
-    float Peak;    ///< Peak counts above sky.
-    float Sky;    ///< Sky level (background).
+    float Sxy;   ///< xy cross moment.
+    float Sum;   ///< Pixel sum above sky (background).
+    float Peak;  ///< Peak counts above sky.
+    float Sky;   ///< Sky level (background).
+    float dSky;  ///< local Sky variance
     float SN;    ///< approx signal-to-noise
-    int nPixels;   ///< Number of pixels used.
+    int nPixels; ///< Number of pixels used.
 }
 pmMoments;
@@ -131 +132 @@
 /** pmModel data structure
  *
- * Every source may have two types of models: a PSF model and a FLT (floating)
+ * Every source may have two types of models: a PSF model and a EXT (extended-source)
  * model. The PSF model represents the best fit of the image PSF to the specific
  * object. In this case, the PSF-dependent parameters are specified for the
- * object by the PSF, not by the fit. The FLT model represents the best fit of
- * the given model to the object, with all parameters floating in the fit.
+ * object by the PSF, not by the fit. The EXT model represents the best fit of
+ * the given model to the object, with all shape parameters floating in the fit.
  *
  */
@@ -146 +147 @@
     int nDOF;    ///< number of degrees of freedom
     int nIter;    ///< number of iterations to reach min
-    int status;         ///< fit status
+    pmModelStatus status;  ///< fit status
     float radius;   ///< fit radius actually used
 }
@@ -162 +163 @@
  */
 typedef enum {
+    PM_SOURCE_UNKNOWN,                  ///< a cosmic-ray
     PM_SOURCE_DEFECT,                   ///< a cosmic-ray
     PM_SOURCE_SATURATED,                ///< random saturated pixels
-
-    PM_SOURCE_SATSTAR,                  ///< a saturated star
-    PM_SOURCE_PSFSTAR,                  ///< a PSF star
-    PM_SOURCE_GOODSTAR,                 ///< a good-quality star
-
-    PM_SOURCE_POOR_FIT_PSF,             ///< poor quality PSF fit
-    PM_SOURCE_FAIL_FIT_PSF,             ///< failed to get a good PSF fit
-    PM_SOURCE_FAINTSTAR,                ///< below S/N cutoff
-
-    PM_SOURCE_GALAXY,                   ///< an extended object (galaxy)
-    PM_SOURCE_FAINT_GALAXY,             ///< a galaxy below S/N cutoff
-    PM_SOURCE_DROP_GALAXY,              ///< ?
-    PM_SOURCE_FAIL_FIT_GAL,             ///< failed on the galaxy fit
-    PM_SOURCE_POOR_FIT_GAL,             ///< poor quality galaxy fit
-
-    PM_SOURCE_OTHER,                    ///< unidentified
+    PM_SOURCE_STAR,                     ///< a good-quality star
+    PM_SOURCE_EXTENDED,                 ///< an extended object (eg, galaxy)
 } pmSourceType;
+
+typedef enum {
+    PM_SOURCE_DEFAULT    = 0x0000, ///<
+    PM_SOURCE_PSFMODEL   = 0x0001, ///<
+    PM_SOURCE_EXTMODEL   = 0x0002, ///<
+    PM_SOURCE_SUBTRACTED = 0x0004, ///<
+    PM_SOURCE_FITTED     = 0x0008, ///<
+    PM_SOURCE_FAIL       = 0x0010, ///<
+    PM_SOURCE_POOR       = 0x0020, ///<
+    PM_SOURCE_PAIR       = 0x0040, ///<
+    PM_SOURCE_PSFSTAR    = 0x0080, ///<
+    PM_SOURCE_SATSTAR    = 0x0100, ///<
+    PM_SOURCE_BLEND      = 0x0200, ///<
+    PM_SOURCE_LINEAR     = 0x0400, ///<
+    PM_SOURCE_TEMPSUB    = 0x0800, ///< XXX get me a better name!
+} pmSourceMode;
 
 /** pmSource data structure
@@ -197 +201 @@
     pmMoments *moments;   ///< Basic moments measure for the object.
     pmModel *modelPSF;   ///< PSF Model fit (parameters and type)
-    pmModel *modelFLT;   ///< FLT (floating) Model fit (parameters and type).
+    pmModel *modelEXT;   ///< EXT (floating) Model fit (parameters and type).
     pmSourceType type;   ///< Best identification of object.
+    pmSourceMode mode;   ///< Best identification of object.
+    psArray *blends;
     float apMag;
     float fitMag;
+    psRegion region; // area on image covered by selected pixels
 }
 pmSource;
@@ -213 +220 @@
     int y,    ///< Col-coordinate in image space
     float counts,   ///< The value of the peak pixel
-    pmPeakType class   ///< The type of peak pixel
+    pmPeakType type   ///< The type of peak pixel
 );
 
@@ -354 +361 @@
 
 
+// A complementary function to pmSourceLocalSky: calculate the local sky variance
+bool pmSourceLocalSkyVariance(
+    pmSource *source,   ///< The input image (float)
+    psStatsOptions statsOptions, ///< The statistic used in calculating the background sky
+    float Radius   ///< The inner radius of the square annulus to exclude
+);
+
 /** pmSourceMoments()
  *
@@ -469 +483 @@
 
 
+bool pmSourceFitModelInit(
+    float nIter,   ///< max number of allowed iterations
+    float tol      ///< convergence criterion
+);
+
 /** pmSourceFitModel()
  *
@@ -481 +500 @@
     pmSource *source,   ///< The input pmSource
     pmModel *model,   ///< model to be fitted
-    const bool PSF   ///< Treat model as PSF or FLT?
+    const bool PSF   ///< Treat model as PSF or EXT?
 );
 
@@ -563 +582 @@
  * This function converts the source classification into the closest available
  * approximation to the Dophot classification scheme:
+ * XXX EAM : fix this to use current source classification scheme
  *
  * PM_SOURCE_DEFECT: 8
@@ -610 +630 @@
     pmSource *source,   ///< The input pmSource
     pmModel *model,   ///< model to be fitted
-    const bool PSF   ///< Treat model as PSF or FLT?
+    const bool PSF   ///< Treat model as PSF or EXT?
 );
 
@@ -626 +646 @@
     pmSource *source,   ///< The input pmSource
     pmModel *model,   ///< model to be fitted
-    const bool PSF   ///< Treat model as PSF or FLT?
+    const bool PSF   ///< Treat model as PSF or EXT?
 );