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 bandpass_cli.py.

Constructor & Destructor Documentation

def bandpass_cli.bandpass_cli_.__init__ ( self )

Definition at line 26 of file bandpass_cli.py.

Member Function Documentation

def bandpass_cli.bandpass_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`,
		refant = `None`,
		minblperant = `None`,
		minsnr = `None`,
		solnorm = `None`,
		bandtype = `None`,
		smodel = `None`,
		append = `None`,
		fillgaps = `None`,
		degamp = `None`,
		degphase = `None`,
		visnorm = `None`,
		maskcenter = `None`,
		maskedge = `None`,
		gaintable = `None`,
		gainfield = `None`,
		interp = `None`,
		spwmap = `None`,
		gaincurve = `None`,
		opacity = `None`,
		parang = `None`,
		async = `None`
	)

Calculates a bandpass calibration solution

       Determines the amplitude and phase as a function of frequency for
       each spectral window containing more than one channel.  Strong sources
       (or many observations of moderately strong sources) are needed to obtain
       accurate bandpass functions.  The two solution choices are: Individual
       antenna/based channel solutions 'B'; and a polynomial fit over the channels
       'BPOLY'.  The 'B' solutions can determined at any specified time interval, and
       is recommended if each channel has good signal-to-noise.  Other, 'BPOLY' is
       recommended.

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

      --- 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
      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
      default: ''=all spectral windows and channels
      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
      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,1:20~30,2:1;2;3'; spw 0, channels 0-10,
       spw 1, channels 20-30, and spw 2, channels, 1,2 and 3
      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 meters)
      default: '' (all); example:
      uvrange='0~1000kl'; uvrange from 0-1000 kilo-lamgda
      uvrange='>4kl';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 5
      antenna='5,6,10'; all baselines with antennas 5, 6 and 10
       scan -- Select data based on scan number - New, under developement
       default: '' (all); example: scan='>3'
       observation -- Observation ID(s).
      default: '' = all
      example: '0~2,4'
       msselect -- Optional complex data selection (ignore for now)

       --- Solution parameters
       solint --  Solution interval in time (units optional), and (optionally)
   in frequency.  Frequency pre-averaging can be
   specified after a comma in units of channels or Hz.
   If nothing is specified for frequency, no freq pre-averaging 
   will be done.
       default: 'inf' (~infinite, up to boundaries controlled by combine,
       with no pre-averaging in frequency)
      Options for time: 'inf' (~infinite), 'int' (per integration), any float
       or integer value with or without units
      Options for freq: an integer with 'ch' suffix will enforce
                pre-averaging by the specified number
                of channels.
                a numeric value suffixed with frequency
                units (e.g., 'Hz','kHz','MHz') will enforce
                pre-averaging by an integral number of 
                channels amounting to no more than the
                specified bandwidth
      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
        solint='inf,8Mhz' --> ~infinite in time, with 
                                  8MHz pre-average in freq
        solint='int,32ch' --> per-integration in time,
                                  with 32-channel pre-average
                                  in freq
       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
       refant -- Reference antenna name(s); a prioritized list may be specified
       default: '' (no reference antenna)
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
       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 (only applies for bandtype = B)
       default: 3.0
       solnorm -- Normalize bandpass amplitudes and phase for each
       spw, pol, ant, and timestamp
       default: False (no normalization)
       bandtype -- Type of bandpass solution (B or BPOLY)
       default: 'B'; example: bandtype='BPOLY'
       'B' does a channel by channel solution for each
   specified spw.
       'BPOLY' is somewhat experimental. It will fit an
   nth order polynomial for the amplitude and phase
   as a function of frequency. Only one fit is made
   for all specified spw, and edge channels should be
   omitted.
Use taskname=plotcal in order to compare the results from
   B and BPOLY.
       fillgaps -- Fill flagged solution channels by interpolation
       default: 0 (don't interpolate)
       example: fillgaps=3 (interpolate gaps 3 channels wide and narrower)
       degamp -- Polynomial degree for BPOLY amplitude solution
       default: 3; example: degamp=2
       degphase -- Polynomial degree for BPOLY phase solution
       default: 3; example: degphase=2
       visnorm -- Normalize data prior to BPOLY solution
       default: False; example: visnorm=True
       maskcenter -- Number of channels to avoid in center of each band
       default: 0; example: maskcenter=5 (BPOLY only)
       maskedge -- Fraction of channels to avoid at each band edge (in %)
       default: 5; example: maskedge=3 (BPOLY only)
       append -- Append solutions to the (existing) table
       default: False; example: append=True

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

      gaintable -- Gain calibration table(s) to apply 
       default: '' (none);
       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']
      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
      parang -- If True, apply the parallactic angle correction (required
       for polarization calibration)
       default: False

Definition at line 46 of file bandpass_cli.py.

def bandpass_cli.bandpass_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 534 of file bandpass_cli.py.

References asdmsummary_cli.asdmsummary_cli_.__globals__, accum_cli.accum_cli_.__globals__, applycal_cli.applycal_cli_.__globals__, bandpass_cli.bandpass_cli_.__globals__, and autoclean_cli.autoclean_cli_.__globals__.

def bandpass_cli.bandpass_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 460 of file bandpass_cli.py.

References asdmsummary_cli.asdmsummary_cli_.__globals__, accum_cli.accum_cli_.__globals__, applycal_cli.applycal_cli_.__globals__, bandpass_cli.bandpass_cli_.__globals__, autoclean_cli.autoclean_cli_.__globals__, asdmsummary_cli.asdmsummary_cli_.itsdefault(), accum_cli.accum_cli_.itsdefault(), applycal_cli.applycal_cli_.itsdefault(), bandpass_cli.bandpass_cli_.itsdefault(), and autoclean_cli.autoclean_cli_.itsdefault().

def bandpass_cli.bandpass_cli_.description	(	self,
		key = `'bandpass'`,
		subkey = `None`
	)

Definition at line 565 of file bandpass_cli.py.

def bandpass_cli.bandpass_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 612 of file bandpass_cli.py.

References accum_cli.accum_cli_.parameters, bandpass_cli.bandpass_cli_.parameters, autoclean_cli.autoclean_cli_.parameters, asdmsummary_cli.asdmsummary_cli_.parameters, and applycal_cli.applycal_cli_.parameters.

def bandpass_cli.bandpass_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 436 of file bandpass_cli.py.

References asdmsummary_cli.asdmsummary_cli_.__globals__, accum_cli.accum_cli_.__globals__, applycal_cli.applycal_cli_.__globals__, bandpass_cli.bandpass_cli_.__globals__, and autoclean_cli.autoclean_cli_.__globals__.

def bandpass_cli.bandpass_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file bandpass_cli.py.

References accum_cli.accum_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 bandpass_cli.bandpass_cli_.__async__ [static, private]

Definition at line 20 of file bandpass_cli.py.

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

bandpass_cli.bandpass_cli_.__bases__ [private]

Definition at line 27 of file bandpass_cli.py.

bandpass_cli.bandpass_cli_.__doc__ [private]

Definition at line 28 of file bandpass_cli.py.

bandpass_cli.bandpass_cli_.__globals__ [private]

Definition at line 259 of file bandpass_cli.py.

string bandpass_cli.bandpass_cli_.__name__ [static, private]

Definition at line 19 of file bandpass_cli.py.

bandpass_cli.bandpass_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file bandpass_cli.py.

bandpass_cli.bandpass_cli_.parameters

Definition at line 30 of file bandpass_cli.py.

tuple bandpass_cli.bandpass_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 513 of file bandpass_cli.py.

tuple bandpass_cli.bandpass_cli_.retval [static]

Definition at line 526 of file bandpass_cli.py.

bandpass_cli.bandpass_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file bandpass_cli.py.

string bandpass_cli.bandpass_cli_.valornotval [static]

Definition at line 516 of file bandpass_cli.py.

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

bandpass_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