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

Constructor & Destructor Documentation

def csvclean_cli.csvclean_cli_.__init__ ( self )

Definition at line 26 of file csvclean_cli.py.

Member Function Documentation

def csvclean_cli.csvclean_cli_.__call__	(	self,
		vis = `None`,
		imagename = `None`,
		field = `None`,
		spw = `None`,
		advise = `None`,
		mode = `None`,
		nchan = `None`,
		width = `None`,
		imsize = `None`,
		cell = `None`,
		phasecenter = `None`,
		niter = `None`,
		weighting = `None`,
		restoringbeam = `None`,
		interactive = `None`,
		async = `None`
	)

This task does an invert of the visibilities and deconvolve in the image plane.

This task does not do a uvdata subtraction (aka Cotton-Schwab major cycle) 
of model visibility as in clean. - For ALMA Commissioning

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

imagename -- Name of output CASA image. (only the prefix)
   default: none; example: imagename='m2'
   output images are:
 m2.image; cleaned and restored image
        With or without primary beam correction
 m2dirty.image; dirty image
 m2psf.image; point-spread function (dirty beam)
 m2.model; image of clean components
 m2.mask; image containing clean regions, when interative=True
         
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
advise -- This determines whether advice for imsize and cell is 
  requested. If set to True. It won't run clean but return
  values for imszise and cell estimated for the longest 
  baseline in the data
      
imsize -- Image pixel size (x,y).  DOES NOT HAVE TO BE A POWER OF 2
       default = [256,256]; example: imsize=[350,350]
       imsize = 500 is equivalent to [500,500].
       Avoid odd-numbered imsize.

cell -- Cell size (x,y)
       default= '1.0arcsec';
       example: cell=['0.5arcsec,'0.5arcsec'] or
       cell=['1arcmin', '1arcmin']
       cell = '1arcsec' is equivalent to ['1arcsec','1arcsec']
       NOTE:cell = 2.0 => ['2arcsec', '2arcsec']

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

mode -- this determines what kind of image to make 
continuum or cube. In continuum all the selected data 
channels are combined in a 1 channel image using 
multifrequency synthesis.
options are 'cube' and 'continuum'
default: 'continuum'
  >>> mode='cube' expandable parameters
       nchan -- sets the number of channel in the output
       image. e.g nchan=10

       width -- image channel width in terms of the number of
        channel of the first spw of the data selected
        e.g width=2  
      


niter -- Maximum number of iterations,
       if niter=0, then no CLEANing is done ("invert" only)
       default: 500; example: niter=5000

weighting -- Weighting to apply to visibilities:
       default='natural'; example: weighting='uniform';
       Options: 'natural','uniform','briggs', 
       'superuniform','briggsabs','radial'

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

interactive -- Create a mask interactively or not.
        default=False; example: interactive=True
        The viewer will open with the image displayed. Select the
        region for the mask and double click in the middle of it.

Definition at line 46 of file csvclean_cli.py.

def csvclean_cli.csvclean_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 374 of file csvclean_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__, bandpass_cli.bandpass_cli_.__globals__, autoclean_cli.autoclean_cli_.__globals__, and clean_cli.clean_cli_.__globals__.

def csvclean_cli.csvclean_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 317 of file csvclean_cli.py.

def csvclean_cli.csvclean_cli_.description	(	self,
		key = `'csvclean'`,
		subkey = `None`
	)

Definition at line 405 of file csvclean_cli.py.

def csvclean_cli.csvclean_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 433 of file csvclean_cli.py.

References accum_cli.accum_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 csvclean_cli.csvclean_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 293 of file csvclean_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__, bandpass_cli.bandpass_cli_.__globals__, autoclean_cli.autoclean_cli_.__globals__, and clean_cli.clean_cli_.__globals__.

def csvclean_cli.csvclean_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file csvclean_cli.py.

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

Definition at line 20 of file csvclean_cli.py.

Referenced by csvclean_cli.csvclean_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(), and cvel_cli.cvel_cli_.result().

csvclean_cli.csvclean_cli_.__bases__ [private]

Definition at line 27 of file csvclean_cli.py.

csvclean_cli.csvclean_cli_.__doc__ [private]

Definition at line 28 of file csvclean_cli.py.

csvclean_cli.csvclean_cli_.__globals__ [private]

Definition at line 154 of file csvclean_cli.py.

string csvclean_cli.csvclean_cli_.__name__ [static, private]

Definition at line 19 of file csvclean_cli.py.

csvclean_cli.csvclean_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file csvclean_cli.py.

csvclean_cli.csvclean_cli_.parameters

Definition at line 30 of file csvclean_cli.py.

tuple csvclean_cli.csvclean_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 353 of file csvclean_cli.py.

tuple csvclean_cli.csvclean_cli_.retval [static]

Definition at line 366 of file csvclean_cli.py.

csvclean_cli.csvclean_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file csvclean_cli.py.

string csvclean_cli.csvclean_cli_.valornotval [static]

Definition at line 356 of file csvclean_cli.py.

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

csvclean_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