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

Constructor & Destructor Documentation

def widefield_cli.widefield_cli_.__init__ ( self )

Definition at line 26 of file widefield_cli.py.

Member Function Documentation

def widefield_cli.widefield_cli_.__call__	(	self,
		vis = `None`,
		imagename = `None`,
		outlierfile = `None`,
		field = `None`,
		spw = `None`,
		selectdata = `None`,
		timerange = `None`,
		uvrange = `None`,
		antenna = `None`,
		scan = `None`,
		mode = `None`,
		niter = `None`,
		gain = `None`,
		threshold = `None`,
		psfmode = `None`,
		ftmachine = `None`,
		facets = `None`,
		wprojplanes = `None`,
		multiscale = `None`,
		negcomponent = `None`,
		interactive = `None`,
		mask = `None`,
		nchan = `None`,
		start = `None`,
		width = `None`,
		imsize = `None`,
		cell = `None`,
		phasecenter = `None`,
		restfreq = `None`,
		stokes = `None`,
		weighting = `None`,
		robust = `None`,
		npixels = `None`,
		noise = `None`,
		cyclefactor = `None`,
		cyclespeedup = `None`,
		npercycle = `None`,
		uvtaper = `None`,
		outertaper = `None`,
		innertaper = `None`,
		restoringbeam = `None`,
		calready = `None`,
		async = `None`
	)

Wide-field imaging and deconvolution with selected algorithm

Wide-field imaging and deconvolution with selected algorithm:

This is the main wide-field imaging/deconvolution task.  It
uses the wprojection method for a large field of view, can
make many facets, and can include outlier fields.  Several
deconvolution algorithms are supported.  Interactive cleaning
is also supported.

For making large images (>2000 on a size), see hints at the
end of the descriptions.  For making images larger than about
5000x5000, the available memory must be larger than 2 Gbytes. For such 
images therefore  a computer with a 64-bit operating system may be
needed.


