ObitDConCleanPxList.c File Reference

ObitDConCleanPxList class function definitions. More...

#include "ObitDConCleanPxList.h"
#include "ObitMem.h"

Functions
void	ObitDConCleanPxListInit (gpointer in)
	Private: Initialize newly instantiated object.
void	ObitDConCleanPxListClear (gpointer in)
	Private: Deallocate members.
ObitDConCleanPxList *	newObitDConCleanPxList (gchar *name)
	Public: Default Constructor.
gconstpointer	ObitDConCleanPxListGetClass (void)
	Public: ClassInfo pointer.
ObitDConCleanPxList *	ObitDConCleanPxListCopy (ObitDConCleanPxList *in, ObitDConCleanPxList *out, ObitErr *err)
	Public: Copy (deep) constructor.
void	ObitDConCleanPxListClone (ObitDConCleanPxList *in, ObitDConCleanPxList *out, ObitErr *err)
	Public: Copy structure.
ObitDConCleanPxList *	ObitDConCleanPxListCreate (gchar *name, ObitImageMosaic *mosaic, glong maxPixel, ObitErr *err)
	Public: Create/initialize ObitDCon structures.
void	ObitDConCleanPxListGetParms (ObitDConCleanPxList *in, ObitErr *err)
	Public: Get Parameters.
void	ObitDConCleanPxListReset (ObitDConCleanPxList *in, ObitErr *err)
	Public: Reset Clean.
void	ObitDConCleanPxListResize (ObitDConCleanPxList *in, glong maxPixel, ObitErr *err)
	Public: Resize Arrrays.
void	ObitDConCleanPxListUpdate (ObitDConCleanPxList *in, glong *fields, glong nSkip, gfloat minFluxLoad, gfloat autoWinFlux, ObitDConCleanWindow *window, ObitFArray *BeamPatch, ObitErr *err)
	Public: Update with new image and window.
gboolean	ObitDConCleanPxListCLEAN (ObitDConCleanPxList *in, ObitErr *err)
	Public: Do minor cycle CLEANing.
glong	ObitDConCleanPxListResult (ObitDConCleanPxList *in, glong *ncomp, ObitErr *err)
	Public: Get results of CLEAN.
void	ObitDConCleanPxListClassInit (void)
	Public: Class initializer.

---

Detailed Description

ObitDConCleanPxList class function definitions.

This class determines the pixel histogram of an image. This class is derived from the Obit base class.

---

Function Documentation

ObitDConCleanPxList* newObitDConCleanPxList (  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 ObitDConCleanPxListClassInit (  void   )

Public: Class initializer.

gboolean ObitDConCleanPxListCLEAN (  ObitDConCleanPxList *  in, ObitErr *  err )

Public: Do minor cycle CLEANing. Parameters: in  The Pixel list object err  Obit error stack object. Returns: TRUE if hit limit of niter or min. flux density.

void ObitDConCleanPxListClear (  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 ObitDConCleanPxList* cast to an Obit*.

void ObitDConCleanPxListClone (  ObitDConCleanPxList *  in, ObitDConCleanPxList *  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.

ObitDConCleanPxList* ObitDConCleanPxListCopy (  ObitDConCleanPxList *  in, ObitDConCleanPxList *  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.

ObitDConCleanPxList* ObitDConCleanPxListCreate (  gchar *  name, ObitImageMosaic *  mosaic, glong  maxPixel, ObitErr *  err )

Public: Create/initialize ObitDCon structures. Parameters: name  An optional name for the object. mosaic  Image mosaic to be deconvolved. maxPixel  Maximum number of pixels allowed (dim. or arrays) Returns: the new object.

gconstpointer ObitDConCleanPxListGetClass (  void   )

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

void ObitDConCleanPxListGetParms (  ObitDConCleanPxList *  in, ObitErr *  err )

Public: Get Parameters. "minFlux" OBIT_float array = Minimun flux density (Jy) per field If only one given it is used for all. "Factor" OBIT_float array = CLEAN depth factor per field If only one given it is used for all. "fGauss" OBIT_float array = Gaussian size (deg) per field "CCVer" OBIT_int array = CLEAN table version per field If only one given it is used for all. "prtLv" OBIT_int = message level [def 2] 0=none, 1=summary, 2=normal, higher numbers for diagnostics Parameters: in  The Pixel list CLEAN object err  Obit error stack object.

void ObitDConCleanPxListInit (  gpointer  inn  )

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

void ObitDConCleanPxListReset (  ObitDConCleanPxList *  in, ObitErr *  err )

Public: Reset Clean. Parameters: in  The Pixel List object err  Obit error stack object.

void ObitDConCleanPxListResize (  ObitDConCleanPxList *  in, glong  maxPixel, ObitErr *  err )

Public: Resize Arrrays. Parameters: in  The Pixel List object maxPixel  Maximum number of pixels allowed (dim. or arrays) err  Obit error stack object.

glong ObitDConCleanPxListResult (  ObitDConCleanPxList *  in, glong *  ncomp, ObitErr *  err )

Public: Get results of CLEAN. Parameters: in  The Pixel List object ncomps  Array of total number of components per field, same order as in ObitImageMosaic err  Obit error stack object.

void ObitDConCleanPxListUpdate (  ObitDConCleanPxList *  in, glong *  fields, glong  nSkip, gfloat  minFluxLoad, gfloat  autoWinFlux, ObitDConCleanWindow *  window, ObitFArray *  BeamPatch, ObitErr *  err )

Public: Update with new image and window. Parameters: in  The Pixel List object fields  Which fields? (1-rel) as zero terminated list nSkip  Number of residuals to skip between ones accepted minFluxLoad  Minimum pixel flux density to accept autoWinFlux  min. residual flux allowed for auto Window window  Windows object corresponding to Image Mosaic being CLEANED Only pixels inside of the CLEAN window are used. err  Obit error stack object.

---