Public Member Functions
def	__init__
def	result
def	__call__
def	paramgui
def	defaults
def	check_params
def	description
def	itsdefault
Public Attributes
	parameters
Static Public Attributes
	rkey
	Handle globals or user over-ride of arguments.
	i_am_a_casapy_task
list	retval
	This function sets the default values but also will return the list of parameters or the default value of a given parameter.
string	valornotval
tuple	retval
Private Attributes
	__bases__
	__doc__
	__globals__
Static Private Attributes
string	__name__
dictionary	__async__

Detailed Description

Definition at line 18 of file polcal_cli.py.

Constructor & Destructor Documentation

def polcal_cli.polcal_cli_.__init__ ( self )

Definition at line 26 of file polcal_cli.py.

Member Function Documentation

def polcal_cli.polcal_cli_.__call__	(	self,
		vis = `None`,
		caltable = `None`,
		field = `None`,
		spw = `None`,
		intent = `None`,
		selectdata = `None`,
		timerange = `None`,
		uvrange = `None`,
		antenna = `None`,
		scan = `None`,
		observation = `None`,
		msselect = `None`,
		solint = `None`,
		combine = `None`,
		preavg = `None`,
		refant = `None`,
		minblperant = `None`,
		minsnr = `None`,
		poltype = `None`,
		smodel = `None`,
		append = `None`,
		gaintable = `None`,
		gainfield = `None`,
		interp = `None`,
		spwmap = `None`,
		gaincurve = `None`,
		opacity = `None`,
		async = `None`
	)

Determine instrumental polarization calibrations

      The instrumental polarization factors (D-terms), the calibrator polarization,
      and the R-L polarization angle can be determined using polcal.  The solutions
      can be obtained for each antenna/spwid and even individual channels, if desired.
      Previous calibrations of the total intensity data should be applied on the fly
      when running polcal, since polcal uses the 'data' column, not the 'corrected'
      column.

      After calibrating the gain, bandpass, and (if relevant, for channelized data)
      cross-hand delay, the simplest way to calibrate the polarization data is:

a) Run polcal with poltype = 'D+QU' on the main 'calibrator' source.  The D terms
   and polarization (QU) of the calibrator will be determined.  Relatively good
   parallactic angle coverage is needed.

b) If there is little parallactic angle coverage, place the known polarization of
   the main calibrator (or 0) using setjy with the appropriate fluxdensity.  Then
   run polcal with poltype = 'D'.  Run plotcal with xaxis = 'real'; yaxis ='imag'
   to view solutions.  It is best to use an unpolarized calibrator in this 
   instance; large systematic offsets from zero indicate significant source  
   polarization that will bias the polarization calibration.  A mechanism 
   to constrain this bias will be made available in the near future. 

c) To determine R-L polarization angle, use setjy to put the fluxdensity of the
   polarization calibrator [I,Q,U,0.0] in the model column.  For resolved sources
   put in values associated with an appropriate u-v range.  Polarized models are
   not yet available for the major polarization standard sources, so very
   resolved polarized sources should not be used.

d) Run polcal with poltype = 'X' and include polarization standard.  Make sure to
   include all previous calibrations, especially the D results.  Run plotxy with
   correlation = 'RL LR' and make sure polarization angles are as expected.

