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

ObitUVSelfCal.h File Reference

ObitUVSelfCal Class for uv data self calibration. More...

#include "ObitUV.h"
#include "ObitTableSN.h"
#include "ObitSkyModel.h"
#include "ObitUVGSolve.h"
#include "ObitDisplay.h"

Go to the source code of this file.

Classes

struct  ObitUVSelfCal
 ObitUVSelfCal Class structure. More...
struct  ObitUVSelfCalClassInfo
 ClassInfo Structure. More...

Defines

#define ObitUVSelfCalUnref(in)   ObitUnref (in)
 Macro to unreference (and possibly destroy) an ObitUVSelfCal returns a ObitUVSelfCal*.
#define ObitUVSelfCalRef(in)   ObitRef (in)
 Macro to reference (update reference count) an ObitUVSelfCal.
#define ObitUVSelfCalIsA(in)   ObitIsA (in, ObitUVSelfCalGetClass())
 Macro to determine if an object is the member of this or a derived class.

Typedefs

typedef ObitUVSelfCal *(* ObitUVSelfCalCreateFP )(gchar *name, ObitSkyModel *skyModel)
 Typedef for definition of class pointer structure.

Functions

void ObitUVSelfCalClassInit (void)
 Public: Class initializer.
ObitUVSelfCal * newObitUVSelfCal (gchar *name)
 Public: Default Constructor.
ObitUVSelfCal * ObitUVSelfCalCreate (gchar *name, ObitSkyModel *skyModel)
 Public: Create/initialize ObitUVSelfCal structures.
gconstpointer ObitUVSelfCalGetClass (void)
 Public: ClassInfo pointer.
ObitUVSelfCal * ObitUVSelfCalCopy (ObitUVSelfCal *in, ObitUVSelfCal *out, ObitErr *err)
 Public: Copy (deep) constructor.
void ObitUVSelfCalClone (ObitUVSelfCal *in, ObitUVSelfCal *out, ObitErr *err)
 Public: Copy structure.
gboolean ObitUVSelfCalSelfCal (ObitUVSelfCal *in, ObitUV *inUV, gboolean init, gboolean *noSCNeed, ObitDConCleanWindow *window, ObitErr *err)
 Public: Determine calibration.
void ObitUVSelfCalModel (ObitUVSelfCal *in, ObitUV *inUV, ObitErr *err)
 Public: Determine initial calibration with point model.
void ObitUVSelfCalFluxHist (ObitUVSelfCal *in, ObitUV *inUV, ObitErr *err)
 Get Flux density histogram.
void ObitUVSelfCalBLRange (ObitUVSelfCal *in, ObitErr *err)
 Find uv range for a current model.

Detailed Description

ObitUVSelfCal Class for uv data self calibration.

This class is derived from the Obit class.

Routines determine calibration for an ObitUV and write an SN table. Control parameters are on the info member.

Creators and Destructors

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

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

Define Documentation

#define ObitUVSelfCalIsA (  in   )     ObitIsA (in, ObitUVSelfCalGetClass())
 

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

Macro to reference (update reference count) an ObitUVSelfCal.

returns a ObitUVSelfCal*. in = object to reference

#define ObitUVSelfCalUnref (  in   )     ObitUnref (in)
 

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

in = object to unreference

Typedef Documentation

typedef ObitUVSelfCal*(* ObitUVSelfCalCreateFP)(gchar *name, ObitSkyModel *skyModel)
 

Typedef for definition of class pointer structure.

Function Documentation

