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

Constructor & Destructor Documentation

def sdimaging_cli.sdimaging_cli_.__init__ ( self )

Definition at line 26 of file sdimaging_cli.py.

Member Function Documentation

def sdimaging_cli.sdimaging_cli_.__call__	(	self,
		infile = `None`,
		specunit = `None`,
		restfreq = `None`,
		scanlist = `None`,
		field = `None`,
		spw = `None`,
		antenna = `None`,
		stokes = `None`,
		gridfunction = `None`,
		convsupport = `None`,
		truncate = `None`,
		gwidth = `None`,
		jwidth = `None`,
		outfile = `None`,
		overwrite = `None`,
		imsize = `None`,
		cell = `None`,
		dochannelmap = `None`,
		nchan = `None`,
		start = `None`,
		step = `None`,
		phasecenter = `None`,
		ephemsrcname = `None`,
		pointingcolumn = `None`,
		async = `None`
	)

SD task: imaging for total power and spectral data
  Keyword arguments:
infile -- name of input SD (MS) dataset
specunit -- units for spectral axis
options: (str) 'channel','km/s','GHz','MHz','kHz','Hz'
default: 'channel'
example: this will be the units for nchan, start, and step
restfreq -- rest frequency
default: '' (refer input data)
example: 1.0e11, '100GHz'
scanlist -- list of scan numbers to process
default: [] (use all scans)
example: [21,22,23,24]
this selection is in addition to field and spw
field -- field id or selection string for selecting scans by name
default: -1 (all fields)
example: 'FLS3a', 0
this selection is in addition to scanlist and spw
spw -- spectral window id
default: 0
example: 1
this selection is in addition to scanlist and field
antenna -- select data based on antenna name(s) or id(s)
default: -1 (all baselines, i.e. all antenna in case of auto data)
example: 0, 'DV01'
stokes -- select data based on stokes or polarization type 
default: '' (use all polarizations)
example: 'XX'
gridfunction -- gridding function for imaging
options: 'BOX' (Box-car), 'SF' (Spheroidal), 
         'PB' (Primary-beam), 'GAUSS' (Gaussian),
         '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'
outfile -- output image name
default: none
example: 'mySDimage.im'
overwrite -- overwrite option for outfile
default: False (not overwrite)
options: True, False
example: if True, existing file will be overwritten
imsize -- x and y image size in pixels, symmetric for single value
default: [256,256]
example: imsize=200 (equivalent to [200,200])
cell -- x and y cell size. default unit arcmin
default: ['1.0arcmin', '1.0arcmin']
example: cell=['0.2arcmin, 0.2arcmin']
         cell='0.2arcmin' (equivalent to example above)
dochannelmap -- channel map image or total power image
default: False (total power)
options: True (channel map), False
    >>> dochannelmap=True expandable parameters
       nchan -- number of spectral channel for created image
   default: 1 
   example: 100
       start -- reference value of start channel (in units of specunit)
   default: 0 (0th channel if specunit='channel')
   example: 100
       step -- width of each spectral channel for created image
   default: 1 (width of 1 channel if specunit='channel')
   example: 100
phasecenter -- image phase center: direction measure or fieldid 
default: 0
example: 'J2000 13h44m00 -17d02m00', 'AZEL -123d48m29 15d41m41'
ephemsrcname -- ephemeris source name for moving source
default: ''
if the source name in the data matches one of the known 
solar objects by the system, this task automatically set 
the source name. 
example: 'moon' 
pointingcolumn -- pointing data column to use
option: 'direction', 'target', 'pointing_offset', 'source_offset', 'encoder' 
default: 'direction'


DESCRIPTION:

Task sdimaging create image from input single-dish data.
The input can be either total power and spectral data. Currently,
this task directly accesses the Measurement Set data only because of 
the data access efficiency. So it differs from other single-dish 
tasks that mostly operate on the ASAP scantable data format.
 
Units of spectral axis can be specified via a parameter specunit.
Allowed values for specunit are 'channel', 'GHz', 'MHz', 'kHz', 'Hz', 
and 'km/s'. This parameter is also used as the units of the parameter 
start and step that specify reference value of start channel and 
width of each spectral channel for channel map, respectively. 
The parameter nchan specifies number of channels for created image. 
If you set nchan as -1, the task selects existing all channels and 
combine those data into one channel to create continuum image.

You can specify field id or name directly. By default, field is set 
to -1 that means the task selects all fields in the data.

Selection of the antennas can be made by setting antennaid(s) or 
antenna name(s) in string (e.g. '0', 'DV01',etc.) or integer 
(e.g. 0). Defalut value, -1, means that the task selects data from 
all baseline, i.e., data from all antenna when data only contains 
auto-correlation.

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). 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).

Definition at line 46 of file sdimaging_cli.py.

def sdimaging_cli.sdimaging_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 450 of file sdimaging_cli.py.

def sdimaging_cli.sdimaging_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 373 of file sdimaging_cli.py.

def sdimaging_cli.sdimaging_cli_.description	(	self,
		key = `'sdimaging'`,
		subkey = `None`
	)

Definition at line 481 of file sdimaging_cli.py.

def sdimaging_cli.sdimaging_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 518 of file sdimaging_cli.py.

