ObitFitModel.h File Reference

ObitFitModel Stores model fit parameters. More...

#include "Obit.h"
#include "ObitErr.h"
#include "ObitImage.h"

Go to the source code of this file.

Classes
struct	ObitFitModel
	ObitFitModel Class structure. More...
struct	ObitFitModelClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitFitModelUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitFitModel returns a ObitFitModel*.
#define	ObitFitModelRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitFitModel.
#define	ObitFitModelIsA(in)   ObitIsA (in, ObitFitModelGetClass())
	Macro to determine if an object is the member of this or a derived class.
Typedefs
typedef ObitFitModel *(*	ObitFitModelCreateFP )(gchar *name, ObitFitModelCompType type, gfloat Flux, gfloat DeltaX, gfloat DeltaY, gint nparm, gfloat *parms)
	Typedef for definition of class pointer structure.
Enumerations
enum	obitFitModelCompType {   OBIT_FitModel_PointMod, OBIT_FitModel_GaussMod, OBIT_FitModel_CGaussMod, OBIT_FitModel_USphereMod,   OBIT_FitModel_Background, OBIT_FitModel_Unknown }
	enum for Model Component model type More...
Functions
void	ObitFitModelClassInit (void)
	Public: Class initializer.
ObitFitModel *	newObitFitModel (gchar *name)
	Public: Default Constructor.
ObitFitModel *	ObitFitModelCreate (gchar *name, ObitFitModelCompType type, gfloat Flux, gfloat DeltaX, gfloat DeltaY, gint nparm, gfloat *parms)
	Public: Create/initialize ObitFitModel structures.
gconstpointer	ObitFitModelGetClass (void)
	Public: ClassInfo pointer.
ObitFitModel *	ObitFitModelCopy (ObitFitModel *in, ObitFitModel *out, ObitErr *err)
	Public: Copy (deep) constructor.
void	ObitFitModelClone (ObitFitModel *in, ObitFitModel *out, ObitErr *err)
	Public: Copy structure.
gint	ObitFitModelDeconGau (gfloat bmaj, gfloat bmin, gfloat bpa, gfloat ebmaj, gfloat ebmin, gfloat ebpa, gfloat cbmaj, gfloat cbmin, gfloat cbpa, gfloat dgau[3][3])
	Public: Deconvolve Gaussians.

---

Detailed Description

ObitFitModel Stores model fit parameters.

This class is derived from the Obit class.

Creators and Destructors

An ObitFitModel will usually be created using ObitFitModelCreate which allows specifying a name for the object as well as other information.

A copy of a pointer to an ObitFitModel should always be made using the ObitFitModelRef function which updates the reference count in the object. Then whenever freeing an ObitFitModel or changing a pointer, the function ObitFitModelUnref will decrement the reference count and destroy the object when the reference count hits 0. There is no explicit destructor.

---

Define Documentation

#define ObitFitModelIsA (  in   )     ObitIsA (in, ObitFitModelGetClass())

Macro to determine if an object is the member of this or a derived class. Returns TRUE if a member, else FALSE in = object to reference

#define ObitFitModelRef (  in   )     ObitRef (in)

Macro to reference (update reference count) an ObitFitModel. returns a ObitFitModel*. in = object to reference

#define ObitFitModelUnref (  in   )     ObitUnref (in)

Macro to unreference (and possibly destroy) an ObitFitModel returns a ObitFitModel*. in = object to unreference

---

Typedef Documentation

typedef ObitFitModel*(* ObitFitModelCreateFP)(gchar *name, ObitFitModelCompType type, gfloat Flux, gfloat DeltaX, gfloat DeltaY, gint nparm, gfloat *parms)

Typedef for definition of class pointer structure.

---

Enumeration Type Documentation

enum obitFitModelCompType

enum for Model Component model type Enumeration values: OBIT_FitModel_PointMod  Point. OBIT_FitModel_GaussMod  Gaussian on sky. OBIT_FitModel_CGaussMod  Convolved Gaussian. OBIT_FitModel_USphereMod  Uniform sphere. OBIT_FitModel_Background  Background surface. OBIT_FitModel_Unknown  Unknown.

---

Function Documentation

ObitFitModel* newObitFitModel (  gchar *  name  )

Public: Default Constructor. Initializes class if needed on first call. Parameters: name  An optional name for the object. Returns: the new object.

void ObitFitModelClassInit (  void   )

Public: Class initializer.

void ObitFitModelClone (  ObitFitModel *  in, ObitFitModel *  out, ObitErr *  err )

Public: Copy structure. Parameters: in  The object to copy out  An existing object pointer for output, must be defined. err  Obit error/message stack object.

ObitFitModel* ObitFitModelCopy (  ObitFitModel *  in, ObitFitModel *  out, ObitErr *  err )

Public: Copy (deep) constructor. Parameters: in  The object to copy out  An existing object pointer for output or NULL if none exists. err  Obit error stack object. Returns: pointer to the new object.

ObitFitModel* ObitFitModelCreate (  gchar *  name, ObitFitModelCompType  type, gfloat  Peak, gfloat  DeltaX, gfloat  DeltaY, gint  nparm, gfloat *  parms )

Public: Create/initialize ObitFitModel structures. Parameters: name  An optional name for the object. type  Model type of the model component Peak  Peak density DeltaX  "X" (RA) offset (deg) of center from reference position DeltaY  "Y" (Dec) offset (deg) of center from reference position nparm  Number of parameters parms  Model parameters, type dependent Returns: the new object.

gint ObitFitModelDeconGau (  gfloat  bmaj, gfloat  bmin, gfloat  bpa, gfloat  ebmaj, gfloat  ebmin, gfloat  ebpa, gfloat  cbmaj, gfloat  cbmin, gfloat  cbpa, gfloat  dgau[3][3] )

Public: Deconvolve Gaussians.

gconstpointer ObitFitModelGetClass (  void   )

Public: ClassInfo pointer. Returns: pointer to the class structure.

---