Main Page | Class List | Directories | File List | Class Members | File Members

ObitDConCleanOTFRec.h File Reference

This class derived from the #ObitDConClean class. More...

#include "Obit.h"
#include "ObitErr.h"
#include "ObitOTF.h"
#include "ObitDConClean.h"
#include "ObitDisplay.h"

Go to the source code of this file.

Classes

struct  ObitDConCleanOTFRec
 ObitDConCleanOTFRec Class structure. More...
struct  ObitDConCleanOTFRecClassInfo
 ClassInfo Structure. More...

Defines

#define ObitDConCleanOTFRecUnref(in)   ObitUnref (in)
 Macro to unreference (and possibly destroy) an ObitDConCleanOTF returns a ObitDConCleanOTF*.
#define ObitDConCleanOTFRecRef(in)   ObitRef (in)
 Macro to reference (update reference count) an ObitDConCleanOTFRec.
#define ObitDConCleanOTFRecIsA(in)   ObitIsA (in, ObitDConCleanOTFRecGetClass())
 Macro to determine if an object is the member of this or a derived class.

Functions

void ObitDConCleanOTFRecClassInit (void)
 Public: Class initializer.
ObitDConCleanOTFRecnewObitDConCleanOTFRec (gchar *name)
 Public: Default Constructor.
ObitDConCleanOTFRecObitDConCleanOTFRecCreate (gchar *name, ObitOTF *inOTF, ObitErr *err)
 Public: Create/initialize ObitDConCleanOTFRec structures.
gconstpointer ObitDConCleanOTFRecGetClass (void)
 Public: ClassInfo pointer.
ObitDConCleanOTFRecObitDConCleanOTFRecCopy (ObitDConCleanOTFRec *in, ObitDConCleanOTFRec *out, ObitErr *err)
 Public: Copy (deep) constructor.
void ObitDConCleanOTFRecClone (ObitDConCleanOTFRec *in, ObitDConCleanOTFRec *out, ObitErr *err)
 Public: Copy structure.
void ObitDConCleanOTFRecDeconvolve (ObitDCon *in, ObitErr *err)
 Public: Do deconvolution.
void ObitDConCleanOTFRecGetParms (ObitDCon *in, ObitErr *err)
 Public: Get parameters.
void ObitDConCleanOTFRecSub (ObitDConClean *in, ObitErr *err)
 Public: Generate residual image.
gboolean ObitDConCleanOTFRecSelect (ObitDConClean *in, ObitErr *err)
 Public:Select components .
void ObitDConCleanOTFRecRestore (ObitDConClean *in, ObitErr *err)
 Public: Restore subtracted components.
void ObitDConCleanOTFRecPixelStats (ObitDConClean *in, ObitErr *err)
 Public: Prepare for minor cycle.


Detailed Description

This class derived from the #ObitDConClean class.

ObitDConCleanOTF Record based CLEAN class for ObitOTF (single dish data). The technique is to occasionally subtract the CLEAN components from the OTF data and reimage. This is most useful for beamswitched data. The dirty image is used with the dirty beam to decompose selected pixels into a set of delta functions stored 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 ObitDConCleanOTFRec should always be made using the ObitDConCleanOTFRecRef function which updates the reference count in the object. Then whenever freeing an ObitDConCleanOTFRec or changing a pointer, the function ObitDConCleanOTFRecUnref 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: The OTF data file should have the following imaging parameters: Gridding convolution functions:

Define Documentation

#define ObitDConCleanOTFRecIsA in   )     ObitIsA (in, ObitDConCleanOTFRecGetClass())
 

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

Macro to reference (update reference count) an ObitDConCleanOTFRec.

returns a ObitDConCleanOTFRec*. in = object to reference

#define ObitDConCleanOTFRecUnref in   )     ObitUnref (in)
 

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

in = object to unreference


Function Documentation

ObitDConCleanOTFRec* newObitDConCleanOTFRec 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 ObitDConCleanOTFRecClassInit void   ) 
 

Public: Class initializer.

void ObitDConCleanOTFRecClone ObitDConCleanOTFRec in,
ObitDConCleanOTFRec 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.

ObitDConCleanOTFRec* ObitDConCleanOTFRecCopy ObitDConCleanOTFRec in,
ObitDConCleanOTFRec 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.

ObitDConCleanOTFRec* ObitDConCleanOTFRecCreate gchar *  name,
ObitOTF inOTF,
ObitErr *  err
 

Public: Create/initialize ObitDConCleanOTFRec structures.

