pmModel.h File Reference

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

Go to the source code of this file.

Data Structures
struct	pmModel
	pmModel data structure More...
Typedefs
typedef int	pmModelType
Enumerations
enum	pmModelStatus { PM_MODEL_UNTRIED, PM_MODEL_SUCCESS, PM_MODEL_NONCONVERGE, PM_MODEL_OFFIMAGE, PM_MODEL_BADARGS }
Functions
pmModel *	pmModelAlloc (pmModelType type)
	pmModelAlloc()
pmModel *	pmModelCopy (pmModel *model)
psF32	pmModelEval (pmModel *model, psImage *image, psS32 col, psS32 row)
bool	pmModelAdd (psImage *image, psImage *mask, pmModel *model, bool center, bool sky)
	pmModelAdd()
bool	pmModelSub (psImage *image, psImage *mask, pmModel *model, bool center, bool sky)
	pmModelSub()
bool	pmModelFitStatus (pmModel *model)
	pmModelFitStatus()

---

Typedef Documentation

typedef int pmModelType

Definition at line 19 of file pmModel.h.

---

Enumeration Type Documentation

enum pmModelStatus

Enumerator: PM_MODEL_UNTRIED  model fit not yet attempted PM_MODEL_SUCCESS  model fit succeeded PM_MODEL_NONCONVERGE  model fit did not converge PM_MODEL_OFFIMAGE  model fit drove out of range PM_MODEL_BADARGS  model fit called with invalid args Definition at line 21 of file pmModel.h.

---

Function Documentation

bool pmModelAdd (  psImage *  image, psImage *  mask, pmModel *  model, bool  center, bool  sky )

pmModelAdd() Add the given source model flux to/from the provided image. The boolean option center selects if the source is re-centered to the image center or if it is placed at its centroid location. The boolean option sky selects if the background sky is applied (TRUE) or not. The pixel range in the target image is at most the pixel range specified by the source.pixels image. The success status is returned. Parameters: image  The output image (float) mask  The image pixel mask (valid == 0) model  The input pmModel center  A boolean flag that determines whether pixels are centered sky  A boolean flag that determines if the sky is subtracted

pmModel* pmModelAlloc (  pmModelType  type  )

pmModelAlloc()

pmModel* pmModelCopy (  pmModel *  model  )

psF32 pmModelEval (  pmModel *  model, psImage *  image, psS32  col, psS32  row )

bool pmModelFitStatus (  pmModel *  model  )

pmModelFitStatus() This function wraps the call to the model-specific function returned by pmModelFitStatusFunc_GetFunction. The model-specific function examines the model parameters, parameter errors, Chisq, S/N, and other parameters available from model to decide if the particular fit was successful or not. XXX: Must code this. Parameters: model  Model to be used

bool pmModelSub (  psImage *  image, psImage *  mask, pmModel *  model, bool  center, bool  sky )

pmModelSub() Subtract the given source model flux to/from the provided image. The boolean option center selects if the source is re-centered to the image center or if it is placed at its centroid location. The boolean option sky selects if the background sky is applied (TRUE) or not. The pixel range in the target image is at most the pixel range specified by the source.pixels image. The success status is returned. Parameters: image  The output image (float) mask  The image pixel mask (valid == 0) model  The input pmModel center  A boolean flag that determines whether pixels are centered sky  A boolean flag that determines if the sky is subtracted

---