casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables
Public Member Functions | Public Attributes | Static Private Attributes
__casac__.calibrater.calibrater Class Reference
Inheritance diagram for __casac__.calibrater.calibrater:
__casac__.calibrater._object

List of all members.

Public Member Functions

def __init__
def open
def selectvis
def setmodel
def setptmodel
def setapply
def setsolve
def setsolvegainspline
def setsolvebandpoly
def state
def reset
def initcalset
def delmod
def solve
def correct
def corrupt
def fluxscale
def accumulate
def activityrec
def specifycal
def smooth
def listcal
def posangcal
def linpolcor
def plotcal
def modelfit
def close
def done

Public Attributes

 this

Static Private Attributes

dictionary __swig_setmethods__
tuple __setattr__
dictionary __swig_getmethods__
tuple __getattr__
 __repr__
 __swig_destroy__
 __del__

Detailed Description

Proxy of C++ casac::calibrater class

Definition at line 70 of file calibrater.py.


Constructor & Destructor Documentation

__init__(self) -> calibrater

Definition at line 77 of file calibrater.py.


Member Function Documentation

def __casac__.calibrater.calibrater.accumulate (   self,
  args,
  kwargs 
)
accumulate(self, tablein=string(""), incrtable=string(""), tableout=string(""), field=initialize_variant(""), 
    calfield=initialize_variant(""), interp=string("linear"), t=-1.0, 
    spwmap=initialize_vector(1, (int)-1)) -> bool

Summary
Accumulate incremental calibration
solutions into a cumulative calibration table

Input Parameters:
tablein          Input cumulative calibration table name 
incrtable        Input incremental calibration table name 
tableout         Output cumulative calibration table name. Default is input table name. 
field            List of fields (names) to update in input cumulative table. Default is all. 
calfield         List of fields (names) in incremental table to use. Default is use all. 
interp           Interpolation mode to use on incremental solutions linear 
t                Cumulative table timescale when creating from scratch -1.0 
spwmap           Spectral windows to apply -1 

--------------------------------------------------------------------------------

Definition at line 396 of file calibrater.py.

activityrec(self) -> record *

Summary
Returns a record containing properties of recent activity
--------------------------------------------------------------------------------

Definition at line 421 of file calibrater.py.

close(self) -> bool

Summary
Close the calibrater tool
--------------------------------------------------------------------------------

Definition at line 575 of file calibrater.py.

def __casac__.calibrater.calibrater.correct (   self,
  args,
  kwargs 
)
correct(self, applymode=string("")) -> bool

Summary
Apply calibration information

Input Parameters:
applymode        Correction cal/flag mode: ''='calflag','cal','flag','trial' 

--------------------------------------------------------------------------------

Definition at line 346 of file calibrater.py.

corrupt(self) -> bool

Summary
Corrupt model with calibration tables
--------------------------------------------------------------------------------

Definition at line 361 of file calibrater.py.

def __casac__.calibrater.calibrater.delmod (   self,
  args,
  kwargs 
)
delmod(self, otf=False, field=initialize_variant(""), scr=False) -> bool

Summary
Delete model data representations in the MS.

Input Parameters:
otf              If T, delete the otf model data keywords false 
field            Select on field 
scr              If T, delete the MODEL_DATA column false 

--------------------------------------------------------------------------------

Definition at line 318 of file calibrater.py.

done(self) -> bool

Summary
Destroy the calibrater tool
--------------------------------------------------------------------------------

Definition at line 586 of file calibrater.py.

def __casac__.calibrater.calibrater.fluxscale (   self,
  args,
  kwargs 
)
fluxscale(self, tablein, reference=initialize_variant(""), tableout=string(""), transfer=initialize_variant(""), 
    listfile=string(""), append=False, refspwmap=initialize_vector(1, (int)-1), 
    incremental=False) -> record *

Summary
Bootstrap the flux density scale from standard calibrators

Input Parameters:
tablein          Input calibration table name 
reference        Reference calibrator field names (comma-separated) 
tableout         Output calibration table name. Default is input calibration table name. 
transfer         Transfer source field names (comma-separated). Default is all other fields. 
listfile         Name of listfile that contains the fit information. Default is '' (no file). 
append           Append to existing table? false 
refspwmap        List of alternate spw for referencing -1 
incremental      create a incremental caltable false 

--------------------------------------------------------------------------------

Definition at line 372 of file calibrater.py.

def __casac__.calibrater.calibrater.initcalset (   self,
  calset = 0 
)
initcalset(self, calset=0) -> bool

