ObitDConCleanImage.c File Reference

ObitDConCleanImage class function definitions. More...

#include "ObitDConCleanImage.h"
#include "ObitMem.h"
#include "ObitFFT.h"
#include "ObitTableCCUtil.h"

Functions
void	ObitDConCleanImageInit (gpointer in)
	Private: Initialize newly instantiated object.
void	ObitDConCleanImageClear (gpointer in)
	Private: Deallocate members.
ObitDConCleanImage *	newObitDConCleanImage (gchar *name)
	Public: Default Constructor.
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.
ObitDConCleanImage *	ObitDConCleanImageCreate (gchar *name, ObitImageMosaic *mosaic, ObitErr *err)
	Public: Create/initialize ObitDConCleanImage structures.
void	ObitDConCleanImageDeconvolve (ObitDCon *inn, ObitErr *err)
	Public: Do deconvolution.
void	ObitDConCleanImageGetParms (ObitDCon *inn, ObitErr *err)
	Public: Get parameters.
void	ObitDConCleanImageSub (ObitDConCleanImage *in, ObitErr *err)
	Public: Subtract components and generate new residual image(s).
void	ObitDConCleanImageClassInit (void)
	Public: Class initializer.

---

Detailed Description

ObitDConCleanImage class function definitions.

Image based CLEAN class. This class is derived from the ObitDCon class.

---

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 ObitDConCleanImageClear (  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 ObitDConCleanImage* cast to an Obit*.

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

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

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.

---