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

Constructor & Destructor Documentation

def sdgrid_cli.sdgrid_cli_.__init__ ( self )

Definition at line 26 of file sdgrid_cli.py.

Member Function Documentation

def sdgrid_cli.sdgrid_cli_.__call__	(	self,
		infiles = `None`,
		antenna = `None`,
		scanlist = `None`,
		ifno = `None`,
		pollist = `None`,
		gridfunction = `None`,
		convsupport = `None`,
		truncate = `None`,
		gwidth = `None`,
		jwidth = `None`,
		weight = `None`,
		clipminmax = `None`,
		outfile = `None`,
		overwrite = `None`,
		npix = `None`,
		cell = `None`,
		center = `None`,
		plot = `None`,
		async = `None`
	)

SD task: gridding single dish data
  Keyword arguments:
infiles -- name of input SD dataset. can be list.
example: 'testimage.asap' 
         ['testimage1.asap','testimage2.asap']
antenna -- select data based on antenna name(s) or id(s)
default: -1
example: 0, 'DV01'
scanlist -- list of scan numbers to process
default: [] (use all scans)
example: [21,22,23,24]
ifno -- IFNO to be gridded
default: -1 (only process IFNO in the first row)
example: 1
pollist -- POLNO to be gridded
default: [] (all polarizations)
example: 1,[0,1]
gridfunction -- gridding function 
options: 'BOX' (Box-car), 'SF' (Spheroidal), 
         'GAUSS' (Gaussian), 'PB' (Primary-beam)
         'GJINC' (Gaussian*Jinc)
default: 'BOX'
example: 'SF'
    >>> gridfunction expandable parameter:
       convsupport -- convolution support for 'SF' 
   default: -1 (use default for each gridfunction)
   example: 3
       truncate -- truncattion radius of convolution kernel.
           effective only for 'GAUSS' and 'GJINC'.
   default: '-1' (use default for each gridfunction)
   example: 3, '20arcsec', '3pixel'
       gwidth -- HWHM for gaussian. Effective only for 
         'GAUSS' and 'GJINC'.
   default: '-1' (use default for each gridfunction)
   example: 3, '20arcsec', '3pixel'
       jwidth -- Width of jinc function. Effective only for 
         'GJINC'.
   default: '-1' (use default for each gridfunction)
   example: 3, '20arcsec', '3pixel'
weight -- weight type (both lower-case and upper-case are 
  acceptable)
options: 'UNIFORM',
         'TSYS'  (1/Tsys**2 weighted)
         'TINT'  (integration time weighted)
         'TINTSYS'  (Tint/Tsys**2)
default: 'UNIFORM'
clipminmax -- do min/max cliping if True
default: False
outfile -- output data name
default: '' (outfile will be set to infile+'.grid')
example: 'mydata.asap.grid'
overwrite -- overwrite option for outfile
default: False (not overwrite)
options: True, False
example: if True, existing file will be overwritten
npix -- x and y image size in pixels, symmetric for single value
default: -1 (automatically calculated from cell size and 
             the data)
example: npix=200 (equivalent to [200,200])
cell -- x and y cell size. default unit arcsec
default: '' (automatically calculated from npix if it is 
             set, otherwise '1.0arcmin')
example: cell=['0.2arcmin, 0.2arcmin']
         cell='0.2arcmin' (equivalent to example above)
         cell=12.0 (interpreted as '12.0arcsec'='0.2arcmin')
center -- grid center
default: '' (automatically calculated from the data)
example: 'J2000 13h44m00 -17d02m00'
         ['05:34:48.2', '-05.22.17.7'] (in J2000 frame)
         [1.46, -0.09] (interpreted as radian in J2000 frame)
plot -- Plot result or not
default: False (not plot)
example: if True, result will be plotted

DESCRIPTION:

The sdgrid task performs spatial gridding according to the user 
specification of spatial grid, convolution function, etc.

For grid configuration, the task supplements necessary information 
by referring input data if any of gridding parameter ('npix', 
'cell', or 'center') is not specified by the user. If 'center' is 
default value (empty string), central position of the grid will be 
set to the center of observed area, i.e. x=0.5*(xmax+xmin), 
y=0.5*(ymax+ymin). If either 'cell' or 'npix' is set, unspecified 
one will be calculated from the others. In that case, total extent of 
the grid will be set to cover all observed position. If neither 'cell' 
nor 'npix' is set, cell size will be set to 1.0 arcmin and number of 
pixel will be calculated based on that cell size.
 
Currently, only J2000 frame is supported.
 
The parameter gridfunction sets gridding function for imaging. 
Currently, the task supports 'BOX' (Box-car), 'SF' (Prolate 
Spheroidal Wave Function), 'GAUSS' (Gaussian), 'GJINC' (Gaussian*
Jinc), where Jinc(x) = J_1(pi*x/c)/(pi*x/c) with a first order 
Bessel function J_1, and 'PB' (Primary Beam, not implemented yet). 
For 'PB', correct antenna informations should be included in input 
file. 