e) Run applycal with all calibration table, include the D and X tables.  Make sure
   that parang = T

 NOTE: For very high dynamic range, use poltype='Df' or 'Df+QU' to determine 
       D terms for each channel.  Similarly, poltype='Xf' can
       be used to determine a channel-dependent R-L phase
       "bandpass".
 NOTE: Rather than use setjy in b and c above, the new smodel
       parameter may be used in polcal to specify a simple
       point source Stokes model.  

      Keyword arguments:
      vis -- Name of input visibility file
      default: none; example: vis='ngc5921.ms'
      caltable -- Name of output gain calibration table
      default: none; example: caltable='ngc5921.dcal'

      --- Data Selection (see help par.selectdata for more detailed information)

      field -- Select field using field id(s) or field name(s).
 [run listobs to obtain the list id's or names]
      default: ''=all fields.
  Most likely, the main calibrator source should be picked.
      If field string is a non-negative integer, it is assumed a field index
otherwise, it is assumed a field name
      field='0~2'; field ids 0,1,2
      field='0,4,5~7'; field ids 0,4,5,6,7
      field='3C286,3C295'; field named 3C286 adn 3C295
      field = '3,4C*'; field id 3, all names starting with 4C
      spw -- Select spectral window/channels 
       type 'help par.selection' for more examples.
     spw='0~2,4'; spectral windows 0,1,2,4 (all channels)
     spw='<2';  spectral windows less than 2 (i.e. 0,1)
     spw='0:5~61'; spw 0, channels 5 to 61, INCLUSIVE
     spw='*:5~61'; all spw with channels 5 to 62
     spw='0,10,3:3~45'; spw 0,10 all channels, spw 3, channels 3 to 45.
     spw='0~2:2~6'; spw 0,1,2 with channels 2 through 6 in each.
     spw='0:0~10;15~60'; spectral window 0 with channels 0-10,15-60
       NOTE ';' to separate channel selections
     spw='0:0~10^2,1:20~30^5'; spw 0, channels 0,2,4,6,8,10,
   spw 1, channels 20,25,30
      intent -- Select observing intent
default: ''  (no selection by intent)
intent='*BANDPASS*'  (selects data labelled with
                      BANDPASS intent)
      selectdata -- Other data selection parameters
      default: True
      timerange  -- Select data based on time range:
      default = '' (all); examples,
      timerange = 'YYYY/MM/DD/hh:mm:ss~YYYY/MM/DD/hh:mm:ss'
      Note: if YYYY/MM/DD is missing dat defaults to first day in data set
      timerange='09:14:0~09:54:0' picks 40 min on first day
      timerange= '25:00:00~27:30:00' picks 1 hr to 3 hr 30min on next day
      timerange='09:44:00' data within one integration of time
      timerange='>10:24:00' data after this time
      uvrange -- Select data within uvrange (default units meters)
      default: '' (all); example:
      uvrange='0~1000'; uvrange from 0-1000 kilo-lamgda
      uvrange='>4';uvranges greater than 4 kilo-lambda
      antenna -- Select data based on antenna/baseline
      default: '' (all)
      If antenna string is a non-negative integer, it is assumed an antenna index
otherwise, it is assumed as an antenna name
      antenna='5&6'; baseline between antenna index 5 and index 6.
      antenna='VA05&VA06'; baseline between VLA antenna 5 and 6.
      antenna='5&6;7&8'; baseline 5-6 and 7-8
      antenna='5'; all baselines with antenna index 5
      antenna='05'; all baselines with antenna name 05, i.e. VLA ant 5
      antenna='5,6,10'; all baselines with antennas 5, 6 and 10
      scan -- Scan number range
      observation -- Observation ID(s).
     default: '' = all
     example: '0~2,4'
      msselect -- Optional complex data selection (ignore for now)

      --- Solution parameters
      poltype -- Type of instrumental polarization solution
      'D+QU' (or 'Df+QU')  solve also for apparent source polarization (channelized D)
 Need relatively good parallactic angle coverage for this
      'D' (or 'Df') solve only for instrumental polarization (channelized).  The
 I, Q, U flux density of the source can be placed in the model column using
 setjy.  Use for poor parallactic angle coverage.
      'X' (or 'Xf') = solve only for position angle correction (channelized).  
 The source must have its I, Q, U flux density in the model column 
 or specified in smodel.  If the source is resolved, use a limited 
 uvrange that is appropriate.
      'D+X' (or 'Df+X') = solve also for position angle offset (channelized D) as
 well as the D-term.  Not normally done.
      default: 'D+QU'
      The solution used the traditional linear approximation.  Non-linearized options
  will be avaible soon.
      smodel -- Point source Stokes parameters for source model (experimental)
      default: [] (use MODEL_DATA column)
      examples: [1,0,0,0] (I=1, unpolarized)
        [5.2,0.2,0.3,0.0] (I=5.2, Q=0.2, U=0.3, V=0.0)
      solint --  Solution interval (units optional) 
      default: 'inf' (~infinite, up to boundaries controlled by combine); 
      Options: 'inf' (~infinite), 'int' (per integration), any float
       or integer value with or without units
      examples: solint='1min'; solint='60s', solint=60 --> 1 minute
        solint='0s'; solint=0; solint='int' --> per integration
        solint-'-1s'; solint='inf' --> ~infinite, up to boundaries
        enforced by combine
      combine -- Data axes to combine for solving
      default: 'scan' --> solutions will break at field and spw boundaries,
        but may extend over multiple scans (per field and spw) up
        to solint.
      Options: '','scan','spw',field', or any comma-separated combination
      example: combine='scan,spw'  --> extend solutions over scan boundaries
       (up to the solint), and combine spws for solving
      preavg -- Pre-averaging interval (sec)
      default=300
      Interval to apply parallactic angle.
      refant -- Reference antenna name
      default: '' => refant = '0'
      example: refant='13' (antenna with index 13)
       refant='VA04' (VLA antenna #4)
       refant='EA02,EA23,EA13' (EVLA antenna EA02, use
                EA23 and EA13 as alternates if/when EA02
                drops out)
      Use 'go listobs' for antenna listing.
      USE SAME REFERENCE ANTENNA AS USED FOR I CALIBRATION.
      minblperant -- Minimum number of baselines required per antenna for each solve
   Antennas with fewer baaselines are excluded from solutions. Amplitude
   solutions with fewer than 4 baselines, and phase solutions with fewer 
   than 3 baselines are only trivially constrained, and are no better
   than baseline-based solutions.
   default: 4
   example: minblperant=10  => Antennas participating on 10 or more 
            baselines are included in the solve
      minsnr -- Reject solutions below this SNR
      default: 3.0
      append -- Append solutions to the (existing) table
      default: False; overwrite existing table or make new table

      --- Other calibrations to apply on the fly before determining gaincal solution

      gaintable -- Gain calibration table(s) to apply 
       default: '' (none);  BUT I CALIBRATION TABLES SHOULD GENERALLY BE INCLUDED
       examples: gaintable='ngc5921.gcal'
         gaintable=['ngc5921.ampcal','ngc5921.phcal']
      gainfield -- Select a subset of calibrators from gaintable(s)
       default:'' ==> all sources in table;
       'nearest' ==> nearest (on sky) available field in table
       otherwise, same syntax as field
       example: gainfield='0~3'
        gainfield=['0~3','4~6'] means use field 0 through 3
          from first gain file, field 4 through 6 for second.
      interp -- Interpolation type (in time[,freq]) to use for each gaintable.
When frequency interpolation is relevant (B, Df, Xf),
separate time-dependent and freq-dependent interp
types with a comma (freq _after_ the comma).                
Specifications for frequency are ignored when the
calibration table has no channel-dependence.
Time-dependent interp options ending in 'PD' enable a
"phase delay" correction per spw for non-channel-dependent
calibration types.
default: '' --> 'linear,linear' for all gaintable(s)
example: interp='nearest'   (in time, freq-dep will be
                             linear, if relevant)
         interp='linear,cubic'  (linear in time, cubic
                                 in freq)
         interp=',spline'  (spline in freq; linear in
                            time by default)
         interp=['nearest,spline','linear']  (for multiple gaintables)
Options: Time: 'nearest', 'linear'
         Freq: 'nearest', 'linear', 'cubic', 'spline'
      spwmap -- Spectral windows combinations to form for gaintable(s)
default: [] (apply solutions from each spw to that spw only)
Example:  spwmap=[0,0,1,1] means apply the caltable solutions
          from spw = 0 to the spw 0,1 and spw 1 to spw 2,3.
          spwmap=[[0,0,1,1],[0,1,0,1]]
      gaincurve -- Apply internal VLA antenna gain curve correction (True/False)
       default: False;
       Use gaincurve=True ONLY for VLA data
      opacity -- Opacity correction to apply (nepers), per spw
       default: [] (no opacity correction for any spw)
       examples:
   A global value for all spws:
     opacity=0.051
   Different values for spws 0,1,2:
     opacity=[0.051, 0.055, 0.057]
   (if more than 3 spws, spw 3 and higher will
    be assigned the last specified value, or 0.057)
       Typical VLA values are: 5 GHz - 0.013, 8 GHz - 0.013
       15 GHz - 0.016, 23 GHz - 0.051, 43 GHz - 0.07
      async --  Run asynchronously
       default = False; do not run asychronously

Definition at line 46 of file polcal_cli.py.

def polcal_cli.polcal_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 529 of file polcal_cli.py.

def polcal_cli.polcal_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 459 of file polcal_cli.py.

def polcal_cli.polcal_cli_.description	(	self,
		key = `'polcal'`,
		subkey = `None`
	)

Definition at line 560 of file polcal_cli.py.

def polcal_cli.polcal_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 600 of file polcal_cli.py.

Referenced by rmtables_cli.rmtables_cli_.defaults(), uvsub_cli.uvsub_cli_.defaults(), uvcontsub2_cli.uvcontsub2_cli_.defaults(), smoothcal_cli.smoothcal_cli_.defaults(), tclean_cli.tclean_cli_.defaults(), splattotable_cli.splattotable_cli_.defaults(), sdflagmanager_cli.sdflagmanager_cli_.defaults(), testconcat_cli.testconcat_cli_.defaults(), sdlist_cli.sdlist_cli_.defaults(), viewer_cli.viewer_cli_.defaults(), sdscale_cli.sdscale_cli_.defaults(), slsearch_cli.slsearch_cli_.defaults(), predictcomp_cli.predictcomp_cli_.defaults(), uvcontsub_cli.uvcontsub_cli_.defaults(), wvrgcal_cli.wvrgcal_cli_.defaults(), ssoflux_cli.ssoflux_cli_.defaults(), vishead_cli.vishead_cli_.defaults(), uvcontsub3_cli.uvcontsub3_cli_.defaults(), sdimprocess_cli.sdimprocess_cli_.defaults(), virtualconcat_cli.virtualconcat_cli_.defaults(), sdsmooth_cli.sdsmooth_cli_.defaults(), visstat_cli.visstat_cli_.defaults(), widebandpbcor_cli.widebandpbcor_cli_.defaults(), sdcoadd_cli.sdcoadd_cli_.defaults(), uvmodelfit_cli.uvmodelfit_cli_.defaults(), sdsave_cli.sdsave_cli_.defaults(), simanalyze_cli.simanalyze_cli_.defaults(), sdmath_cli.sdmath_cli_.defaults(), sdgrid_cli.sdgrid_cli_.defaults(), sdtpimaging_cli.sdtpimaging_cli_.defaults(), sdstat_cli.sdstat_cli_.defaults(), split_cli.split_cli_.defaults(), sdimaging_cli.sdimaging_cli_.defaults(), statwt_cli.statwt_cli_.defaults(), sdflag_cli.sdflag_cli_.defaults(), simalma_cli.simalma_cli_.defaults(), sdfit_cli.sdfit_cli_.defaults(), sdcal_cli.sdcal_cli_.defaults(), simobserve_cli.simobserve_cli_.defaults(), polcal_cli.polcal_cli_.defaults(), sdbaseline_cli.sdbaseline_cli_.defaults(), setjy_cli.setjy_cli_.defaults(), widefield_cli.widefield_cli_.defaults(), specfit_cli.specfit_cli_.defaults(), and sdreduce_cli.sdreduce_cli_.defaults().

def polcal_cli.polcal_cli_.paramgui	(	self,
		useGlobals = `True`,
		ipython_globals = `None`
	)

Opens a parameter GUI for this task.  If useGlobals is true, then any relevant global parameter settings are used.

Definition at line 435 of file polcal_cli.py.

def polcal_cli.polcal_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file polcal_cli.py.

References accum_cli.accum_cli_.__async__, polcal_cli.polcal_cli_.__async__, plotxy_cli.plotxy_cli_.__async__, plotweather_cli.plotweather_cli_.__async__, plotuv_cli.plotuv_cli_.__async__, plotms_cli.plotms_cli_.__async__, plotcal_cli.plotcal_cli_.__async__, plotants_cli.plotants_cli_.__async__, peel_cli.peel_cli_.__async__, pclean_cli.pclean_cli_.__async__, partition_cli.partition_cli_.__async__, msview_cli.msview_cli_.__async__, msmoments_cli.msmoments_cli_.__async__, mosaic_cli.mosaic_cli_.__async__, makemask_cli.makemask_cli_.__async__, listvis_cli.listvis_cli_.__async__, listsdm_cli.listsdm_cli_.__async__, listpartition_cli.listpartition_cli_.__async__, listobs_cli.listobs_cli_.__async__, listhistory_cli.listhistory_cli_.__async__, listfits_cli.listfits_cli_.__async__, listcal_cli.listcal_cli_.__async__, imview_cli.imview_cli_.__async__, imval_cli.imval_cli_.__async__, imtrans_cli.imtrans_cli_.__async__, imsubimage_cli.imsubimage_cli_.__async__, imstat_cli.imstat_cli_.__async__, imsmooth_cli.imsmooth_cli_.__async__, imregrid_cli.imregrid_cli_.__async__, imreframe_cli.imreframe_cli_.__async__, importvla_cli.importvla_cli_.__async__, importuvfits_cli.importuvfits_cli_.__async__, importgmrt_cli.importgmrt_cli_.__async__, importfitsidi_cli.importfitsidi_cli_.__async__, importfits_cli.importfits_cli_.__async__, importevla_cli.importevla_cli_.__async__, importasdm_cli.importasdm_cli_.__async__, impbcor_cli.impbcor_cli_.__async__, immoments_cli.immoments_cli_.__async__, immath_cli.immath_cli_.__async__, imhead_cli.imhead_cli_.__async__, imfit_cli.imfit_cli_.__async__, imcontsub_cli.imcontsub_cli_.__async__, imcollapse_cli.imcollapse_cli_.__async__, hanningsmooth_cli.hanningsmooth_cli_.__async__, gencal_cli.gencal_cli_.__async__, gaincal_cli.gaincal_cli_.__async__, ft_cli.ft_cli_.__async__, fluxscale_cli.fluxscale_cli_.__async__, flagmanager_cli.flagmanager_cli_.__async__, flagdata_cli.flagdata_cli_.__async__, flagcmd_cli.flagcmd_cli_.__async__, fixvis_cli.fixvis_cli_.__async__, fixplanets_cli.fixplanets_cli_.__async__, find_cli.find_cli_.__async__, feather_cli.feather_cli_.__async__, exportuvfits_cli.exportuvfits_cli_.__async__, exportfits_cli.exportfits_cli_.__async__, exportasdm_cli.exportasdm_cli_.__async__, delmod_cli.delmod_cli_.__async__, deconvolve_cli.deconvolve_cli_.__async__, cvel_cli.cvel_cli_.__async__, csvclean_cli.csvclean_cli_.__async__, conjugatevis_cli.conjugatevis_cli_.__async__, concat_cli.concat_cli_.__async__, clearstat_cli.clearstat_cli_.__async__, clearplot_cli.clearplot_cli_.__async__, clearcal_cli.clearcal_cli_.__async__, clean_cli.clean_cli_.__async__, caltabconvert_cli.caltabconvert_cli_.__async__, calstat_cli.calstat_cli_.__async__, browsetable_cli.browsetable_cli_.__async__, boxit_cli.boxit_cli_.__async__, blcal_cli.blcal_cli_.__async__, bandpass_cli.bandpass_cli_.__async__, autoclean_cli.autoclean_cli_.__async__, asdmsummary_cli.asdmsummary_cli_.__async__, and applycal_cli.applycal_cli_.__async__.

Member Data Documentation

dictionary polcal_cli.polcal_cli_.__async__ [static, private]

Definition at line 20 of file polcal_cli.py.

Referenced by polcal_cli.polcal_cli_.result(), wvrgcal_cli.wvrgcal_cli_.result(), widefield_cli.widefield_cli_.result(), widebandpbcor_cli.widebandpbcor_cli_.result(), visstat_cli.visstat_cli_.result(), vishead_cli.vishead_cli_.result(), virtualconcat_cli.virtualconcat_cli_.result(), viewer_cli.viewer_cli_.result(), uvsub_cli.uvsub_cli_.result(), uvmodelfit_cli.uvmodelfit_cli_.result(), uvcontsub_cli.uvcontsub_cli_.result(), uvcontsub3_cli.uvcontsub3_cli_.result(), uvcontsub2_cli.uvcontsub2_cli_.result(), testconcat_cli.testconcat_cli_.result(), tclean_cli.tclean_cli_.result(), statwt_cli.statwt_cli_.result(), ssoflux_cli.ssoflux_cli_.result(), split_cli.split_cli_.result(), splattotable_cli.splattotable_cli_.result(), specfit_cli.specfit_cli_.result(), smoothcal_cli.smoothcal_cli_.result(), slsearch_cli.slsearch_cli_.result(), simobserve_cli.simobserve_cli_.result(), simanalyze_cli.simanalyze_cli_.result(), simalma_cli.simalma_cli_.result(), setjy_cli.setjy_cli_.result(), sdtpimaging_cli.sdtpimaging_cli_.result(), sdstat_cli.sdstat_cli_.result(), sdsmooth_cli.sdsmooth_cli_.result(), sdscale_cli.sdscale_cli_.result(), sdsave_cli.sdsave_cli_.result(), sdreduce_cli.sdreduce_cli_.result(), sdplot_cli.sdplot_cli_.result(), sdmath_cli.sdmath_cli_.result(), sdlist_cli.sdlist_cli_.result(), sdimprocess_cli.sdimprocess_cli_.result(), sdimaging_cli.sdimaging_cli_.result(), sdgrid_cli.sdgrid_cli_.result(), sdflagmanager_cli.sdflagmanager_cli_.result(), sdflag_cli.sdflag_cli_.result(), sdfit_cli.sdfit_cli_.result(), sdcoadd_cli.sdcoadd_cli_.result(), sdcal_cli.sdcal_cli_.result(), sdbaseline_cli.sdbaseline_cli_.result(), rmtables_cli.rmtables_cli_.result(), and predictcomp_cli.predictcomp_cli_.result().

polcal_cli.polcal_cli_.__bases__ [private]

Definition at line 27 of file polcal_cli.py.

polcal_cli.polcal_cli_.__doc__ [private]

Definition at line 28 of file polcal_cli.py.

polcal_cli.polcal_cli_.__globals__ [private]

Definition at line 272 of file polcal_cli.py.

string polcal_cli.polcal_cli_.__name__ [static, private]

Definition at line 19 of file polcal_cli.py.

polcal_cli.polcal_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file polcal_cli.py.

polcal_cli.polcal_cli_.parameters

Definition at line 30 of file polcal_cli.py.

tuple polcal_cli.polcal_cli_.retval [static]

This function sets the default values but also will return the list of parameters or the default value of a given parameter.

Definition at line 508 of file polcal_cli.py.

tuple polcal_cli.polcal_cli_.retval [static]

Definition at line 521 of file polcal_cli.py.

polcal_cli.polcal_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file polcal_cli.py.

string polcal_cli.polcal_cli_.valornotval [static]

Definition at line 511 of file polcal_cli.py.

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

polcal_cli.py

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation