Changeset 28643 for branches/eam_branches/ipp-20100621/psModules/src/objects/pmModel.h

Timestamp:

Jul 9, 2010, 10:56:32 AM (16 years ago)

Author:

eugene

Message:

changed pmSourceFitModel and related APIs to pass a structure of fit options; this lets us change the options between soruces within the multithreaded context; also re-organized the include orders to avoid conflicts

File:

• branches/eam_branches/ipp-20100621/psModules/src/objects/pmModel.h (modified) (3 diffs)

branches/eam_branches/ipp-20100621/psModules/src/objects/pmModel.h

@@ -14 +14 @@
 # define PM_MODEL_H
 
-#include <pslib.h>
-#include "pmPSF.h"
-
 /// @addtogroup Objects Object Detection / Analysis Functions
 /// @{
@@ -22 +19 @@
 /* pointers for the functions types below are supplied to each pmModel, and can be used by
    the programmer without needing to know the model class */
-
-typedef enum {
-    PM_MODEL_STATUS_NONE         = 0x00, ///< model fit not yet attempted, no other info
-    PM_MODEL_STATUS_FITTED       = 0x01, ///< model fit completed
-    PM_MODEL_STATUS_NONCONVERGE  = 0x02, ///< model fit did not converge
-    PM_MODEL_STATUS_OFFIMAGE     = 0x04, ///< model fit drove out of range
-    PM_MODEL_STATUS_BADARGS      = 0x08, ///< model fit called with invalid args
-    PM_MODEL_STATUS_LIMITS       = 0x10  ///< model parameters hit limits
-} pmModelStatus;
-
-typedef enum {
-    PM_MODEL_OP_NONE    = 0x00,
-    PM_MODEL_OP_FUNC    = 0x01,
-    PM_MODEL_OP_RES0    = 0x02,
-    PM_MODEL_OP_RES1    = 0x04,
-    PM_MODEL_OP_FULL    = 0x07,
-    PM_MODEL_OP_SKY     = 0x08,
-    PM_MODEL_OP_CENTER  = 0x10,
-    PM_MODEL_OP_NORM    = 0x20,
-    PM_MODEL_OP_NOISE   = 0x40,
-} 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;
-
-//  This function is the model chi-square minimization function for this model.
-typedef psMinimizeLMChi2Func pmModelFunc;
-
-//  This function sets the parameter limits for this model.
-typedef psMinimizeLMLimitFunc pmModelLimits;
-
-// This function returns the integrated flux for the given model parameters.
-typedef psF64 (*pmModelFlux)(const psVector *params);
-
-// This function returns the radius at which the given model and parameters
-// achieves the given flux.
-typedef psF64 (*pmModelRadius)(const psVector *params, double flux);
-
-//  This function provides the model guess parameters based on the details of
-//  the given source.
-typedef bool (*pmModelGuessFunc)(pmModel *model, pmSource *source);
-
-//  This function constructs the PSF model for the given source based on the
-//  supplied psf and the EXT model for the object.
-typedef bool (*pmModelFromPSFFunc)(pmModel *modelPSF, pmModel *modelEXT, const pmPSF *psf);
-
-//  This function sets the model parameters based on the PSF for a given coordinate and central
-//  intensity
-typedef bool (*pmModelParamsFromPSF)(pmModel *model, const pmPSF *psf, float Xo, float Yo, float Io);
-
-//  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
@@ -122 +55 @@
     pmModelSetLimitsFunc modelSetLimits;
 };
-
-/** Symbolic names for the elements of [d]params
- * Note: these are #defines not enums as a given element of [d]params
- * may/will correspond to different parameters in different contexts
- */
-#define PM_PAR_SKY 0   ///< Sky
-#define PM_PAR_I0 1   ///< Central intensity
-#define PM_PAR_XPOS 2   ///< X centre of object
-#define PM_PAR_YPOS 3   ///< Y centre of object
-#define PM_PAR_SXX 4   ///< shape X^2 moment
-#define PM_PAR_SYY 5   ///< shape Y^2 moment
-#define PM_PAR_SXY 6   ///< shape XY moment
-#define PM_PAR_7 7   ///< ??? Unknown parameter
-#define PM_PAR_8 8   ///< ??? Unknown parameter
 
 /** pmModelAlloc()