Main Page | Modules | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals

pmModelGroup.h File Reference


Detailed Description

The object model function types are defined to allow for the flexible addition of new object models.

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.

Author:
EAM, IfA
Version:
Revision
1.5
Name
rel12
Date:
Date
2006/06/10 02:58:43
Copyright 2004 Maui High Performance Computing Center, University of Hawaii

Definition in file pmModelGroup.h.

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  pmModelGroup

Typedefs

typedef psMinimizeLMChi2Func pmModelFunc
typedef psF64(* pmModelFlux )(const psVector *params)
typedef psF64(* pmModelRadius )(const psVector *params, double flux)
typedef bool(* pmModelLimits )(psVector **beta_lim, psVector **params_min, psVector **params_max)
typedef bool(* pmModelGuessFunc )(pmModel *model, pmSource *source)
typedef bool(* pmModelFromPSFFunc )(pmModel *modelPSF, pmModel *modelEXT, pmPSF *psf)
typedef bool(* pmModelFitStatusFunc )(pmModel *model)

Functions

pmModelGrouppmModelGroupAlloc (int nModels)
bool pmModelGroupInit (void)
void pmModelGroupCleanup (void)
void pmModelGroupAdd (pmModelGroup *model)
int pmModelParameterCount (pmModelType type)
char * pmModelGetType (pmModelType 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.
pmModelpmSourceModelGuess (pmSource *source, pmModelType model)
 pmSourceModelGuess()


Typedef Documentation

typedef bool(* pmModelFitStatusFunc)(pmModel *model)
 

Definition at line 49 of file pmModelGroup.h.

typedef psF64(* pmModelFlux)(const psVector *params)
 

Definition at line 25 of file pmModelGroup.h.

typedef bool(* pmModelFromPSFFunc)(pmModel *modelPSF, pmModel *modelEXT, pmPSF *psf)
 

Definition at line 45 of file pmModelGroup.h.

typedef psMinimizeLMChi2Func pmModelFunc
 

Definition at line 22 of file pmModelGroup.h.

typedef bool(* pmModelGuessFunc)(pmModel *model, pmSource *source)
 

Definition at line 39 of file pmModelGroup.h.

typedef bool(* pmModelLimits)(psVector **beta_lim, psVector **params_min, psVector **params_max)
 

Definition at line 34 of file pmModelGroup.h.

typedef psF64(* pmModelRadius)(const psVector *params, double flux)
 

Definition at line 30 of file pmModelGroup.h.


Function Documentation

pmModelFitStatusFunc pmModelFitStatusFunc_GetFunction pmModelType  type  ) 
 

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 pmModelFlux_GetFunction pmModelType  type  ) 
 

pmModelFlux returns the total integrated flux for the given input parameters.

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.

The input primarily relies upon the centroid coordinates of the input model, though the normalization may potentially be used.

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.

char* pmModelGetType pmModelType  type  ) 
 

Parameters:
type  Add comment.

void pmModelGroupAdd pmModelGroup model  ) 
 

pmModelGroup* pmModelGroupAlloc int  nModels  ) 
 

void pmModelGroupCleanup void   ) 
 

bool pmModelGroupInit void   ) 
 

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).

pmModelLimits pmModelLimits_GetFunction pmModelType  type  ) 
 

pmModelLimits sets the parameter limit vectors for the function.

int pmModelParameterCount pmModelType  type  ) 
 

Parameters:
type  Add comment.

pmModelRadius pmModelRadius_GetFunction pmModelType  type  ) 
 

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.

pmModelType pmModelSetType char *  name  ) 
 

This function returns the internal model type code for the user-space model names.

Parameters:
name  Add comment.

pmModel* pmSourceModelGuess pmSource source,
pmModelType  model
 

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.

Parameters:
source  The input pmSource
model  The type of model to be created.


Generated on Mon Jul 3 14:24:51 2006 for Pan-STARRS Module Library by  doxygen 1.4.4