Summary
Re-initialize the calibration scratch columns.

Input Parameters:
calset           if it set to 1 the model saved in the header is removed 0 

--------------------------------------------------------------------------------

Definition at line 303 of file calibrater.py.

def __casac__.calibrater.calibrater.linpolcor (   self,
  args,
  kwargs 
)
linpolcor(self, tablein=string(""), tableout=string(""), fields=std::vector< string >(1, "")) -> bool

Summary
Correct the gain table for linear polarization of the calibrator

Input Parameters:
tablein          Input calibration table name 
tableout         Output calibration table name 
fields           Calibrator field names 

--------------------------------------------------------------------------------

Definition at line 513 of file calibrater.py.

def __casac__.calibrater.calibrater.listcal (   self,
  args,
  kwargs 
)
listcal(self, caltable, field=initialize_variant(""), antenna=initialize_variant(""), spw=initialize_variant(""), 
    listfile=string(""), pagerows=50) -> bool

Summary
 List the contents of a calibration table
   

Input Parameters:
caltable         Calibration table to list 
field            Field names or indices to list: ''==>all 
antenna          Antenna/Baseline to list: ''==>all 
spw              Spectral windows and channels: ''==>all, spw='10:8~20' 
listfile         Send output to file: ''==>send to terminal) 
pagerows         Rows per page 50 

--------------------------------------------------------------------------------

Definition at line 474 of file calibrater.py.

def __casac__.calibrater.calibrater.modelfit (   self,
  args,
  kwargs 
)
modelfit(self, vary, niter=0, compshape=string("P"), par=initialize_vector(3,(double)1.0, (double)0.0, (double)0.0), 
    file=string("")) -> std::vector< double >

Summary
 Model fitting