ObitUVSelfCal* newObitUVSelfCal (  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 ObitUVSelfCalBLRange (  ObitUVSelfCal *  in,
ObitErr *  err
) 
 

Find uv range for a current model.

Returns a uv range from the longest baseline whose average flux amplitude - 1 X RMS exceeds the sum of the clean components in the mosaic member of the SkyModel member to infinity. Results saved in the UVFullRange member. If there is no histogram all baselines are accepted.

Parameters:
in Input Self Cal
inUV UV data to examine
err Error stack, returns if not empty.

void ObitUVSelfCalClassInit (  void   ) 
 

Public: Class initializer.

void ObitUVSelfCalClone (  ObitUVSelfCal *  in,
ObitUVSelfCal *  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.

ObitUVSelfCal* ObitUVSelfCalCopy (  ObitUVSelfCal *  in,
ObitUVSelfCal *  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.

ObitUVSelfCal* ObitUVSelfCalCreate (  gchar *  name,
ObitSkyModel *  skyModel
) 
 

Public: Create/initialize ObitUVSelfCal structures.

Parameters:
name An optional name for the object.
skyModel Sky model [optional] to normalize uv data
Returns:
the new object.

void ObitUVSelfCalFluxHist (  ObitUVSelfCal *  in,
ObitUV *  inUV,
ObitErr *  err
) 
 

Get Flux density histogram.

Histogram forced to be monitonically decreasing with baseline. Also computes RMS of average values as histRMS

Parameters:
in Input Self Cal
inUV UV data to examine
err Error stack, returns if not empty.

gconstpointer ObitUVSelfCalGetClass (  void   ) 
 

Public: ClassInfo pointer.

Returns:
pointer to the class structure.

void ObitUVSelfCalModel (  ObitUVSelfCal *  in,
ObitUV *  inUV,
ObitErr *  err
) 
 

Public: Determine initial calibration with point model.

On output, the dataset has a new SN table with this calibration and is set up to apply them.

Parameters:
in Input self cal object. Control parameters are on the info member.
  • "modelFlux" OBIT_float (1,1,1) Model flux density [def 1.0]
  • "modelPos" OBIT_float (2,1,1) Model posn. offset (X, y) asec [def 0]
  • "modelParm" OBIT_float (?,1,1) Other model parameters: major_axis (deg), minor_axis (deg), position_angle (deg), type (ObitSkyModelCompType as gint); [def 0]
  • "subA" OBIT_int (1,1,1) Selected subarray (default 1)
  • "solInt" OBIT_float (1,1,1) Solution interval (min). (default 1 sec)
  • "refAnt" OBIT_int (1,1,1) Ref ant to use. (default 1)
  • "avgPol" OBIT_bool (1,1,1) True if RR and LL to be averaged (false)
  • "avgIF" OBIT_bool (1,1,1) True if all IFs to be averaged (false)
  • "SNRMin" OBIT_float (1,1,1) Minimum acceptable SNR (5)
  • "doMGM" OBIT_bool (1,1,1) True then find the mean gain modulus (true)
  • "solType" OBIT_string (4,1,1 Solution type ' ', 'L1', (' ')
  • "solMode" OBIT_string (4,1,1 Solution mode: 'A&P', 'P', 'P!A', 'GCON' ('P')
  • "minNo" OBIT_int (1,1,1) Min. no. antennas. (default 4)
  • "antWt" OBIT_float (*,1,1) Antenna weights. (default 1.0)
  • "UVR_Full"OBIT_float (2,1,1) Range of baseline lengths with full weight (kilolamda). If none is given then derive one if possible.
  • "WtUV" OBIT_float (1,1,1) Weight outside of UVRANG. (default 1.0)
  • "prtLv" OBIT_int (1,1,1) Print level (default no print)
  • "doSmoo" OBIT_bool (1,1,1) True then interpolate failed solutions [F]
inUV Input UV data.
err Error/message stack, returns if error.

gboolean ObitUVSelfCalSelfCal (  ObitUVSelfCal *  in,
ObitUV *  inUV,
gboolean  init,
gboolean *  noSCNeed,
ObitDConCleanWindow *  window,
ObitErr *  err
) 
 

Public: Determine calibration.

On output, the dataset has a new SN table with this calibration and is set up to apply them. Routine determines if self calibration is converged, if so TRUE is returned (else FALSE) and the best SN table is set to be applied.

Parameters:
in Input self cal object. Control parameters are on the info member.
  • "subA" OBIT_int (1,1,1) Selected subarray (default 1)
  • "solInt" OBIT_float (1,1,1) Solution interval (min). (default 1 sec)
  • "refAnt" OBIT_int (1,1,1) Ref ant to use. (default 1)
  • "avgPol" OBIT_bool (1,1,1) True if RR and LL to be averaged (false)
  • "avgIF" OBIT_bool (1,1,1) True if all IFs to be averaged (false)
  • "SNRMin" OBIT_float (1,1,1) Minimum acceptable SNR (5)
  • "doMGM" OBIT_bool (1,1,1) True then find the mean gain modulus (true)
  • "solType" OBIT_string (4,1,1 Solution type ' ', 'L1', (' ')
  • "solMode" OBIT_string (4,1,1 Solution mode: 'A&P', 'P', 'P!A', 'GCON' ('P')
  • "minNo" OBIT_int (1,1,1) Min. no. antennas. (default 4)
  • "antWt" OBIT_float (*,1,1) Antenna weights. (default 1.0)
  • "UVR_Full"OBIT_float (2,1,1) Range of baseline lengths with full weight (kilolamda). If none is given then derive one if possible.
  • "WtUV" OBIT_float (1,1,1) Weight outside of UVRANG. (default 1.0)
  • "prtLv" OBIT_int (1,1,1) Print level (default no print)
  • "minFluxPSC" OBIT_float (1,1,1) min peak flux for phase selfcal
  • "minFluxASC" OBIT_float (1,1,1) min peak flux for A&P selfcal
  • "doSmoo" OBIT_bool (1,1,1) True then interpolate failed solutions [F]
  • "dispURL" OBIT_string scalar = URL of display server
  • "peakFlux" OBIT_float scalar If present and > 0.0, then this is the highest image pixel value to use to determine if SC needed else use sum of CC in SkyModel.
inUV Input UV data.
init If True, this is the first SC in a series.
noSCNeed If True, no self calibration was needed
window If nonNULL, the CLEAN window to be edited.
err Error/message stack, returns if error.
Returns:
True if SC converged, else False. No gain solution if True

Generated on Fri Aug 31 22:13:10 2007 for Obit by  doxygen 1.3.9.1