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

ObitDConCleanOTF.c File Reference

ObitDConCleanOTF class function definitions. More...

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

Functions

void ObitDConCleanOTFInit (gpointer in)
 Private: Initialize newly instantiated object.
void ObitDConCleanOTFClear (gpointer in)
 Private: Deallocate members.
ObitDConCleanOTFnewObitDConCleanOTF (gchar *name)
 Public: Default Constructor.
gconstpointer ObitDConCleanOTFGetClass (void)
 Public: ClassInfo pointer.
ObitDConCleanOTFObitDConCleanOTFCopy (ObitDConCleanOTF *in, ObitDConCleanOTF *out, ObitErr *err)
 Public: Copy (deep) constructor.
void ObitDConCleanOTFClone (ObitDConCleanOTF *in, ObitDConCleanOTF *out, ObitErr *err)
 Public: Copy structure.
ObitDConCleanOTFObitDConCleanOTFCreate (gchar *name, ObitImage *dirty, ObitImage *beam, ObitImage *clean, ObitErr *err)
 Public: Create/initialize ObitDConCleanOTF structures.
void ObitDConCleanOTFDeconvolve (ObitDCon *inn, ObitErr *err)
 Public: Do deconvolution.
void ObitDConCleanOTFGetParms (ObitDCon *inn, ObitErr *err)
 Public: Get parameters.
void ObitDConCleanOTFSub (ObitDConClean *inn, ObitErr *err)
 Public: Generate residual image.
void ObitDConCleanOTFRestore (ObitDConClean *inn, ObitErr *err)
 Public: Restore subtracted components.
gboolean ObitDConCleanOTFSelect (ObitDConClean *inn, ObitErr *err)
 Public:Select components .
void ObitDConCleanOTFPixelStats (ObitDConClean *in, ObitErr *err)
 Public: Prepare for minor cycle.
void ObitDConCleanOTFClassInit (void)
 Public: Class initializer.


Detailed Description

ObitDConCleanOTF class function definitions.

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


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 ObitDConCleanOTFClear 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 ObitDConCleanOTF* cast to an Obit*.

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 ObitDConCleanOTFInit gpointer  inn  ) 
 

Private: Initialize newly instantiated object.

Parent classes portions are (recursively) initialized first

Parameters:
inn Pointer to the object to initialize.

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 *  in,
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