ObitDConCleanImage.h File Reference

ObitDConCleanImage Image based (BGC-like) CLEAN class. More...

#include "Obit.h"
#include "ObitErr.h"
#include "ObitDConClean.h"
#include "ObitImageMosaic.h"
#include "ObitDConCleanWindow.h"
#include "ObitDConCleanBmHist.h"
#include "ObitDConCleanPxHist.h"
#include "ObitDConCleanPxList.h"

Go to the source code of this file.

Classes
struct	ObitDConCleanImage
	ObitDConCleanImage Class structure. More...
struct	ObitDConCleanImageClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitDConCleanImageUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitDConCleanImage returns a ObitDConCleanImage*.
#define	ObitDConCleanImageRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitDConCleanImage.
#define	ObitDConCleanImageIsA(in)   ObitIsA (in, ObitDConCleanImageGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitDConCleanImageClassInit (void)
	Public: Class initializer.
ObitDConCleanImage *	newObitDConCleanImage (gchar *name)
	Public: Default Constructor.
ObitDConCleanImage *	ObitDConCleanImageCreate (gchar *name, ObitImageMosaic *mosaic, ObitErr *err)
	Public: Create/initialize ObitDConCleanImage structures.
gconstpointer	ObitDConCleanImageGetClass (void)
	Public: ClassInfo pointer.
ObitDConCleanImage *	ObitDConCleanImageCopy (ObitDConCleanImage *in, ObitDConCleanImage *out, ObitErr *err)
	Public: Copy (deep) constructor.
void	ObitDConCleanImageClone (ObitDConCleanImage *in, ObitDConCleanImage *out, ObitErr *err)
	Public: Copy structure.
void	ObitDConCleanImageDeconvolve (ObitDCon *in, ObitErr *err)
	Public: Do deconvolution.
void	ObitDConCleanImageGetParms (ObitDCon *in, ObitErr *err)
	Public: Get parameters.
void	ObitDConCleanImageSub (ObitDConCleanImage *in, ObitErr *err)
	Public: Subtract components and generate new residual image(s).

---

Detailed Description

ObitDConCleanImage Image based (BGC-like) CLEAN class.

This class is derived from the ObitDConClean class.

Only a Single field can be CLEANed and only a quarter the area of it.

Creators and Destructors

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

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

CLEAN control information

The control parameters for the CLEAN are read from the ObitInfoList member when the Deconvolve function is called: The file etc. info should have been stored in the ObitInfoList:

• "Niter" OBIT_int scalar = Maximum number of CLEAN iterations
• "maxPixel" OBIT_int scalar = Maximum number of residuals [def 20000]
• "minPatch" OBIT_int scalar = Minimum beam patch in pixels [def 100]
• "BMAJ" OBIT_float scalar = Restoring beam major axis (deg)
• "BMIN" OBIT_float scalar = Restoring beam minor axis (deg)
• "BPA" OBIT_float scalar = Restoring beam position angle (deg)
• "Beam" OBIT_float array[3]= (BMAJ, BMIN, BPA) alternate form
• "Gain" OBIT_float scalar = CLEAN loop gain
• "minFlux" OBIT_float scalar = Minimun flux density (Jy)
• "Factor" OBIT_float array = CLEAN depth factor
• "Plane" OBIT_int array = Plane being processed, 1-rel indices of axes 3-? [def 1,1,1,1,1]
• "CLEANBox" OBIT_int [4,?] = Array of Clean boxes for field 1 Any entries with first element=0 are ignored.
• "prtLv" OBIT_int message level [def 2] 0=none, 1=summary, 2=normal, higher numbers for diagnostics
• "CCVer" OBIT_int = CC table version number

---

Define Documentation

#define ObitDConCleanImageIsA (  in   )     ObitIsA (in, ObitDConCleanImageGetClass())

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

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

#define ObitDConCleanImageUnref (  in   )     ObitUnref (in)

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

---

Function Documentation

ObitDConCleanImage* newObitDConCleanImage (  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 ObitDConCleanImageClassInit (  void   )

Public: Class initializer.

void ObitDConCleanImageClone (  ObitDConCleanImage *  in, ObitDConCleanImage *  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.

ObitDConCleanImage* ObitDConCleanImageCopy (  ObitDConCleanImage *  in, ObitDConCleanImage *  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.

ObitDConCleanImage* ObitDConCleanImageCreate (  gchar *  name, ObitImageMosaic *  mosaic, ObitErr *  err )

Public: Create/initialize ObitDConCleanImage structures. Parameters: name  An optional name for the object. mosaic  from which to create object err  Obit error stack object. Returns: the new object.

void ObitDConCleanImageDeconvolve (  ObitDCon *  inn, ObitErr *  err )

Public: Do deconvolution. CLEAN control parameters are in the ObitInfoList member: "Niter" OBIT_int scalar = Maximum number of CLEAN iterations "maxPixel" OBIT_int scalar = Maximum number of residuals [def 20000] "minPatch" OBIT_int scalar = Minimum beam patch in pixels [def 50] "BMAJ" OBIT_float scalar = Restoring beam major axis (deg) "BMIN" OBIT_float scalar = Restoring beam minor axis (deg) "BPA" OBIT_float scalar = Restoring beam position angle (deg) "Beam" OBIT_float array[3]= (BMAJ, BMIN, BPA) alternate form "CCVer" OBIT_int array = CLEAN table version per field "Gain" OBIT_float array = CLEAN loop gain per field "minFlux" OBIT_float array = Minimun flux density (Jy) per field "Factor" OBIT_float array = CLEAN depth factor per field "Plane" OBIT_int array = Plane being processed, 1-rel indices of axes 3-? Parameters: in  The object to deconvolve err  Obit error stack object.

gconstpointer ObitDConCleanImageGetClass (  void   )

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

void ObitDConCleanImageGetParms (  ObitDCon *  inn, ObitErr *  err )

Public: Get parameters. Parameters: in  The CLEAN object as base class err  Obit error stack object.

void ObitDConCleanImageSub (  ObitDConCleanImage *  in, ObitErr *  err )

Public: Subtract components and generate new residual image(s). Grids and FFT components, multiplies by transfer function (FFT of beam), reverse FFTs and subtracts from image. Parameters: in  The object to deconvolve err  Obit error stack object.

---