Input Parameters:
vary             If specified where T, let this parameter (in par) vary in fit 
niter            Number of non-linear fitting iterations 0 
compshape        Component shape, P=point G=gaussian P 
par              Initial guess for fit parameters (default is for 'P)'I flux, rel RA, rel Dec, 1,0, 0.0, 0.0 are defaults 1.0 0.0 0.0 
file             If specified, output componentslist file name, if empty don't write componentslist file 

--------------------------------------------------------------------------------

Definition at line 555 of file calibrater.py.

def __casac__.calibrater.calibrater.open (   self,
  args,
  kwargs 
)
open(self, filename, compress=False, addcorr=True, addmodel=True) -> bool

Summary
Attach MeasurementSet to the calibrater tool

Input Parameters:
filename         MeasurementSet file name. No default 
compress         Compress calibration columns? false 
addcorr          Add scratch columns? true 
addmodel         Add MODEL_DATA column along with CORRECTED_DATA ? true 

--------------------------------------------------------------------------------

Definition at line 84 of file calibrater.py.

def __casac__.calibrater.calibrater.plotcal (   self,
  args,
  kwargs 
)
plotcal(self, antennas, fields, spwids, plottype=string("AMP"), tablename=string(""), polarization=1, 
    multiplot=False, nx=1, ny=1, psfile=string("")) -> bool

Summary
Plot a calibration table

Input Parameters:
antennas         Antennas to plot. Default is none. 
fields           Fields to plot. Default is none. 
spwids           Spectral windows id.'s to plot. Default is none. 
plottype         Plot type 1/AMP PHASE RLPHASE XYPHASE RI DAMP DPHASE DRI FIT FITWGT TOTALFIT AMP 
tablename        Calibration table name 
polarization     Polarization to plot 1 
multiplot        Turn on separate antenna plots false 
nx               If multiplot=T, number of plots on horizontal axis 1 
ny               If multiplot=T, number of plots on vertical axis 1 
psfile           Name of output PostScript file to write plot to. Default is to send plot to the screen. 

--------------------------------------------------------------------------------

Definition at line 530 of file calibrater.py.

def __casac__.calibrater.calibrater.posangcal (   self,
  args,
  kwargs 
)
posangcal(self, posangcor, tablein, tableout=string("")) -> bool

Summary
Apply position angle calibration to an existing cal table

Input Parameters:
posangcor        Position angle corrections (degrees) 
tablein          Input calibration table name 
tableout         Output calibration table name. Default is input table name. 

--------------------------------------------------------------------------------

Definition at line 496 of file calibrater.py.

def __casac__.calibrater.calibrater.reset (   self,
  apply = True,
  solve = True 
)
reset(self, apply=True, solve=True) -> bool

Summary
Reset the selected apply and/or solve components

Input Parameters:
apply            If true, unset all apply settings true 
solve            If true, unset all solve settings true 

--------------------------------------------------------------------------------

Definition at line 287 of file calibrater.py.

def __casac__.calibrater.calibrater.selectvis (   self,
  args,
  kwargs 
)
selectvis(self, time=initialize_variant(""), spw=initialize_variant(""), scan=initialize_variant(""), 
    field=initialize_variant(""), intent=initialize_variant(""), observation=initialize_variant(""), 
    baseline=initialize_variant(""), uvrange=initialize_variant(""), 
    chanmode=string("none"), nchan=1, start=0, step=1, mstart=Quantity(std::vector<double>(1, 0.0),"km/s"), 
    mstep=Quantity(std::vector<double>(1, 0.0),"km/s"), 
    msselect=string("")) -> bool

Summary
Set the data selection for subsequent processing

Input Parameters:
time             Select on time 
spw              Select on spectral window 
scan             Select on scan 
field            Select on field 
intent           Select on intent or state 
observation      Select by observation ID(s) 
baseline         Select on antennas/baselines 
uvrange          Select by uvrange 
chanmode         Type of data selection: channel or velocity channel velocity none 
nchan            Number of channels to select (mode='channel') 1 
start            Start channel (0-relative) (mode='channel') 0 
step             Step in channel number (mode='channel') 1 
mstart           Start velocity (e.g. '20Km/s') 0.0 
mstep            Step in velocity (e.g. '100m/s') 0.0 
msselect         TAQL selection string. Default (empty) is no specific selection. 

--------------------------------------------------------------------------------

Definition at line 102 of file calibrater.py.

def __casac__.calibrater.calibrater.setapply (   self,
  args,
  kwargs 
)
setapply(self, type=string(""), t=0.0, table=string(""), field=initialize_variant(""), interp=string("linear"), 
    select=string(""), calwt=False, spwmap=initialize_vector(1, (int)-1), 
    opacity=initialize_vector(1, (double)0.0)) -> bool

Summary
Arrange to apply calibration

Input Parameters:
type             Component type B BPOLY G GSPLINE D P T TOPAC GAINCURVE 
t                Interpolation interval (seconds) 0.0 
table            Calibration table name 
field            Select on field 
interp           Interpolation type (in time) aipslin nearest linear 
select           TAQL selection string. Default is no selection. 
calwt            Calibrate weights? false 
spwmap           Spectral windows to apply -1 
opacity          Array-wide zenith opacity per antenna (for type='TOPAC') 0.0 

--------------------------------------------------------------------------------

Definition at line 166 of file calibrater.py.

def __casac__.calibrater.calibrater.setmodel (   self,
  args,
  kwargs 
)
setmodel(self, modelimage) -> bool

Summary
Set the sky model used to compute the model visibilities

Input Parameters:
modelimage       Name of the model image. 

--------------------------------------------------------------------------------

Definition at line 136 of file calibrater.py.

def __casac__.calibrater.calibrater.setptmodel (   self,
  args,
  kwargs 
)
setptmodel(self, stokes=initialize_vector(4,(double)0.0, (double)0.0, (double)0.0, (double)0.0)) -> bool

Summary
Set the point source model Stokes parameters to be used to compute the model visibilities

Input Parameters:
stokes           Vector of Stokes parameters. 0.0 0.0 0.0 0.0 

--------------------------------------------------------------------------------

Definition at line 151 of file calibrater.py.

def __casac__.calibrater.calibrater.setsolve (   self,
  args,
  kwargs 
)
setsolve(self, type=string("MF"), t=initialize_variant(""), table=string(""), append=False, preavg=-1.0, 
    phaseonly=False, apmode=string("AP"), refant=initialize_variant(""), 
    minblperant=4, solnorm=False, minsnr=0.0, combine=string(""), fillgaps=0, 
    cfcache=string(""), painc=360.0, fitorder=0) -> bool

Summary
Arrange to solve for calibration

Input Parameters:
type             Component type G T B D M MF 
t                Solution interval (units optional) 
table            Output calibration table name 
append           Append to existing table? false 
preavg           Pre-averaging interval (in sec) -1.0 
phaseonly        Solve only for phase? false 
apmode           Solve for 'AP', 'A' (amp-only) or 'P' (phase-only) AP 
refant           Reference antenna. Default is none. 
minblperant      Minimum number of baselines per ant for solving 4 
solnorm          Normalize solution after solve false 
minsnr           SNR threshold for accepting solutions 0.0 
combine          Data axes on which to combine solving (scan, spw, and/or field) 
fillgaps         0 
cfcache          Name of the directory to be used for convolution function disk cache. This is used when type=EP. 
painc            Parallactic Angle increment used to trigger computation of a new convolution function. This is used when type=EP. Default value implies that only one convolution function will be computed for the entire range of observation. 360.0 
fitorder         Order of the polynomial fit, used when type='A'. 0 

--------------------------------------------------------------------------------

Definition at line 191 of file calibrater.py.

def __casac__.calibrater.calibrater.setsolvebandpoly (   self,
  args,
  kwargs 
)
setsolvebandpoly(self, table=string(""), append=False, t=initialize_variant(""), combine=string(""), degamp=3, 
    degphase=3, visnorm=False, solnorm=True, maskcenter=0, maskedge=5.0, 
    refant=initialize_variant("")) -> bool

Summary
Specialization of setsolve for
polynomial B (bandpass) solving

Input Parameters:
table            Output calibration table name 
append           Append to existing table? false 
t                Solution interval (units optional) 
combine          Data axes on which to combine solving (scan, spw, and/or field) 
degamp           Polynomial degree for amplitude solution 3 
degphase         Polynomial degree for phase solution 3 
visnorm          Normalize data prior to solution false 
solnorm          Normalize result? true 
maskcenter       Number of channels to avoid in center of each band 0 
maskedge         Fraction of channels to avoid at each band edge (in \%) 5.0 
refant           Reference antenna 

--------------------------------------------------------------------------------

Definition at line 248 of file calibrater.py.

def __casac__.calibrater.calibrater.setsolvegainspline (   self,
  args,
  kwargs 
)
setsolvegainspline(self, table=string(""), append=False, mode=string("PHAS"), splinetime=10800, preavg=0.0, 
    npointaver=10, phasewrap=250, refant=initialize_variant("")) -> bool

Summary
Specialization of setsolve for
cubic spline G (time-dependent gain) solving

Input Parameters:
table            Output calibration table name 
append           Append to existing table? false 
mode             Phase or Amplitude mode? AMP PHASAMP PHAS 
splinetime       Spline timescale (sec) 10800 
preavg           Pre-averaging interval (in sec) 0.0 
npointaver       10 
phasewrap        250 
refant           Reference antenna. Default is none. 

--------------------------------------------------------------------------------

Definition at line 224 of file calibrater.py.

def __casac__.calibrater.calibrater.smooth (   self,
  args,
  kwargs 
)
smooth(self, tablein, tableout, field=initialize_variant(""), smoothtype=string("median"), smoothtime=60.0) -> bool

Summary
Produce a smoothed calibration table

Input Parameters:
tablein          Input calibration table 
tableout         Output calibration table 
field            Limit smoothing to these fields (default is all fields) 
smoothtype       The smoothing type: 'mean' or 'median' mean median 
smoothtime       Smoothing filter time constant (sec) 60.0 

--------------------------------------------------------------------------------

Definition at line 455 of file calibrater.py.

solve(self) -> bool

Summary
Solve for the selected calibration components
--------------------------------------------------------------------------------

Definition at line 335 of file calibrater.py.

def __casac__.calibrater.calibrater.specifycal (   self,
  args,
  kwargs 
)
specifycal(self, caltable=string(""), time=string(""), spw=string(""), antenna=string(""), pol=string(""), 
    caltype=string(""), parameter=initialize_vector(1, (double)1.0)) -> bool

Summary
Externally specify calibration
of various types

Input Parameters:
caltable         The calibration table name 
time             Calibration timestamp 
spw              Calibration spw(s) 
antenna          Calibration antenna(s) 
pol              Calibration polarization 
caltype          Calibration timestamp 
parameter        Calibration parameters 1.0 

--------------------------------------------------------------------------------

Definition at line 432 of file calibrater.py.

state(self) -> bool

Summary
Request the apply/solve state of the calibrater tool
--------------------------------------------------------------------------------

Definition at line 276 of file calibrater.py.


Member Data Documentation

Definition at line 83 of file calibrater.py.

Definition at line 75 of file calibrater.py.

Definition at line 76 of file calibrater.py.

Definition at line 73 of file calibrater.py.

Definition at line 82 of file calibrater.py.

Definition at line 74 of file calibrater.py.

Definition at line 72 of file calibrater.py.

Definition at line 81 of file calibrater.py.


The documentation for this class was generated from the following file: