ObitDConCleanPxList.h File Reference

ObitDConCleanPxList CLEAN image pixel list/CLEAN class. More...

#include "Obit.h"
#include "ObitErr.h"
#include "ObitImageMosaic.h"
#include "ObitDConCleanWindow.h"
#include "ObitTableCC.h"
#include "ObitDef.h"
#include "ObitClassDef.h"

Go to the source code of this file.

Classes
struct	ObitDConCleanPxList
	ObitDConCleanPxList Class structure. More...
struct	ObitDConCleanPxListClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitDConCleanPxListUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitDConCleanPxList returns a ObitDConCleanPxList*.
#define	ObitDConCleanPxListRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitDConCleanPxList.
#define	ObitDConCleanPxListIsA(in)   ObitIsA (in, ObitDConCleanPxListGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitDConCleanPxListClassInit (void)
	Public: Class initializer.
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.

---

Detailed Description

ObitDConCleanPxList CLEAN image pixel list/CLEAN class.

This class is derived from the Obit class.

Creators and Destructors

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

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

---

Define Documentation

#define ObitDConCleanPxListIsA (  in   )     ObitIsA (in, ObitDConCleanPxListGetClass())

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

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

#define ObitDConCleanPxListUnref (  in   )     ObitUnref (in)

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

---

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 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 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.

---