Changeset 27840 for branches/simtest_nebulous_branches/psModules/src/objects/pmModel.h

Timestamp:

May 3, 2010, 8:50:52 AM (16 years ago)

Author:

eugene

Message:

updates from trunk

Location:

branches/simtest_nebulous_branches

Files:

• . (modified) (1 prop)
• psModules (modified) (1 prop)
• psModules/src/objects/pmModel.h (modified) (7 diffs)

branches/simtest_nebulous_branches/psModules/src/objects/pmModel.h

@@ -44 +44 @@
 } pmModelOpMode;
 
+/// Parameter limit types
+typedef enum {
+    PM_MODEL_LIMITS_NONE,               ///< Apply no limits: suitable for debugging
+    PM_MODEL_LIMITS_IGNORE,             ///< Ignore all limits: fit can go to town
+    PM_MODEL_LIMITS_LAX,                ///< Lax limits: attempting to reproduce even bad data
+    PM_MODEL_LIMITS_MODERATE,           ///< Moderate limits: cope with mildly bad data
+    PM_MODEL_LIMITS_STRICT,             ///< Strict limits: insist on good quality data
+} pmModelLimitsType;
+
 typedef struct pmModel pmModel;
 typedef struct pmSource pmSource;
@@ -74 +83 @@
 //  This function returns the success / failure status of the given model fit
 typedef bool (*pmModelFitStatusFunc)(pmModel *model);
+
+//  This function sets the parameter limits for the given model
+typedef bool (*pmModelSetLimitsFunc)(pmModelLimitsType type);
 
 /** pmModel data structure
@@ -96 +108 @@
     int nIter;                          ///< number of iterations to reach min
     pmModelStatus flags;                ///< model status flags
-    float radiusFit;                    ///< fit radius actually used
+    float fitRadius;                    ///< fit radius actually used
     pmResiduals *residuals;             ///< normalized PSF residuals
 
@@ -108 +120 @@
     pmModelParamsFromPSF modelParamsFromPSF;
     pmModelFitStatusFunc modelFitStatus;
+    pmModelSetLimitsFunc modelSetLimits;
 };
 
@@ -151 +164 @@
     pmModel *model,                     ///< The input pmModel
     pmModelOpMode mode,                 ///< mode to control how the model is added into the image
-    psImageMaskType maskVal             ///< Value to mask
+    psImageMaskType maskVal             ///< Value to mask
 );
 
@@ -169 +182 @@
     pmModel *model,                     ///< The input pmModel
     pmModelOpMode mode,                 ///< mode to control how the model is added into the image
-    psImageMaskType maskVal             ///< Value to mask
+    psImageMaskType maskVal             ///< Value to mask
 );
 
@@ -202 +215 @@
 );
 
+
+/// Set the model parameter limits for the given model
+///
+/// Wraps the model-specific pmModelSetLimitsFunc function.
+bool pmModelSetLimits(
+    const pmModel *model,               ///< Model of interest
+    pmModelLimits type                  ///< Type of limits
+    );
+
+
 /// @}
 # endif /* PM_MODEL_H */