ObitImageFitData.h File Reference

ObitImageFitData Stores fitting data and provides evaluation routines. More...

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

Go to the source code of this file.

Classes
struct	ObitImageFitData
	ObitImageFitData Class structure. More...
struct	ObitImageFitDataClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitImageFitDataUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitImageFitData returns a ObitImageFitData*.
#define	ObitImageFitDataRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitImageFitData.
#define	ObitImageFitDataIsA(in)   ObitIsA (in, ObitImageFitDataGetClass())
	Macro to determine if an object is the member of this or a derived class.
Typedefs
typedef void(*	ObitImageFitDataFuncFP )(gpointer data, gdouble *p, gdouble *f, gdouble *grad, gint iflag)
	function pointer for evaluation routine used by solver
typedef ObitImageFitData *(*	ObitImageFitDataCreateFP )(gchar *name, ObitFitRegion *reg, ObitInfoList *bounds, ObitImage *image, ObitErr *err)
	Typedef for definition of class pointer structure.
typedef void(*	ObitImageFitData2RegFP )(ObitImageFitData *data, ObitFitRegion *reg)
Functions
void	ObitImageFitDataClassInit (void)
	Public: Class initializer.
ObitImageFitData *	newObitImageFitData (gchar *name)
	Public: Default Constructor.
ObitImageFitData *	ObitImageFitDataCreate (gchar *name, ObitFitRegion *reg, ObitInfoList *bounds, ObitImage *image, ObitErr *err)
	Public: Create/initialize ObitImageFitData structures.
void	ObitImageFitData2Reg (ObitImageFitData *data, ObitFitRegion *reg)
	Public: Copy contents to ObitFitRegion.
gconstpointer	ObitImageFitDataGetClass (void)
	Public: ClassInfo pointer.

---

Detailed Description

ObitImageFitData Stores fitting data and provides evaluation routines.

This class is derived from the Obit class.

Creators and Destructors

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

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

---

Define Documentation

#define ObitImageFitDataIsA (  in   )     ObitIsA (in, ObitImageFitDataGetClass())

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 ObitImageFitDataRef (  in   )     ObitRef (in)

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

#define ObitImageFitDataUnref (  in   )     ObitUnref (in)

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

---

Typedef Documentation

typedef void(* ObitImageFitData2RegFP)(ObitImageFitData *data, ObitFitRegion *reg)

typedef ObitImageFitData*(* ObitImageFitDataCreateFP)(gchar *name, ObitFitRegion *reg, ObitInfoList *bounds, ObitImage *image, ObitErr *err)

Typedef for definition of class pointer structure.

typedef void(* ObitImageFitDataFuncFP)(gpointer data, gdouble *p, gdouble *f, gdouble *grad, gint iflag)

function pointer for evaluation routine used by solver

---

Function Documentation

ObitImageFitData* newObitImageFitData (  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 ObitImageFitData2Reg (  ObitImageFitData *  data, ObitFitRegion *  reg )

Public: Copy contents to ObitFitRegion. Parameters: data  Fit data to copy reg  ObitFitRegion to update

void ObitImageFitDataClassInit (  void   )

Public: Class initializer.

ObitImageFitData* ObitImageFitDataCreate (  gchar *  name, ObitFitRegion *  reg, ObitInfoList *  bounds, ObitImage *  image, ObitErr *  err )

Public: Create/initialize ObitImageFitData structures. Parameters: name  An optional name for the object. reg  ObitFitRegion to copy bounds  InfoList giving bounds "PosGuard" OBIT_double (1,1,1) Distance from edge to allow center [def no bound] "FluxLow" OBIT_double (1,1,1) Lower bounds on Flux density [no bound] "GMajUp" OBIT_double (1,1,1) Major axis upper bound [no bound] "GMajLow" OBIT_double (1,1,1) Major axis lower bound [no bound] "GMinUp" OBIT_double (1,1,1) Minor axis upper bound [no bound] "GMinLow" OBIT_double (1,1,1) Minor axis lower bound [no bound] image  Image with pixel data, (with selection used for reg) err  Obit Error/mesage stack Returns: the new object.

gconstpointer ObitImageFitDataGetClass (  void   )

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

---