Parameters:
name An optional name for the object.
inOTF Data to image
  • "outName" Obit_string = Base name of image files, dirty="Dirty"+outName+".fits" beam = "Beam"+outname+".fits" clean = outname+".fits"
  • "outDisk" OBIT_int [1,1,1] = Disk number for output files. [def 1]
  • "SCANS" OBIT_int [2,1,1] = Range of scan numbers, [def=all]
  • "DOCALIB" OBIT_int (1,1,1) = >0 -> calibrate,
  • "keepCal" OBIT_bool(1,1,1) = True = keep cal-on data [def TRUE]
  • "GAINUSE" OBIT_int (1,1,1) = SN/CL table version number, 0-> use highest
  • "FLAGVER" OBIT_int (1,1,1) = Flag table version, 0-> use highest, <0-> none
  • "STOKES" OBIT_string (4,1,1)= Selected output Stokes parameters: "I", "V", " " -> "I" [def "I"]
  • "BCHAN" OBIT_int (1,1,1) = First spectral channel selected. [def all]
  • "ECHAN" OBIT_int (1,1,1) = Highest spectral channel selected. [def all]
  • "FEEDS" OBIT_int (?,1,1) = List of selected feed numbers, [def all.]
  • "TARGETS" Obit_string [?,?] = List of target names to include
  • "RA" OBIT_float scalar = Center RA in deg
  • "Dec" OBIT_float scalar = Center Dec in deg
  • "nx" OBIT_int scalar = Number of cells in RA
  • "ny" OBIT_int scalar = Number of cells in Declination
  • "beamNx" OBIT_int scalar = Number of "x" pixels [def 32]
  • "beamNy" OBIT_int scalar = Number of "y" pixels [def 32]
  • "xCells" OBIT_float scalar = Cell spacing (deg) in RA
  • "yCells" OBIT_float scalar = Cell spacing (deg) in Dec
  • "minWt" OBIT_float scalar = Minimum sum of weights Default = 0.1.
  • "Proj" OBIT_string (4,1,1) Projection string "-SIN", "-ARC", "-TAN" [Default "-SIN"]
  • "ConvType"OBIT_int scalar = Convolving function type: [def=3] 0 = pillbox, 3 = Gaussian, 4 = Exp*Sinc, 5 = Spherodial wave
  • "ConvParm"OBIT_float[10] = Convolving function parameters (see below)
Gridding convolution functions:
  • 0 = pillbox,
  • 2 = Sinc, Parm[0] = halfwidth in cells, Parm[1] = Expansion factor
  • 3 = Gaussian, Parm[0] = halfwidth in cells,[def 3.0] Parm[1] = Gaussian with as fraction or raw beam [def 1.0]
  • 4 = Exp*Sinc Parm[0] = halfwidth in cells, [def 2.0] Parm[1] = 1/sinc factor (cells) [def 1.55] Parm[2] = 1/exp factor (cells) [def 2.52] Parm[3] = exp power [def 2.0]
  • 5 = Spherodial wave Parm[0] = halfwidth in cells [def 3.0] Parm[1] = Alpha [def 5.0] Parm[2] = Expansion factor [not used]
err Obit error stack object.
Returns:
the new object.

void ObitDConCleanOTFRecDeconvolve ObitDCon *  inn,
ObitErr *  err
 

Public: Do deconvolution.

CLEAN control parameters are in the ObitInfoList member:

  • "fracPeak"OBIT_float scalar = Fraction of residual to CLEAN to before major cycle [def 0.75]
  • "Niter" OBIT_int scalar = Maximum number of CLEAN iterations
  • "maxPixel" OBIT_int scalar = Maximum number of residuals [def 20000]
  • "Patch" 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-?
  • "dispURL" OBIT_string scalar= URL of display server
    Parameters:
    in The object to deconvolve
    err Obit error stack object.

gconstpointer ObitDConCleanOTFRecGetClass void   ) 
 

Public: ClassInfo pointer.

Returns:
pointer to the class structure.

void ObitDConCleanOTFRecGetParms 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)
  • "fracPeak"OBIT_float scalar = Fraction of residual to CLEAN to before major cycle [def 0.75]
The OTF data file should have the following imaging parameters:
  • "outName" Obit_string = Base name of image files, dirty="Dirty"+outName+".fits" beam = "Beam"+outname+".fits" clean = outname+".fits"
  • "outDisk" OBIT_int [1,1,1] = Disk number for output files. [def 1]
    Parameters:
    in The CLEAN object as base class
    err Obit error stack object.

void ObitDConCleanOTFRecPixelStats ObitDConClean *  in,
ObitErr *  err
 

Public: Prepare for minor cycle.

Parameters:
in The object to deconvolve
err Obit error stack object.

void ObitDConCleanOTFRecRestore 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 ObitDConCleanOTFRecSelect 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 ObitDConCleanOTFRecSub ObitDConClean *  inn,
ObitErr *  err
 

Public: Generate residual image.

Parameters:
in The object to deconvolve
err Obit error stack object.


Generated on Mon Sep 3 20:43:53 2007 by  doxygen 1.3.9.1