References accum_cli.accum_cli_.parameters, sdimaging_cli.sdimaging_cli_.parameters, sdgrid_cli.sdgrid_cli_.parameters, sdflagmanager_cli.sdflagmanager_cli_.parameters, sdflag_cli.sdflag_cli_.parameters, sdfit_cli.sdfit_cli_.parameters, sdcoadd_cli.sdcoadd_cli_.parameters, sdcal_cli.sdcal_cli_.parameters, sdbaseline_cli.sdbaseline_cli_.parameters, rmtables_cli.rmtables_cli_.parameters, applycal_cli.applycal_cli_.parameters, predictcomp_cli.predictcomp_cli_.parameters, polcal_cli.polcal_cli_.parameters, plotxy_cli.plotxy_cli_.parameters, plotweather_cli.plotweather_cli_.parameters, plotuv_cli.plotuv_cli_.parameters, plotms_cli.plotms_cli_.parameters, plotcal_cli.plotcal_cli_.parameters, plotants_cli.plotants_cli_.parameters, peel_cli.peel_cli_.parameters, pclean_cli.pclean_cli_.parameters, partition_cli.partition_cli_.parameters, msview_cli.msview_cli_.parameters, msmoments_cli.msmoments_cli_.parameters, mosaic_cli.mosaic_cli_.parameters, makemask_cli.makemask_cli_.parameters, autoclean_cli.autoclean_cli_.parameters, listsdm_cli.listsdm_cli_.parameters, listpartition_cli.listpartition_cli_.parameters, listobs_cli.listobs_cli_.parameters, listhistory_cli.listhistory_cli_.parameters, listfits_cli.listfits_cli_.parameters, listcal_cli.listcal_cli_.parameters, imview_cli.imview_cli_.parameters, imval_cli.imval_cli_.parameters, imtrans_cli.imtrans_cli_.parameters, imsubimage_cli.imsubimage_cli_.parameters, imstat_cli.imstat_cli_.parameters, imsmooth_cli.imsmooth_cli_.parameters, imregrid_cli.imregrid_cli_.parameters, imreframe_cli.imreframe_cli_.parameters, importvla_cli.importvla_cli_.parameters, importuvfits_cli.importuvfits_cli_.parameters, importgmrt_cli.importgmrt_cli_.parameters, importfitsidi_cli.importfitsidi_cli_.parameters, importfits_cli.importfits_cli_.parameters, importevla_cli.importevla_cli_.parameters, importasdm_cli.importasdm_cli_.parameters, impbcor_cli.impbcor_cli_.parameters, immoments_cli.immoments_cli_.parameters, immath_cli.immath_cli_.parameters, imhead_cli.imhead_cli_.parameters, imfit_cli.imfit_cli_.parameters, imcontsub_cli.imcontsub_cli_.parameters, imcollapse_cli.imcollapse_cli_.parameters, hanningsmooth_cli.hanningsmooth_cli_.parameters, gencal_cli.gencal_cli_.parameters, gaincal_cli.gaincal_cli_.parameters, browsetable_cli.browsetable_cli_.parameters, fluxscale_cli.fluxscale_cli_.parameters, flagmanager_cli.flagmanager_cli_.parameters, flagdata_cli.flagdata_cli_.parameters, flagcmd_cli.flagcmd_cli_.parameters, fixvis_cli.fixvis_cli_.parameters, fixplanets_cli.fixplanets_cli_.parameters, find_cli.find_cli_.parameters, feather_cli.feather_cli_.parameters, exportuvfits_cli.exportuvfits_cli_.parameters, exportfits_cli.exportfits_cli_.parameters, exportasdm_cli.exportasdm_cli_.parameters, delmod_cli.delmod_cli_.parameters, deconvolve_cli.deconvolve_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, ft_cli.ft_cli_.parameters, boxit_cli.boxit_cli_.parameters, blcal_cli.blcal_cli_.parameters, bandpass_cli.bandpass_cli_.parameters, listvis_cli.listvis_cli_.parameters, asdmsummary_cli.asdmsummary_cli_.parameters, and recipes.almahelpers.SpwInfo.parameters.

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(), 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 sdimaging_cli.sdimaging_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 349 of file sdimaging_cli.py.

def sdimaging_cli.sdimaging_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file sdimaging_cli.py.

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

Definition at line 20 of file sdimaging_cli.py.

Referenced by sdimaging_cli.sdimaging_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(), and sdimprocess_cli.sdimprocess_cli_.result().

sdimaging_cli.sdimaging_cli_.__bases__ [private]

Definition at line 27 of file sdimaging_cli.py.

sdimaging_cli.sdimaging_cli_.__doc__ [private]

Definition at line 28 of file sdimaging_cli.py.

sdimaging_cli.sdimaging_cli_.__globals__ [private]

Definition at line 192 of file sdimaging_cli.py.

string sdimaging_cli.sdimaging_cli_.__name__ [static, private]

Definition at line 19 of file sdimaging_cli.py.

sdimaging_cli.sdimaging_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file sdimaging_cli.py.

sdimaging_cli.sdimaging_cli_.parameters

Definition at line 30 of file sdimaging_cli.py.

tuple sdimaging_cli.sdimaging_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 429 of file sdimaging_cli.py.

tuple sdimaging_cli.sdimaging_cli_.retval [static]

Definition at line 442 of file sdimaging_cli.py.

sdimaging_cli.sdimaging_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file sdimaging_cli.py.

string sdimaging_cli.sdimaging_cli_.valornotval [static]

Definition at line 432 of file sdimaging_cli.py.

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

sdimaging_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