ObitFitRegion.h File Reference

ObitFitRegion Information about model fitting a regions of the sky. More...

#include "Obit.h"
#include "ObitErr.h"
#include "ObitFitModel.h"

Go to the source code of this file.

Classes
struct	ObitFitRegion
	ObitFitRegion Class structure. More...
struct	ObitFitRegionClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitFitRegionUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitFitRegion returns a ObitFitRegion*.
#define	ObitFitRegionRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitFitRegion.
#define	ObitFitRegionIsA(in)   ObitIsA (in, ObitFitRegionGetClass())
	Macro to determine if an object is the member of this or a derived class.
Typedefs
typedef ObitFitRegion *(*	ObitFitRegionCreateFP )(gchar *name, gint corner[2], gint dim[2], gfloat peak, gfloat peakResid, gfloat RMSResid, gfloat fluxResid, gint nmodel, ObitFitModel **models)
	Typedef for definition of class pointer structure.
Functions
void	ObitFitRegionClassInit (void)
	Public: Class initializer.
ObitFitRegion *	newObitFitRegion (gchar *name)
	Public: Default Constructor.
ObitFitRegion *	ObitFitRegionCreate (gchar *name, gint corner[2], gint dim[2], gfloat peak, gfloat peakResid, gfloat RMSResid, gfloat fluxResid, gint nmodel, ObitFitModel **models)
	Public: Create/initialize ObitFitRegion structures.
gchar *	ObitFitRegionName (gint indx)
	Public: Generate the region name from an index.
gconstpointer	ObitFitRegionGetClass (void)
	Public: ClassInfo pointer.
ObitFitRegion *	ObitFitRegionCopy (ObitFitRegion *in, ObitFitRegion *out, ObitErr *err)
	Public: Copy (deep) constructor.
void	ObitFitRegionClone (ObitFitRegion *in, ObitFitRegion *out, ObitErr *err)
	Public: Copy structure.
void	ObitFitRegionResize (ObitFitRegion *in, gint nmodel)
	Public: Resize.
void	ObitFitRegionSubtract (ObitFitRegion *reg, ObitImage *image, ObitErr *err)
	Public: Subtract from image.

---

Detailed Description

ObitFitRegion Information about model fitting a regions of the sky.

This class is derived from the Obit class.

Creators and Destructors

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

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

---

Define Documentation

#define ObitFitRegionIsA (  in   )     ObitIsA (in, ObitFitRegionGetClass())

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

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

#define ObitFitRegionUnref (  in   )     ObitUnref (in)

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

---

Typedef Documentation

typedef ObitFitRegion*(* ObitFitRegionCreateFP)(gchar *name, gint corner[2], gint dim[2], gfloat peak, gfloat peakResid, gfloat RMSResid, gfloat fluxResid, gint nmodel, ObitFitModel **models)

Typedef for definition of class pointer structure.

---

Function Documentation

ObitFitRegion* newObitFitRegion (  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 ObitFitRegionClassInit (  void   )

Public: Class initializer.

void ObitFitRegionClone (  ObitFitRegion *  in, ObitFitRegion *  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.

ObitFitRegion* ObitFitRegionCopy (  ObitFitRegion *  in, ObitFitRegion *  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.

ObitFitRegion* ObitFitRegionCreate (  gchar *  name, gint  corner[2], gint  dim[2], gfloat  peak, gfloat  peakResid, gfloat  RMSResid, gfloat  fluxResid, gint  nmodel, ObitFitModel **  models )

Public: Create/initialize ObitFitRegion structures. Parameters: name  A unique name for the object. corner  bottom left corner in selected region of image (0-rel) dim  dimension of region peak  peak in region peakResid  peak in region residual after model subtraction RMSResid  RMS residual fluxResid  Sum of pixel values in residual nmodel  Number of models models  Array of Models, steals references Returns: the new object.

gconstpointer ObitFitRegionGetClass (  void   )

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

gchar* ObitFitRegionName (  gint  indx  )

Public: Generate the region name from an index. Each region has the name "regnnnnnn" where nnnnnn is the 1-rel Parameters: index  index number of region Returns: name, should be g_freeed when done

void ObitFitRegionResize (  ObitFitRegion *  in, gint  nmodel )

Public: Resize. Parameters: in  The object to resize nmodel  New number of models

void ObitFitRegionSubtract (  ObitFitRegion *  reg, ObitImage *  image, ObitErr *  err )

Public: Subtract from image. Parameters: in  region model in image. image  Image with attached image buffer pixel array err  Obit Error/message stack

---