ObitDConCleanOTF.h File Reference

ObitDConCleanOTF Image based (BGC-like) CLEAN class for OTF (single dish data). More...

#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include <math.h>
#include <glib.h>
#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	ObitDConCleanOTF
	ObitDConCleanOTF Class structure. More...
struct	ObitDConCleanOTFClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitDConCleanOTFUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitDConCleanOTF returns a ObitDConCleanOTF*.
#define	ObitDConCleanOTFRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitDConCleanOTF.
#define	ObitDConCleanOTFIsA(in)   ObitIsA (in, ObitDConCleanOTFGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitDConCleanOTFClassInit (void)
	Public: Class initializer.
ObitDConCleanOTF *	newObitDConCleanOTF (gchar *name)
	Public: Default Constructor.
ObitDConCleanOTF *	ObitDConCleanOTFCreate (gchar *name, ObitImage *dirty, ObitImage *beam, ObitImage *clean, ObitErr *err)
	Public: Create/initialize ObitDConCleanOTF structures.
gconstpointer	ObitDConCleanOTFGetClass (void)
	Public: ClassInfo pointer.
ObitDConCleanOTF *	ObitDConCleanOTFCopy (ObitDConCleanOTF *in, ObitDConCleanOTF *out, ObitErr *err)
	Public: Copy (deep) constructor.
void	ObitDConCleanOTFClone (ObitDConCleanOTF *in, ObitDConCleanOTF *out, ObitErr *err)
	Public: Copy structure.
void	ObitDConCleanOTFDeconvolve (ObitDCon *in, ObitErr *err)
	Public: Do deconvolution.
void	ObitDConCleanOTFGetParms (ObitDCon *in, ObitErr *err)
	Public: Get parameters.
void	ObitDConCleanOTFSub (ObitDConClean *in, ObitErr *err)
	Public: Generate residual image.
gboolean	ObitDConCleanOTFSelect (ObitDConClean *in, ObitErr *err)
	Public:Select components .
void	ObitDConCleanOTFRestore (ObitDConClean *in, ObitErr *err)
	Public: Restore subtracted components.
void	ObitDConCleanOTFPixelStats (ObitDConClean *in, ObitErr *err)
	Public: Prepare for minor cycle.

---

Detailed Description

ObitDConCleanOTF Image based (BGC-like) CLEAN class for OTF (single dish data).

This CLEAN is appropriate for Single dish deconvolution where the instrumental PSF is of very limited support. The dirty image is used with the dirty beam to decompose selected pixels into a set of delta functions stores in an AIPS CC table. Windowing is supported and the dirty beam should have the same pixel spacing as the dirty beam but need not be the same size.

Creators and Destructors

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

A copy of a pointer to an ObitDConCleanOTF should always be made using the ObitDConCleanOTFRef function which updates the reference count in the object. Then whenever freeing an ObitDConCleanOTF or changing a pointer, the function ObitDConCleanOTFUnref 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
• "Patch" OBIT_int scalar = Size of beam patch in pixels [def all]
• "BeamSize"OBIT_float scalar = Restoring beam FWHM (deg)
• "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-?
• "CCVer" OBIT_int = CC table version number
• "noResid" OBIT_bool scalar = If defined and TRUE, set residuals to Zero in restore

---

Define Documentation

#define ObitDConCleanOTFIsA (  in   )     ObitIsA (in, ObitDConCleanOTFGetClass())

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

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

#define ObitDConCleanOTFUnref (  in   )     ObitUnref (in)

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

---

Function Documentation

ObitDConCleanOTF* newObitDConCleanOTF (  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 ObitDConCleanOTFClassInit (  void   )

Public: Class initializer.

void ObitDConCleanOTFClone (  ObitDConCleanOTF *  in, ObitDConCleanOTF *  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.

ObitDConCleanOTF* ObitDConCleanOTFCopy (  ObitDConCleanOTF *  in, ObitDConCleanOTF *  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.

ObitDConCleanOTF* ObitDConCleanOTFCreate (  gchar *  name, ObitImage *  dirty, ObitImage *  beam, ObitImage *  clean, ObitErr *  err )

Public: Create/initialize ObitDConCleanOTF structures. Parameters: name  An optional name for the object. dirty  Dirty image beam  Dirty beam, actual raw instrumental response clean  Image to receive Clean residual or restored image err  Obit error stack object. Returns: the new object.

void ObitDConCleanOTFDeconvolve (  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) "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 ObitDConCleanOTFGetClass (  void   )

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

void ObitDConCleanOTFGetParms (  ObitDCon *  inn, ObitErr *  err )

Public: Get parameters. This Class: "Patch" OBIT_int scalar = Beam patch in pixels [def 100] "BeamSize"OBIT_float scalar = Restoring beam FWHM (deg) Parameters: in  The CLEAN object as base class err  Obit error stack object.

void ObitDConCleanOTFPixelStats (  ObitDConClean *  in, ObitErr *  err )

Public: Prepare for minor cycle. Parameters: in  The object to deconvolve err  Obit error stack object.

void ObitDConCleanOTFRestore (  ObitDConClean *  inn, ObitErr *  err )

Public: Restore subtracted components. BeamSize OBIT_float scalar CLEAN restoring beam FWHM in asec [def 3.0]. If < 0 then don't restore. Parameters: in  Object with OTFCLEAN structures. err  Error stack Returns: pointer to OTFCLEAN object (ref. count updated).

gboolean ObitDConCleanOTFSelect (  ObitDConClean *  inn, ObitErr *  err )

Public:Select components . Parameters: in  The object to deconvolve err  Obit error stack object. Returns: TRUE if deconvolution is complete

void ObitDConCleanOTFSub (  ObitDConClean *  inn, ObitErr *  err )

Public: Generate residual image. Parameters: in  The object to deconvolve err  Obit error stack object.

---