There are four subparameters for gridfunction: convsupport, truncate, 
gwidth, and jwidth. The convsupport is an integer specifying cut-off 
radius for 'SF' in units of pixel. By default (convsupport=-1), 
the cut-off radius is set to 3 pixels. The truncate is a cut-off 
radius for 'GAUSS' or 'GJINC'. It accepts integer, float, and 
string values of numeric plus unit. Allowed units are angular 
units such as 'deg', 'arcmin', 'arcsec', and 'pixel'. Default unit 
is 'pixel' so that string without unit or numerical values (integer 
or float) will be interpreted as radius in pixel. Default value 
for truncate, which is used when negative radius is set, is 3*HWHM 
for 'GAUSS' and radius at first null for 'GJINC'. The gwidth is 
the HWHM of gaussian for 'GAUSS' and 'GJINC'. Default value is 
sqrt(log(2)) pixel for 'GAUSS' and 2.52*sqrt(log(2)) pixel for 
'GJINC'. The jwidth specifies width of the jinc function (parameter 
'c' in the definition above). Default is 1.55 pixel. Both gwidth 
jwidth allows integer, float, or string of numeric plus unit. 
Default values for gwidth and jwidth are taken from Mangum et al. 
(2007).

Boolean parameter 'plot' controls whether gridded result is plotted 
or not. If True, color map of gridded data will be shown. Pixel 
center and observed position are overlayed as blue dot and red dot, 
respectively. Currently, channel averaged value will be plotted.

Definition at line 46 of file sdgrid_cli.py.

def sdgrid_cli.sdgrid_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 408 of file sdgrid_cli.py.

def sdgrid_cli.sdgrid_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 337 of file sdgrid_cli.py.

def sdgrid_cli.sdgrid_cli_.description	(	self,
		key = `'sdgrid'`,
		subkey = `None`
	)

Definition at line 439 of file sdgrid_cli.py.

def sdgrid_cli.sdgrid_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 470 of file sdgrid_cli.py.

Referenced by uvsub_cli.uvsub_cli_.defaults(), uvcontsub2_cli.uvcontsub2_cli_.defaults(), smoothcal_cli.smoothcal_cli_.defaults(), tclean_cli.tclean_cli_.defaults(), splattotable_cli.splattotable_cli_.defaults(), testconcat_cli.testconcat_cli_.defaults(), sdlist_cli.sdlist_cli_.defaults(), viewer_cli.viewer_cli_.defaults(), sdscale_cli.sdscale_cli_.defaults(), slsearch_cli.slsearch_cli_.defaults(), wvrgcal_cli.wvrgcal_cli_.defaults(), uvcontsub_cli.uvcontsub_cli_.defaults(), ssoflux_cli.ssoflux_cli_.defaults(), vishead_cli.vishead_cli_.defaults(), uvcontsub3_cli.uvcontsub3_cli_.defaults(), sdimprocess_cli.sdimprocess_cli_.defaults(), virtualconcat_cli.virtualconcat_cli_.defaults(), sdsmooth_cli.sdsmooth_cli_.defaults(), visstat_cli.visstat_cli_.defaults(), widebandpbcor_cli.widebandpbcor_cli_.defaults(), uvmodelfit_cli.uvmodelfit_cli_.defaults(), sdsave_cli.sdsave_cli_.defaults(), simanalyze_cli.simanalyze_cli_.defaults(), sdmath_cli.sdmath_cli_.defaults(), sdgrid_cli.sdgrid_cli_.defaults(), sdtpimaging_cli.sdtpimaging_cli_.defaults(), sdstat_cli.sdstat_cli_.defaults(), split_cli.split_cli_.defaults(), sdimaging_cli.sdimaging_cli_.defaults(), statwt_cli.statwt_cli_.defaults(), simalma_cli.simalma_cli_.defaults(), simobserve_cli.simobserve_cli_.defaults(), setjy_cli.setjy_cli_.defaults(), widefield_cli.widefield_cli_.defaults(), specfit_cli.specfit_cli_.defaults(), and sdreduce_cli.sdreduce_cli_.defaults().

def sdgrid_cli.sdgrid_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 313 of file sdgrid_cli.py.

def sdgrid_cli.sdgrid_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file sdgrid_cli.py.

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

Definition at line 20 of file sdgrid_cli.py.

Referenced by sdgrid_cli.sdgrid_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(), and sdimaging_cli.sdimaging_cli_.result().

sdgrid_cli.sdgrid_cli_.__bases__ [private]

Definition at line 27 of file sdgrid_cli.py.

sdgrid_cli.sdgrid_cli_.__doc__ [private]

Definition at line 28 of file sdgrid_cli.py.

sdgrid_cli.sdgrid_cli_.__globals__ [private]

Definition at line 173 of file sdgrid_cli.py.

string sdgrid_cli.sdgrid_cli_.__name__ [static, private]

Definition at line 19 of file sdgrid_cli.py.

sdgrid_cli.sdgrid_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file sdgrid_cli.py.

sdgrid_cli.sdgrid_cli_.parameters

Definition at line 30 of file sdgrid_cli.py.

tuple sdgrid_cli.sdgrid_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 387 of file sdgrid_cli.py.

tuple sdgrid_cli.sdgrid_cli_.retval [static]

Definition at line 400 of file sdgrid_cli.py.

sdgrid_cli.sdgrid_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file sdgrid_cli.py.

string sdgrid_cli.sdgrid_cli_.valornotval [static]

Definition at line 390 of file sdgrid_cli.py.

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

sdgrid_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