ObitImageFit.h File Reference

ObitImageFit fits models to images. More...

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

Go to the source code of this file.

Classes
struct	ObitImageFit
	ObitImageFit Class structure. More...
struct	ObitImageFitClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitImageFitUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitImageFit returns a ObitImageFit*.(NULL) in = object to unreference.
#define	ObitImageFitRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitImageFit.
#define	ObitImageFitIsA(in)   ObitIsA (in, ObitImageFitGetClass())
	Macro to determine if an object is the member of this or a derived class.
Typedefs
typedef ObitImageFit *(*	ObitImageFitCreateFP )(gchar *name)
	Typedef for definition of class pointer structure.
typedef gint(*	ObitImageFitFitFP )(ObitImageFit *in, ObitImage *image, ObitFitRegion *reg, ObitErr *err)
	Typedef for definition of class pointer structure.
Functions
void	ObitImageFitClassInit (void)
	Public: Class initializer.
ObitImageFit *	newObitImageFit (gchar *name)
	Public: Default Constructor.
ObitImageFit *	ObitImageFitCreate (gchar *name)
	Public: Create/initialize ObitImageFit structures.
gint	ObitImageFitFit (ObitImageFit *in, ObitImage *image, ObitFitRegion *reg, ObitErr *err)
	Public: Fit an ObitFitRegion.
gconstpointer	ObitImageFitGetClass (void)
	Public: ClassInfo pointer.
ObitImageFit *	ObitImageFitCopy (ObitImageFit *in, ObitImageFit *out, ObitErr *err)
	Public: Copy (deep) constructor.
void	ObitImageFitClone (ObitImageFit *in, ObitImageFit *out, ObitErr *err)
	Public: Copy structure.

---

Detailed Description

ObitImageFit fits models to images.

This class is derived from the Obit class.

Fits image models in an ObitFitRegion.

Creators and Destructors

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

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

---

Define Documentation

#define ObitImageFitIsA (  in   )     ObitIsA (in, ObitImageFitGetClass())

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

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

#define ObitImageFitUnref (  in   )     ObitUnref (in)

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

---

Typedef Documentation

typedef ObitImageFit*(* ObitImageFitCreateFP)(gchar *name)

Typedef for definition of class pointer structure.

typedef gint(* ObitImageFitFitFP)(ObitImageFit *in, ObitImage *image, ObitFitRegion *reg, ObitErr *err)

Typedef for definition of class pointer structure.

---

Function Documentation

ObitImageFit* newObitImageFit (  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 ObitImageFitClassInit (  void   )

Public: Class initializer.

void ObitImageFitClone (  ObitImageFit *  in, ObitImageFit *  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 stack object.

ObitImageFit* ObitImageFitCopy (  ObitImageFit *  in, ObitImageFit *  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.

ObitImageFit* ObitImageFitCreate (  gchar *  name  )

Public: Create/initialize ObitImageFit structures. Parameters: name  An optional name for the object. Returns: the new object.

gint ObitImageFitFit (  ObitImageFit *  in, ObitImage *  image, ObitFitRegion *  reg, ObitErr *  err )

Public: Fit an ObitFitRegion. Parameters: in  Fitter to use, control info in info: "MaxIter" OBIT_int (1,1,1) Maximum number of iterations defaults to 10 per fitted parameter "prtLv" OBIT_int (1,1,1) Message level, 0=>none [def 0] "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 to fit, should have pixel array attached and opened as described in reg (BLC, TRC). reg  Region in image to fit, on input the initial guess on output, the fitted result err  Obit error/message stack. Returns: a completion code: 0=> converged, 1=> max. iterations.

gconstpointer ObitImageFitGetClass (  void   )

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

---