Index: trunk/psModules/src/objects/pmModelGroup.h =================================================================== --- trunk/psModules/src/objects/pmModelGroup.h (revision 5844) +++ trunk/psModules/src/objects/pmModelGroup.h (revision 6872) @@ -9,16 +9,84 @@ * @author EAM, IfA * - * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-12-24 01:24:32 $ + * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * @date $Date: 2006-04-17 18:01:05 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii * */ -#include "pmObjects.h" -#include "pmPSF.h" -/** - * - * This function returns the number of parameters used by the listed function. - * + +# ifndef PM_MODEL_GROUP_H +# define PM_MODEL_GROUP_H + +// This function is the model chi-square minimization function for this model. +typedef psMinimizeLMChi2Func pmModelFunc; + +// 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 sets the model parameter limits vectors for the given model + */ +typedef bool (*pmModelLimits)(psVector **beta_lim, psVector **params_min, psVector **params_max); + +/* 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, pmPSF *psf); + +/* This function returns the success / failure status of the given model fit + */ +typedef bool (*pmModelFitStatusFunc)(pmModel *model); + +/* Every model instance belongs to a class of models, defined by the value of + * the pmModelType type entry. Various functions need access to information about + * each of the models. Some of this information varies from model to model, and + * may depend on the current parameter values or other data quantities. In order + * to keep the code from requiring the information about each model to be coded + * into the low-level fitting routines, we define a collection of functions which + * allow us to abstract this type of model-dependent information. These generic + * functions take the model type and return the corresponding function pointer + * for the specified model. Each model is defined by creating this collection of + * specific functions, and placing them in a single file for each model. We + * define the following structure to carry the collection of information about + * the models. + */ +typedef struct +{ + char *name; + int nParams; + pmModelFunc modelFunc; + pmModelFlux modelFlux; + pmModelRadius modelRadius; + pmModelLimits modelLimits; + pmModelGuessFunc modelGuessFunc; + pmModelFromPSFFunc modelFromPSFFunc; + pmModelFitStatusFunc modelFitStatusFunc; +} +pmModelGroup; + +// allocate a pmModelGroup to hold nModels entries +pmModelGroup *pmModelGroupAlloc (int nModels); + +// initialize the internal (static) model group with the default models +void pmModelGroupInit (void); + +// free the internal (static) model group +void pmModelGroupCleanup (void); + +// add a new model to the internal (static) model group +void pmModelGroupAdd (pmModelGroup *model); + +/* This function returns the number of parameters used by the listed function. */ int pmModelParameterCount( @@ -27,8 +95,5 @@ -/** - * - * This function returns the user-space model names for the specified model type. - * +/* This function returns the user-space model names for the specified model type. */ char *pmModelGetType( @@ -46,62 +111,4 @@ ); - -#ifndef PM_MODEL_GROUP_H -#define PM_MODEL_GROUP_H - -/** - * - * This function is the model chi-square minimization function for this model. - * - */ -typedef psMinimizeLMChi2Func pmModelFunc; - - -/** - * - * 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 sets the model parameter limits vectors for the given model - * - */ -typedef bool (*pmModelLimits)(psVector **beta_lim, psVector **params_min, psVector **params_max); - -/** - * - * 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 FLT model for the object. - * - */ -typedef bool (*pmModelFromPSFFunc)(pmModel *modelPSF, pmModel *modelFLT, pmPSF *psf); - -/** - * - * This function returns the success / failure status of the given model fit - * - */ -typedef bool (*pmModelFitStatusFunc)(pmModel *model); - /** * @@ -110,5 +117,4 @@ * */ - /** @@ -177,44 +183,17 @@ +/** pmSourceModelGuess() + * + * Convert available data to an initial guess for the given model. This + * function allocates a pmModel entry for the pmSource structure based on the + * provided model selection. The method of defining the model parameter guesses + * are specified for each model below. The guess values are placed in the model + * parameters. The function returns TRUE on success or FALSE on failure. + * + */ +pmModel *pmSourceModelGuess( + pmSource *source, ///< The input pmSource + pmModelType model ///< The type of model to be created. +); - -/** - * - * Every model instance belongs to a class of models, defined by the value of - * the pmModelType type entry. Various functions need access to information about - * each of the models. Some of this information varies from model to model, and - * may depend on the current parameter values or other data quantities. In order - * to keep the code from requiring the information about each model to be coded - * into the low-level fitting routines, we define a collection of functions which - * allow us to abstract this type of model-dependent information. These generic - * functions take the model type and return the corresponding function pointer - * for the specified model. Each model is defined by creating this collection of - * specific functions, and placing them in a single file for each model. We - * define the following structure to carry the collection of information about - * the models. - * - */ -typedef struct -{ - char *name; - int nParams; - pmModelFunc modelFunc; - pmModelFlux modelFlux; - pmModelRadius modelRadius; - pmModelLimits modelLimits; - pmModelGuessFunc modelGuessFunc; - pmModelFromPSFFunc modelFromPSFFunc; - pmModelFitStatusFunc modelFitStatusFunc; -} -pmModelGroup; - -// allocate a pmModelGroup to hold nModels entries -pmModelGroup *pmModelGroupAlloc (int nModels); - -// initialize the internal (static) model group with the default models -void pmModelGroupInit (void); - -// add a new model to the internal (static) model group -void pmModelGroupAdd (pmModelGroup *model); - -# endif +# endif /* PM_MODEL_GROUP_H */