Every object model, with parameters represented by pmModel, has an associated set of functions which provide necessary support operations. A set of abstract functions allow the programmer to select the approriate function or property for a specific named object model.
Definition in file pmModelGroup.h.
#include "pmObjects.h"
#include "pmPSF.h"
Include dependency graph for pmModelGroup.h:
Go to the source code of this file.
Data Structures | |
| struct | pmModelGroup |
| Every model instance belongs to a class of models, defined by the value of the pmModelType type entry. More... | |
Typedefs | |
| typedef psMinimizeLMChi2Func | pmModelFunc |
| This function is the model chi-square minimization function for this model. | |
| typedef psF64(* | pmModelFlux )(const psVector *params) |
| This function returns the integrated flux for the given model parameters. | |
| typedef psF64(* | pmModelRadius )(const psVector *params, double flux) |
| This function returns the radius at which the given model and parameters achieves the given flux. | |
| typedef bool(* | pmModelLimits )(psVector **beta_lim, psVector **params_min, psVector **params_max) |
| This function sets the model parameter limits vectors for the given model. | |
| typedef bool(* | pmModelGuessFunc )(pmModel *model, pmSource *source) |
| This function provides the model guess parameters based on the details of the given source. | |
| typedef bool(* | pmModelFromPSFFunc )(pmModel *modelPSF, pmModel *modelFLT, pmPSF *psf) |
| This function constructs the PSF model for the given source based on the supplied psf and the FLT model for the object. | |
| typedef bool(* | pmModelFitStatusFunc )(pmModel *model) |
| This function returns the success / failure status of the given model fit. | |
Functions | |
| int | pmModelParameterCount (pmModelType type) |
| This function returns the number of parameters used by the listed function. | |
| char * | pmModelGetType (pmModelType type) |
| This function returns the user-space model names for the specified model type. | |
| pmModelType | pmModelSetType (char *name) |
| This function returns the internal model type code for the user-space model names. | |
| pmModelFunc | pmModelFunc_GetFunction (pmModelType type) |
| pmModelFunc is the function used to determine the value of the model at a specific coordinate, and is the one used by psMinimizeLMChi2. | |
| pmModelFlux | pmModelFlux_GetFunction (pmModelType type) |
| pmModelFlux returns the total integrated flux for the given input parameters. | |
| pmModelRadius | pmModelRadius_GetFunction (pmModelType type) |
| pmModelRadius returns the scaling radius at which the flux of the model matches the specified flux. | |
| pmModelLimits | pmModelLimits_GetFunction (pmModelType type) |
| pmModelLimits sets the parameter limit vectors for the function. | |
| pmModelGuessFunc | pmModelGuessFunc_GetFunction (pmModelType type) |
| pmModelGuessFunc generates an initial guess for the model based on the provided source statistics (moments and pixel values as needed). | |
| pmModelFromPSFFunc | pmModelFromPSFFunc_GetFunction (pmModelType type) |
| pmModelFromPSFFunc takes as input a representation of the psf and a value for the model and fills in the PSF parameters of the model. | |
| pmModelFitStatusFunc | pmModelFitStatusFunc_GetFunction (pmModelType type) |
| pmModelFitStatusFunc returns a true or false values based on the success or failure of a model fit. | |
|
|
This function returns the success / failure status of the given model fit.
Definition at line 104 of file pmModelGroup.h. |
|
|
This function returns the integrated flux for the given model parameters.
Definition at line 64 of file pmModelGroup.h. |
|
|
This function constructs the PSF model for the given source based on the supplied psf and the FLT model for the object.
Definition at line 97 of file pmModelGroup.h. |
|
|
This function is the model chi-square minimization function for this model.
Definition at line 57 of file pmModelGroup.h. |
|
|
This function provides the model guess parameters based on the details of the given source.
Definition at line 88 of file pmModelGroup.h. |
|
|
This function sets the model parameter limits vectors for the given model.
Definition at line 80 of file pmModelGroup.h. |
|
|
This function returns the radius at which the given model and parameters achieves the given flux.
Definition at line 73 of file pmModelGroup.h. |
|
|
pmModelFitStatusFunc returns a true or false values based on the success or failure of a model fit. The success is determined by quantities such as the chisq or the signal-to-noise. |
|
|
pmModelFlux returns the total integrated flux for the given input parameters.
|
|
|
pmModelFromPSFFunc takes as input a representation of the psf and a value for the model and fills in the PSF parameters of the model. The input primarily relies upon the centroid coordinates of the input model, though the normalization may potentially be used. |
|
|
pmModelFunc is the function used to determine the value of the model at a specific coordinate, and is the one used by psMinimizeLMChi2.
|
|
|
This function returns the user-space model names for the specified model type.
|
|
|
pmModelGuessFunc generates an initial guess for the model based on the provided source statistics (moments and pixel values as needed).
|
|
|
pmModelLimits sets the parameter limit vectors for the function.
|
|
|
This function returns the number of parameters used by the listed function.
|
|
|
pmModelRadius returns the scaling radius at which the flux of the model matches the specified flux. This presumes that the model is a function of an elliptical contour. |
|
|
This function returns the internal model type code for the user-space model names.
|
1.4.5