ObitFitRegion.c File Reference

ObitFitRegion class function definitions. More...

#include "ObitFitRegion.h"

Functions
void	ObitFitRegionInit (gpointer in)
	Private: Initialize newly instantiated object.
void	ObitFitRegionClear (gpointer in)
	Private: Deallocate members.
ObitFitRegion *	newObitFitRegion (gchar *name)
	Public: Default Constructor.
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.
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.
void	ObitFitRegionSubtract (ObitFitRegion *reg, ObitImage *image, ObitErr *err)
	Public: Subtract from image.
void	ObitFitRegionClassInit (void)
	Public: Class initializer.

---

Detailed Description

ObitFitRegion class function definitions.

This class is derived from the Obit base class.

---

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 ObitFitRegionClear (  gpointer  inn  )

Private: Deallocate members. Does (recursive) deallocation of parent class members. Parameters: inn  Pointer to the object to deallocate. Actually it should be an ObitFitRegion* cast to an Obit*.

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.

void ObitFitRegionInit (  gpointer  inn  )

Private: Initialize newly instantiated object. Parent classes portions are (recursively) initialized first Parameters: inn  Pointer to the object to initialize.

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

---