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

Constructor & Destructor Documentation

def mosaic_cli.mosaic_cli_.__init__ ( self )

Definition at line 26 of file mosaic_cli.py.

Member Function Documentation

def mosaic_cli.mosaic_cli_.__call__	(	self,
		vis = `None`,
		imagename = `None`,
		mode = `None`,
		alg = `None`,
		imsize = `None`,
		cell = `None`,
		phasecenter = `None`,
		stokes = `None`,
		niter = `None`,
		gain = `None`,
		threshold = `None`,
		mask = `None`,
		cleanbox = `None`,
		nchan = `None`,
		start = `None`,
		width = `None`,
		field = `None`,
		spw = `None`,
		timerange = `None`,
		restfreq = `None`,
		sdimage = `None`,
		modelimage = `None`,
		weighting = `None`,
		mosweight = `None`,
		rmode = `None`,
		robust = `None`,
		ftmachine = `None`,
		cyclefactor = `None`,
		cyclespeedup = `None`,
		scaletype = `None`,
		minpb = `None`,
		sigma = `None`,
		targetflux = `None`,
		constrainflux = `None`,
		prior = `None`,
		negcomponent = `None`,
		scales = `None`,
		npercycle = `None`,
		npixels = `None`,
		noise = `None`,
		async = `None`
	)

Create a multi-field deconvolved image with selected algorithm


    Two types of point-source deconvolution, as well as multi-scale
    deconvolution, are available.  A continuum image (mfs) is produced
    by gridding together all spectral data.   Individual channels or
    groups of channels can also be images and then placed in an output
    image cube.

    The cleaning regions can be specified by an input mask image, from a
    file containing rectangular regions, or interactively as the
    deconvolution progresses.

    The mosaic task only uses the "corrected" datacolumn which is made
    from the "data" data column using applycal with the appropriate
    calibration tables.  Many Stokes combinations are available.


    Keyword arguments:
    vis -- Name of input visibility file
    default: none; example: vis='ngc5921.ms'
    imagename -- Pre-name of output images:
    default: none; example: imagename='m2'
    output images are:
      m2.image; cleaned and restored image
      m2.flux;  relative sky sensitivity over field
      m2.model; image of clean components
      m2.residual; image of residuals
      m2.interactive.mask; image containing clean regions
    mode -- Frequency Specification:
    NOTE: See examples below:
    default: 'mfs'
      mode = 'mfs' means produce one image from all specified data.
      mode = 'channel'; Use with nchan, start, width to specify
      output image cube.  See examples below
      mode = 'velocity', means channels are specified in velocity.
      mode = 'frequency', means channels are specified in frequency.
       >>> mode expandable parameters (for modes other than 'mfs')
    Start, width are given in units of channels, frequency or velocity
       as indicated by mode, but only channel is complete.
    nchan -- Number of channels (planes) in output image
      default: 1; example: nchan=3
    start -- Start input channel (relative-0)
      default=0; example: start=5
    width -- Output channel width (>1 indicates channel averaging)
      default=1; example: width=4
