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

Constructor & Destructor Documentation

def cvel_cli.cvel_cli_.__init__ ( self )

Definition at line 26 of file cvel_cli.py.

Member Function Documentation

def cvel_cli.cvel_cli_.__call__	(	self,
		vis = `None`,
		outputvis = `None`,
		passall = `None`,
		field = `None`,
		spw = `None`,
		selectdata = `None`,
		antenna = `None`,
		timerange = `None`,
		scan = `None`,
		array = `None`,
		mode = `None`,
		nchan = `None`,
		start = `None`,
		width = `None`,
		interpolation = `None`,
		phasecenter = `None`,
		restfreq = `None`,
		outframe = `None`,
		veltype = `None`,
		hanning = `None`,
		async = `None`
	)

regrid an MS to a new spectral window / channel structure or frame

       vis -- Name of input visibility file
       default: none; example: vis='ngc5921.ms'    

       outputvis -- Name of output measurement set (required)
       default: none; example: vis='ngc5921-regridded.ms'    
       
       passall --  if False, data not meeting the selection is omitted/deleted 
       or flagged (if in-row); if True, data not meeting the selection 
       on field and spw is passed through without modification
       default: False; example: 
       field='NGC5921'
       passall=False : only data from NGC5921 is included in output MS, 
         no data from other fields (e.g. 1331+305) is included
       passall=True : data from NGC5921 is transformed by cvel, all other 
         fields are passed through unchanged 

       field -- Select fields in mosaic.  Use field id(s) or field name(s).
  ['go listobs' to obtain the list id's or names]
      default: ''= all fields
      If field string is a non-negative integer, it is assumed to
  be a field index otherwise, it is assumed to be 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 and 3C295
      field = '3,4C*'; field id 3, all names starting with 4C

       spw --Select spectral window/channels
      NOTE: This selects the data passed as the INPUT to mode
      default: ''=all spectral windows and channels
spw='0~2,4'; spectral windows 0,1,2,4 (all channels)
spw='0:5~61'; spw 0, channels 5 to 61
spw='<2';   spectral windows less than 2 (i.e. 0,1)
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
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

       selectdata -- Other data selection parameters
      default: True

  >>> selectdata=True expandable parameters

      antenna -- Select data based on antenna/baseline
  default: '' (all)
  If antenna string is a non-negative integer, it is 
    assumed to be an antenna index, otherwise, it is
    considered 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'; baselines 5-6 and 7-8
  antenna='5'; all baselines with antenna index 5
  antenna='05'; all baselines with antenna number 05 
                (VLA old name)
  antenna='5,6,9'; all baselines with antennas 5,6,9 
                   index numbers

      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 date 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' pick data within one integration 
             of time
  timerange='>10:24:00' data after this time

      scan -- Scan number range.
  default: '' (all)
  example: scan='1~5'
  Check 'go listobs' to insure the scan numbers are in 
        order.

      array -- Select data by (sub)array indices
  default: '' (all); example:
  array='0~2'; arrays 0 to 2 

      mode -- Frequency Specification:
       NOTE: See examples below:
       default: 'channel'
 mode = 'channel'; Use with nchan, start, width to specify
         output spw. Produces equidistant grid based on first
         selected channel. See examples below.
 mode = 'velocity', means channels are specified in 
      velocity.
 mode = 'frequency', means channels are specified in 
      frequency.
 mode = 'channel_b', alternative 'channel' mode.
         Does not force an equidistant grid. Faster.

  >>> mode expandable parameters 
       Start, width are given in units of channels, frequency 
  or velocity as indicated by mode 
       nchan -- Number of channels in output spw
 default: -1 = all channels; example: nchan=3
       start -- Start or end input channel (zero-based) depending on the sign of the width parameter
 default=0; example: start=5
       width -- Output channel width in units of the input
     channel width (sign indicates whether the start parameter is lower(+) or upper(-) end of the range)
 default=1; example: width=4
       interpolation -- Interpolation method (linear, nearest, cubic, spline, fftshift)
 default = 'linear'
   examples:
       spw = '0,1'; mode = 'channel'
  will produce a single spw containing all channels in spw 
       0 and 1
       spw='0:5~28^2'; mode = 'channel'
  will produce a single spw made with channels 
       (5,7,9,...,25,27)
       spw = '0'; mode = 'channel': nchan=3; start=5; width=4
  will produce an spw with 3 output channels
  new channel 1 contains data from channels (5+6+7+8)
  new channel 2 contains data from channels (9+10+11+12)
  new channel 3 contains data from channels (13+14+15+16)
       spw = '0:0~63^3'; mode='channel'; nchan=21; start = 0; 
   width = 1
  will produce an spw with 21 channels
  new channel 1 contains data from channel 0
  new channel 2 contains data from channel 2
  new channel 21 contains data from channel 61
       spw = '0:0~40^2'; mode = 'channel'; nchan = 3; start = 
   5; width = 4
  will produce an spw with three output channels
  new channel 1 contains channels (5,7)
  new channel 2 contains channels (13,15)
  new channel 3 contains channels (21,23)

      phasecenter -- direction measure  or fieldid for the mosaic center
       default: '' => first field selected ; example: phasecenter=6
       or phasecenter='J2000 19h30m00 -40d00m00'

      restfreq -- Specify rest frequency to use for output image
       default='' Occasionally it is necessary to set this (for
       example some VLA spectral line data).  For example for
       NH_3 (1,1) put restfreq='23.694496GHz'

      outframe -- output reference frame
       default='' (keep original reference frame) ; example: outframe='bary'     

      veltype -- definition of velocity (in mode)
       default = 'radio'

      hanning -- if true, Hanning smooth frequency channel data to remove Gibbs ringing

==================================================================

The intent of cvel is to transform channel labels and the 
visibilities to a spectral reference frame which is appropriate
for the science analysis, e.g. from TOPO to LSRK to correct for 
Doppler shifts throughout the time of the observation. Naturally, 
this will change the shape of the spectral feature to some extent. 
According to the Nyquist theorem you should oversample a spectrum 
with twice the numbers of channels to retain the shape. Based on 
some tests, however, we recommend to observe with at least 
3-4 times the number of channels for each significant spectral 
feature (like 3-4 times the linewidth). This will minimize 
regridding artifacts in cvel.

If cvel has already established the grid that is desired for the
imaging, clean should be run with exactly the same frequency/velocity 
parameters as used in cvel in order to avoid additional regridding in 
clean.

Hanning smoothing is optionally offered in cvel, but tests have 
shown that already the regridding process itself, if it involved 
a transformation from TOPO to a non-terrestrial reference frame, 
implies some smoothing (due to channel interpolation) such that 
Hanning smoothing may not be necessary.

Definition at line 46 of file cvel_cli.py.

def cvel_cli.cvel_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

def cvel_cli.cvel_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 394 of file cvel_cli.py.

References clearstat_cli.clearstat_cli_.__globals__, clearplot_cli.clearplot_cli_.__globals__, asdmsummary_cli.asdmsummary_cli_.__globals__, conjugatevis_cli.conjugatevis_cli_.__globals__, caltabconvert_cli.caltabconvert_cli_.__globals__, boxit_cli.boxit_cli_.__globals__, calstat_cli.calstat_cli_.__globals__, clearcal_cli.clearcal_cli_.__globals__, browsetable_cli.browsetable_cli_.__globals__, concat_cli.concat_cli_.__globals__, csvclean_cli.csvclean_cli_.__globals__, accum_cli.accum_cli_.__globals__, blcal_cli.blcal_cli_.__globals__, applycal_cli.applycal_cli_.__globals__, cvel_cli.cvel_cli_.__globals__, bandpass_cli.bandpass_cli_.__globals__, autoclean_cli.autoclean_cli_.__globals__, clean_cli.clean_cli_.__globals__, clearstat_cli.clearstat_cli_.itsdefault(), clearplot_cli.clearplot_cli_.itsdefault(), asdmsummary_cli.asdmsummary_cli_.itsdefault(), conjugatevis_cli.conjugatevis_cli_.itsdefault(), caltabconvert_cli.caltabconvert_cli_.itsdefault(), clearcal_cli.clearcal_cli_.itsdefault(), calstat_cli.calstat_cli_.itsdefault(), boxit_cli.boxit_cli_.itsdefault(), browsetable_cli.browsetable_cli_.itsdefault(), concat_cli.concat_cli_.itsdefault(), accum_cli.accum_cli_.itsdefault(), csvclean_cli.csvclean_cli_.itsdefault(), blcal_cli.blcal_cli_.itsdefault(), applycal_cli.applycal_cli_.itsdefault(), cvel_cli.cvel_cli_.itsdefault(), bandpass_cli.bandpass_cli_.itsdefault(), autoclean_cli.autoclean_cli_.itsdefault(), and clean_cli.clean_cli_.itsdefault().

def cvel_cli.cvel_cli_.description	(	self,
		key = `'cvel'`,
		subkey = `None`
	)

Definition at line 491 of file cvel_cli.py.

def cvel_cli.cvel_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 536 of file cvel_cli.py.

References accum_cli.accum_cli_.parameters, cvel_cli.cvel_cli_.parameters, csvclean_cli.csvclean_cli_.parameters, conjugatevis_cli.conjugatevis_cli_.parameters, concat_cli.concat_cli_.parameters, clearstat_cli.clearstat_cli_.parameters, clearplot_cli.clearplot_cli_.parameters, clearcal_cli.clearcal_cli_.parameters, clean_cli.clean_cli_.parameters, caltabconvert_cli.caltabconvert_cli_.parameters, calstat_cli.calstat_cli_.parameters, browsetable_cli.browsetable_cli_.parameters, boxit_cli.boxit_cli_.parameters, blcal_cli.blcal_cli_.parameters, bandpass_cli.bandpass_cli_.parameters, autoclean_cli.autoclean_cli_.parameters, asdmsummary_cli.asdmsummary_cli_.parameters, and applycal_cli.applycal_cli_.parameters.

def cvel_cli.cvel_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 370 of file cvel_cli.py.

References clearstat_cli.clearstat_cli_.__globals__, clearplot_cli.clearplot_cli_.__globals__, asdmsummary_cli.asdmsummary_cli_.__globals__, conjugatevis_cli.conjugatevis_cli_.__globals__, caltabconvert_cli.caltabconvert_cli_.__globals__, boxit_cli.boxit_cli_.__globals__, calstat_cli.calstat_cli_.__globals__, clearcal_cli.clearcal_cli_.__globals__, browsetable_cli.browsetable_cli_.__globals__, concat_cli.concat_cli_.__globals__, csvclean_cli.csvclean_cli_.__globals__, accum_cli.accum_cli_.__globals__, blcal_cli.blcal_cli_.__globals__, applycal_cli.applycal_cli_.__globals__, cvel_cli.cvel_cli_.__globals__, bandpass_cli.bandpass_cli_.__globals__, autoclean_cli.autoclean_cli_.__globals__, and clean_cli.clean_cli_.__globals__.

def cvel_cli.cvel_cli_.result	(	self,
		key = `None`
	)

Member Data Documentation

dictionary cvel_cli.cvel_cli_.__async__ [static, private]

Definition at line 20 of file cvel_cli.py.

Referenced by cvel_cli.cvel_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(), and deconvolve_cli.deconvolve_cli_.result().

cvel_cli.cvel_cli_.__bases__ [private]

Definition at line 27 of file cvel_cli.py.

cvel_cli.cvel_cli_.__doc__ [private]

Definition at line 28 of file cvel_cli.py.

cvel_cli.cvel_cli_.__globals__ [private]

Definition at line 227 of file cvel_cli.py.

string cvel_cli.cvel_cli_.__name__ [static, private]

Definition at line 19 of file cvel_cli.py.

cvel_cli.cvel_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file cvel_cli.py.

cvel_cli.cvel_cli_.parameters

Definition at line 30 of file cvel_cli.py.

tuple cvel_cli.cvel_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 439 of file cvel_cli.py.

tuple cvel_cli.cvel_cli_.retval [static]

Definition at line 452 of file cvel_cli.py.

cvel_cli.cvel_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file cvel_cli.py.

string cvel_cli.cvel_cli_.valornotval [static]

Definition at line 442 of file cvel_cli.py.

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

cvel_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