Keyword arguments:
vis -- Name of all input visibility files
default: none; example: vis='ngc5921.ms'
example: vis=['data01.ms', 'data02.ms']
imagename -- Pre-name of output images:
default: none; example: imagename='n5921'
if outlier fields are included, then
   imagename=['n5921', 'outlier1', outlier2']
   and the first imagename is the wide-field image
output images names are: n5921.clean, n5921.residual,
n5921.model, n5921.interactive.mask
mode -- Type of selection
default: 'mfs'; example: mode='channel';
Options: 'mfs', channel, velocity, frequency'
alg -- Algorithm to use
default: 'clark';
Options: 'clark', 'hogbom','multiscale','entropy'
    Strongly advise 'clark'.  multiscale and entropy
    well-tested.
imsize -- Image pixel size (x,y)
default = [256,256]; example: imsize=[500,500], or imsize=500
example for multiple fields: imsize=[(1000, 1000), (100, 100)]
cell -- Cell size (x,y)
default=['1arcsec,'1arcsec']
example: cell=['0.5arcsec,'0.5arcsec'], or cell='0.5arcsec'
phasecenter -- direction position or the field for the image center
A list of the above is needed for multiple-fields
default: '' -->field='0' as center; example: phasecenter='6'
   phasecenter='J2000 19h30m00 -40d00m00'
   phasecenter=['J2000 19h30m00 -40d00m00', 'J2000 19h57m00 40d00m00']
      for wide-field, plus one outlier field.
stokes -- Stokes parameters to image
default='I'; example: stokes='IQUV';
Options: 'I','IV','IQU','IQUV'
niter -- Number iterations, set to zero for no CLEANing
default: 500; example: niter=500
gain -- Loop gain for CLEANing
default: 0.1; example: gain=0.1
threshold -- Flux level at which to stop CLEANing (units=mJy)
default: 0.0; example: threshold=0.0
mask -- Name(s) of mask image(s) used for CLEANing
default: ''  example: mask='orion.mask'
Number of mask fields must equal number of imaged fields
cleanbox -- List of [blc-x,blc-y,trc-x,trc-y] values
default: []; example: cleanbox=[110,110,150,145]
Note: This can also be a filename with clean values:
fieldindex blc-x blc-y trc-x trc-y
cleanbox = 'interactive' is very useful.
--- Data Selection
nchan -- Number of channels to select
default: 1; example: nchan=45
start -- Start channel, 0-relative
default=0; example: start=5
if mode='frequency' then a frequency value e.g start='1.4GHz'
width -- Channel width (value > 1 indicates channel averaging)
default=1; example: width=5
if mode='frequency' then a frequency value e.g  width='10kHz'
step -- Step in channel number
default=1; example: step=2
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
       example for multiple ms in vis parameter:
       field=['0~2', '1,2']
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
       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
       For multiple ms in vis parameter:
       spw=['0,10,3:3~45', '<2']
timerange -- Select time range subset of data (not implemented yet)
    default='' meaning no time selection
    example: timerange='YYYY/MM/DD/HH:MM:SS.sss'
    timerange='< YYYY/MM/DD/HH:MM:SS.sss'
    timerange='> YYYY/MM/DD/HH:MM:SS.sss'
    timerange='ddd/HH:MM:SS.sss'
    timerange='< ddd/HH:MM:SS.sss'
    timerange='> ddd/HH:MM:SS.sss'
restfreq -- Specify rest frequency to use for image
    default='' (i.e., try to use the restfreq specified in the visibility data)

--- Weighting
weighting -- Weighting to apply to visibilities
default='natural'; example: weighting='uniform';
Options: 'natural','uniform','briggs','briggsabs','radial', 'superuniform'
robust -- 'briggs' and 'brigssabs' robustness parameter
default=0.0; example: robust=0.5;
Options: -2.0 to 2.0; -2 (uniform)/+2 (natural)
npixels -- number of pixels to determine uv-cell size for weight calculation
 -- Used with superuniform or briggs weighting schemes
  example: npixels=3

--- widefield controls
ftmachine -- Gridding method for the image;
ft (standard interferometric gridding).
wproject (wprojection algorithm for gridding)
default: wproject
wprojplanes -- Number w-projection planes to use for gridding
default: 256
example: wprojplanes=64
   Good value = BMAX(klambda) * Map width(arcmin)^2 / 600
facets   -- Number of facets along one axis on central image
image is divided in facets x facets rectangles.
default: 1
example: facets=3 makes 3x3 images to cover the field
if ftmachine = 'ft', only faceting is used
if ftmachine = 'wproject', both wplanes and faceting  
         can be used  (see below).

cyclefactor -- Change the threshold at which the deconvolution cycle will
stop and degrid and subtract from the visibilities. For bad PSFs,
reconcile often (cyclefactor=4 or 5); For good PSFs, use
cyclefactor 1.5 to 2.0.
default: 2.5; example: cyclefactor=4, but decreases speed considerably.
<cycle threshold = cyclefactor * max sidelobe * max residual>
cyclespeedup -- Cycle threshold doubles in this number of iterations
default: -1; example: cyclespeedup=500

--- MEM parameters (Experimental, not well-tested)
sigma -- Target image sigma
default: '0.001Jy'; example: sigma='0.1Jy'
targetflux -- Target flux for final image
default: '1.0Jy'; example: targetflux='200Jy'
constrainflux -- Constrain image to match target flux;
otherwise, targetflux is used to initialize model only.
default: False; example: constrainflux=True
prior -- Name of MEM prior images
default: ['']; example: prior='source_mem.image'

--- Multi-scale parameters (Experimental, not well-tested)
negcomponent -- Stop component search when the largest scale has found this
number of negative components; -1 means continue component search
even if the largest component is negative.
default: 2; example: negcomponent=-1
scales -- Used for alg='multiscale'; set a number of scales or a vector
default: [0,3,10]; example: scales=[0.0,3.0,10.0, 30]
--  interactive masking
npercycle -- when cleanbox is set to 'interactive',
   this is the number of iterations between each clean to update mask
   interactively. However, this number can be adjusted during execution.

uvtaper -- Apply additional uv tapering of the visibilities.
       default: uvtaper=False; example: uvtaper=True
  uvtaper=True expandable parameters
     outertaper -- uv-taper on outer baselines in uv-plane
           [bmaj, bmin, bpa] taper Gaussian scale in uv or
            angular units. NOTE: uv taper in (klambda) is  
            roughly on-sky FWHM(arcsec/200)
         default: outertaper=[]; no outer taper applied
            example: outertaper=['5klambda']  circular taper
                FWHM=5 kilo-lambda
                outertaper=['5klambda','3klambda','45.0deg']
                outertaper=['10arcsec'] on-sky FWHM 10"
                outertaper=['300.0'] default units are meters
                   in aperture plane
     innertaper -- uv-taper in center of uv-plane
             NOT YET IMPLEMENTED

restoringbeam -- Output Gaussian restoring beam for CLEAN image
[bmaj, bmin, bpa] elliptical Gaussian restoring beam
default units are in arc-seconds for bmaj,bmin, degrees
for bpa default: restoringbeam=[]; Use PSF calculated
from dirty beam.
example: restoringbeam=['10arcsec'] circular Gaussian
       FWHM 10" example:
       restoringbeam=['10.0','5.0','45.0deg'] 10"x5"
       at 45 degrees

calready -- if True will create scratch columns if they are 
not there. And after clean completes the predicted model 
visibility is from the clean components are
written to the ms.        

async --  Run asynchronously
default = False; do not run asychronously

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

      HINTS ON RUNNING WIDEFIELD

      1.  Decide if the images will be specified directly in the  
  inputs or with an outlier file.  For more than a few fields,
  an outlier file more convenient.

 Direct Method:

    cell = ['1.0arcsec', '1.0arcsec']
    imagename = ['M1_0','M1_1','M1_2]
    imsize = [[1024,1024],[128,128],[128,128]]
    phasecenter = ['J2000 13h27m20.98 43d26m28.0', 
      'J2000 13h30m52.159 43d23m08.02', 'J2000 13h24m08.16 43d09m48.0']

  Text file method  (in outlier.txt)

    imagename = 'M1'
    outlierfile = 'outlier.txt'
       [phasecenter, imsize ignored]

    Contents of outlier.txt
    C   0   1024 1024   13 27 20.98     43 26 28.0
    C   1    128  128   13 30 52.158    43 23 08.00
    C   2    128  128   13 24 08.163    43 09 48.00

 In both cases the following images will be made:
     M1_0.image, M1_1.image, M1_2.image     cleaned images
     M1.0.model, M1_1.model, M1_2.model     model images
     M1.0.residual, M1_1.residual, M1_2.residual     residual images

       2.  Wprojection:  It is fastest to use wprojection without faceting.
     ftmachine = 'wproject'
     wprojplane = NN

   The value of NN should be chosen as small as possible to reduce
   execution time.  The algorithm
       NN = BMAX(klambda) * imagewidth (arcmin)^2 / 600, with a minimum
    of 16, should be adequate.

       3.  Depending on the memory of the computer, a limit of about
       5000x5000 may occur for example if a computer has 2Gbyte of
       RAM. Also a 32-bit computer has a maximum limit of 2Gbyte
       memory usable per process, irrespective of how much physical
       RAM is present. Hence it is recommended to move to a 64-bit
       computer with more than 2 GByte of RAM for >5000x5000 images
   

       4. For data with extremely large 'w' values, i.e low frequency,
       long baseline and very widefield image, the wprojection
       convolution can be very large and either not fit in memory or
       slow for processing.  In these cases you should consider using
       both ftmachine='wproject' and facets=xx where is 3.

Definition at line 46 of file widefield_cli.py.

def widefield_cli.widefield_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 628 of file widefield_cli.py.

def widefield_cli.widefield_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 531 of file widefield_cli.py.

def widefield_cli.widefield_cli_.description	(	self,
		key = `'widefield'`,
		subkey = `None`
	)

Definition at line 659 of file widefield_cli.py.

def widefield_cli.widefield_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 730 of file widefield_cli.py.

Referenced by wvrgcal_cli.wvrgcal_cli_.defaults(), and widefield_cli.widefield_cli_.defaults().

def widefield_cli.widefield_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 507 of file widefield_cli.py.

def widefield_cli.widefield_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file widefield_cli.py.

References accum_cli.accum_cli_.__async__, widefield_cli.widefield_cli_.__async__, widebandpbcor_cli.widebandpbcor_cli_.__async__, visstat_cli.visstat_cli_.__async__, vishead_cli.vishead_cli_.__async__, virtualconcat_cli.virtualconcat_cli_.__async__, viewer_cli.viewer_cli_.__async__, uvsub_cli.uvsub_cli_.__async__, uvmodelfit_cli.uvmodelfit_cli_.__async__, uvcontsub_cli.uvcontsub_cli_.__async__, uvcontsub3_cli.uvcontsub3_cli_.__async__, uvcontsub2_cli.uvcontsub2_cli_.__async__, testconcat_cli.testconcat_cli_.__async__, tclean_cli.tclean_cli_.__async__, statwt_cli.statwt_cli_.__async__, ssoflux_cli.ssoflux_cli_.__async__, split_cli.split_cli_.__async__, splattotable_cli.splattotable_cli_.__async__, specfit_cli.specfit_cli_.__async__, smoothcal_cli.smoothcal_cli_.__async__, slsearch_cli.slsearch_cli_.__async__, simobserve_cli.simobserve_cli_.__async__, simanalyze_cli.simanalyze_cli_.__async__, simalma_cli.simalma_cli_.__async__, setjy_cli.setjy_cli_.__async__, sdtpimaging_cli.sdtpimaging_cli_.__async__, sdstat_cli.sdstat_cli_.__async__, sdsmooth_cli.sdsmooth_cli_.__async__, sdscale_cli.sdscale_cli_.__async__, sdsave_cli.sdsave_cli_.__async__, sdreduce_cli.sdreduce_cli_.__async__, sdplot_cli.sdplot_cli_.__async__, sdmath_cli.sdmath_cli_.__async__, sdlist_cli.sdlist_cli_.__async__, sdimprocess_cli.sdimprocess_cli_.__async__, sdimaging_cli.sdimaging_cli_.__async__, sdgrid_cli.sdgrid_cli_.__async__, sdflagmanager_cli.sdflagmanager_cli_.__async__, sdflag_cli.sdflag_cli_.__async__, sdfit_cli.sdfit_cli_.__async__, sdcoadd_cli.sdcoadd_cli_.__async__, sdcal_cli.sdcal_cli_.__async__, sdbaseline_cli.sdbaseline_cli_.__async__, rmtables_cli.rmtables_cli_.__async__, predictcomp_cli.predictcomp_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 widefield_cli.widefield_cli_.__async__ [static, private]

Definition at line 20 of file widefield_cli.py.

Referenced by widefield_cli.widefield_cli_.result(), and wvrgcal_cli.wvrgcal_cli_.result().

widefield_cli.widefield_cli_.__bases__ [private]

Definition at line 27 of file widefield_cli.py.

widefield_cli.widefield_cli_.__doc__ [private]

Definition at line 28 of file widefield_cli.py.

widefield_cli.widefield_cli_.__globals__ [private]

Definition at line 310 of file widefield_cli.py.

Referenced by wvrgcal_cli.wvrgcal_cli_.check_params(), widefield_cli.widefield_cli_.check_params(), wvrgcal_cli.wvrgcal_cli_.defaults(), widefield_cli.widefield_cli_.defaults(), wvrgcal_cli.wvrgcal_cli_.paramgui(), and widefield_cli.widefield_cli_.paramgui().

string widefield_cli.widefield_cli_.__name__ [static, private]

Definition at line 19 of file widefield_cli.py.

widefield_cli.widefield_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file widefield_cli.py.

widefield_cli.widefield_cli_.parameters

Definition at line 30 of file widefield_cli.py.

Referenced by wvrgcal_cli.wvrgcal_cli_.itsdefault(), and widefield_cli.widefield_cli_.itsdefault().

tuple widefield_cli.widefield_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 607 of file widefield_cli.py.

tuple widefield_cli.widefield_cli_.retval [static]

Definition at line 620 of file widefield_cli.py.

widefield_cli.widefield_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file widefield_cli.py.

string widefield_cli.widefield_cli_.valornotval [static]

Definition at line 610 of file widefield_cli.py.

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

widefield_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