examples:
    spw = '0,1'; mode = 'mfs'
       will produce one image made from all channels in spw 0 and 1
    spw='0:5~28^2'; mode = 'mfs' 
       will produce one image made with channels (5,7,9,...,25,27)
    spw = '0'; mode = 'channel': nchan=3; start=5; width=4
       will produce an image with 3 output planes
       plane 1 contains data from channels (5+6+7+8)
       plane 2 contains data from channels (9+10+11+12)
       plane 3 contains data from channels (13+14+15+16)
    spw = '0:0~63^3'; mode=chann; nchan=21; start = 0; width = 1
       will produce an image with 20 output planes
       Plane 1 contains data from channel 0
       Plane 2 contains date from channel 2
       Plane 21 contains data from channel 61
    spw = '0:0~40^2'; mode = 'channel'; nchan = 3; start = 5; width = 4
       will produce an image with three output planes
       plane 1 contains channels (5,7)
       plane 2 contains channels (13,15)
       plane 3 contains channels (21,23)
    alg -- Algorithm to use (expandable):
    default: 'clark': Options: 'clark','hogbom','multiscale','entropy'
    'hogbom' Cleans from the images only.  Only inner quarter
     of image is cleaned
    'clark' Cleans from gridded us data.  Only inner quarter of
    image is cleaned
    'multiscale' cleans with several resolutions using hobgom clean
  Currently much slower than single resolution. For extended 
  sources, try single resolution with interactive and
    'entropy' Maximum entropy algorithm is still experimental
  and not recommended for general use
      >>> multiscale expandable parameter
    scales  -- in pixel numbers; the size of component to deconvolve
  default = [0,3,10]
   recommended sizes are 0 (point), 3 (points per clean beam), and
    10 (about a factor of three lower resolution)
    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
      >>> entropy (MEM) expandable parameters (experimental)
    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'
    imsize -- Image pixel size (x,y)
    default = [256,256]; example: imsize=[350,350]
    imsize = 500 is equivalent to [500,500]
    cell -- Cell size (x,y)
    default= none;
    example: cell=['0.5arcsec,'0.5arcsec'] or
    cell=['1arcmin', '1arcmin']
    cell = '1arcsec' is equivalent to ['1arcsec','1arcsec']
    NOTE:cell = '2' makes default cell size of 2 radians! 
    phasecenter -- direction measure  or fieldid for the mosaic center
    default: 0 (imply field=0 as center); example: phasecenter=6
    or phasecenter='J2000 19h30m00 -40d00m00'
    stokes -- Stokes parameters to image
    default='I'; example: stokes='IQUV';
    Options: 'I','IV''QU','IQUV','RR','LL','XX','YY','RRLL','XXYY'
    niter -- Maximum number iterations, set to zero for no CLEANing
    default: 500; example: niter=500
    gain -- Loop gain for CLEANing
    default: 0.1; example: gain=0.5
    threshold -- Flux level at which to stop CLEANing (units=mJy)
    default: 0.0; example: threshold=0.0  
    mask -- Name of mask image used for CLEANing
    default '' means no mask;
      example: mask='orion.mask'.  
    It is useful to use a mask from a previous interactive mosaic 
    session for a new execution.  The mask image shape
    must be the same as the new mosaic.
    cleanbox -- Cleaning region:
    default: [] defaults to inner quarter of image
    Three specification types:
    (a) 'interactive' allows the user to build the cleaning
 mask interactively using the viewer.  The viewer will 
 appear every npercycle interation, but modify as needed
 The final interactive maks is saved in the file
 imagename_interactive.mask.
    (b) Explicit pixel ranges
example: cleanbox=[110,110,150,145]
clean region with blc=110,100; trc=150,145 (pixel values)
Only one clean region can be given this way.
    (c) Filename with pixel values with ascii format:
<fieldindex blc-x blc-y trc-x trc-y> on each line
1  45  66  123 124
2  23 100  300 340
      >>> 'interactive' expandable parameter 
    npercycle -- this is the number of iterations between each clean 
    to update mask interactively. Set to about niter/5, can also
    be changed interactively.               
    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='<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
    timerange  -- Time range:
    default = '' (all); examples,
    selectime = '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' data within one integration of time
    timerange='>10:24:00' data after this time
    restfreq -- Specify rest frequency to use for 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'
    sdimage -- Input Single Dish image to use for model
    default='' (no image); example: sdimage='n4826_12mchan.im'
    modelimage -- Name of output(/input) model image
    default='' (none=imagename.model); modelimage='orion.model'
    Note: This specifies the output model if a single dish
    image is input or the output model name from the imaging
    weighting -- Weighting to apply to visibilities:
    default='natural'; example: weighting='uniform';
    Options: 'natural','uniform','briggs','radial', 'superuniform'
       >>> Weighting expandable parameters
    For weighting='briggs'
      rmode -- Robustness mode (see help mosaic)
default='norm'; example='abs';
Options: 'norm','abs','none'
      robust -- Brigg's robustness parameter
default=0.0; example: robust=0.5;
Options: -2.0 to 2.0; -2 (uniform)/+2 (natural)
      noise   -- noise parameter to use for rmode='abs' in
briggs weighting
example noise='1.0mJy'
    For superuniform/briggs weighting
npixels -- number of pixels to determine uv-cell size
for weight calculation
example npixels=7
    mosweight -- Individually weight the fields of the mosaic
    default: False; example: mosweight=True
    This can be useful if some of your fields are more
    sensitive than others (i.e. due to time spent on-source);
    this parameter will give more weight to higher sensitivity
    fields in the overlap regions.
    ftmachine -- Gridding method for the image;
    Options: ft (standard interferometric gridding), sd
    (standard single dish) both (ft and sd as appropriate),
    mosaic (gridding use PB as convolution function)
    default: 'mosaic'; example: ftmachine='ft'
    cyclefactor -- Change the threshold at which the deconvolution cycle will
    stop, degrid and subtract from the visibilities. For poor PSFs,
    reconcile often (cyclefactor=4 or 5); For good PSFs, use
    cyclefactor 1.5 to 2.0.
    default: 1.5; example: cyclefactor=4
    cycle threshold = cyclefactor * max sidelobe * max residual
    cyclespeedup -- Cycle threshold doubles in this number of iterations
    default: -1; example: cyclespeedup=500
    scaletype -- Controls scaling of pixels in the image plane. 
    default='SAULT'; example: scaletype='PBCOR'
    Options: 'PBCOR','SAULT'
    'SAULT' scale makes an output image where the noise is constant
     across the whole mosaic. However, the image is NOT
     corrected for the PB pattern, and therefore is not "flux
     correct". Division of the SAULT image_name.image image
     by the image_name.flux image will produce a "flux correct image".
     The 'PBCOR' option uses the SAULT scaling scheme for
     deconvolution, but when interactively cleaning shows the
     primary beam corrected image; the final PBCOR image is "flux
     correct"
    minpb -- Minimum PB level to use
    default=0.1; example: minpb=0.01
    async --  Run asynchronously
    default = False; do not run asychronously

Definition at line 46 of file mosaic_cli.py.

def mosaic_cli.mosaic_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 602 of file mosaic_cli.py.

def mosaic_cli.mosaic_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 511 of file mosaic_cli.py.

def mosaic_cli.mosaic_cli_.description	(	self,
		key = `'mosaic'`,
		subkey = `None`
	)

Definition at line 633 of file mosaic_cli.py.

def mosaic_cli.mosaic_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 700 of file mosaic_cli.py.

def mosaic_cli.mosaic_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 487 of file mosaic_cli.py.

def mosaic_cli.mosaic_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file mosaic_cli.py.

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

Definition at line 20 of file mosaic_cli.py.

Referenced by mosaic_cli.mosaic_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(), and msmoments_cli.msmoments_cli_.result().

mosaic_cli.mosaic_cli_.__bases__ [private]

Definition at line 27 of file mosaic_cli.py.

mosaic_cli.mosaic_cli_.__doc__ [private]

Definition at line 28 of file mosaic_cli.py.

mosaic_cli.mosaic_cli_.__globals__ [private]

Definition at line 287 of file mosaic_cli.py.

string mosaic_cli.mosaic_cli_.__name__ [static, private]

Definition at line 19 of file mosaic_cli.py.

mosaic_cli.mosaic_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file mosaic_cli.py.

mosaic_cli.mosaic_cli_.parameters

Definition at line 30 of file mosaic_cli.py.

tuple mosaic_cli.mosaic_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 581 of file mosaic_cli.py.

tuple mosaic_cli.mosaic_cli_.retval [static]

Definition at line 594 of file mosaic_cli.py.

mosaic_cli.mosaic_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file mosaic_cli.py.

string mosaic_cli.mosaic_cli_.valornotval [static]

Definition at line 584 of file mosaic_cli.py.

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

mosaic_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