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

Constructor & Destructor Documentation

def sdsmooth_cli.sdsmooth_cli_.__init__ ( self )

Definition at line 26 of file sdsmooth_cli.py.

Member Function Documentation

def sdsmooth_cli.sdsmooth_cli_.__call__	(	self,
		infile = `None`,
		antenna = `None`,
		scanaverage = `None`,
		scanlist = `None`,
		field = `None`,
		iflist = `None`,
		pollist = `None`,
		kernel = `None`,
		kwidth = `None`,
		chanwidth = `None`,
		verify = `None`,
		outfile = `None`,
		outform = `None`,
		overwrite = `None`,
		plotlevel = `None`,
		async = `None`
	)

ASAP SD task: do smoothing of spectra

Keyword arguments:
infile -- name of input SD dataset
antenna -- antenna name or id (only effective for MS input). 
scanaverage -- average integrations within scans
options: (bool) True,False
default: False
example: if True, this happens in read-in
         For GBT, set False!
scanlist -- list of scan numbers to process
default: [] (use all scans)
example: [21,22,23,24]
this selection is in addition to field, iflist, and pollist
field -- selection string for selecting scans by name
default: '' (no name selection)
example: 'FLS3a*'
this selection is in addition to scanlist, iflist,pollist
iflist -- list of IF id numbers to select
default: [] (use all IFs)
example: [15]
this selection is in addition to scanlist, field, and pollist
pollist -- list of polarization id numbers to select
default: [] (use all polarizations)
example: [1]
this selection is in addition to scanlist, field, and iflist
kernel -- type of spectral smoothing
options: 'hanning','gaussian','boxcar','regrid'
default: 'hanning'

    >>>kernel expandable parameter
 kwidth -- width of spectral smoothing kernel
         options: (int) in channels 
         default: 5
         example: 5 or 10 seem to be popular for boxcar
                  ignored for hanning (fixed at 5 chans)
                  (0 will turn off gaussian or boxcar)
 chanwidth -- channel width of regridded spectra
         default: '5' (in channels)
         example: '500MHz', '0.2km/s'

verify -- verify the results of smoothing
options: (bool) True,False
default: False
WARNING: Currently this just asks whether you accept
         the displayed smoothing and if not, continues
         without smoothing.
Note: verification is not yet available for kernel='regrid'
outfile -- Name of output ASAP format(scantable) file
default: '' (<infile>_sm)
outform -- format of output file
options: 'ASCII','SDFITS','MS','ASAP'
default: 'ASAP'
example: the ASAP format is easiest for further sd
         processing; use MS for CASA imaging.
         If ASCII, then will append some stuff to
         the outfile name
overwrite -- overwrite the output file if already exists
options: (bool) True,False
default: False
WARNING: if outform='ASCII', this parameter is ignored
plotlevel -- control for plotting of results
options: (int) 0=none, 1=some, 2=more, <0=hardcopy
default: 0 (no plotting)
example: plotlevel<0 as abs(plotlevel), e.g.
         -1 => hardcopy of final plot (will be named
         <outfile>_smspec.eps)


DESCRIPTION:

Task sdsmooth performs smoothing of the single-dish spectra.
Set plotlevel >= 1 to plot spectrum before and after smoothing.

WARNING for the GBT raw SDFITS format data as input:
SDtasks are able to handle GBT raw SDFITS format data since the 
data filler is available. However, the functionality is not well 
tested yet, so that there may be unknown bugs.

Definition at line 46 of file sdsmooth_cli.py.

def sdsmooth_cli.sdsmooth_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 353 of file sdsmooth_cli.py.

def sdsmooth_cli.sdsmooth_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 289 of file sdsmooth_cli.py.

def sdsmooth_cli.sdsmooth_cli_.description	(	self,
		key = `'sdsmooth'`,
		subkey = `None`
	)

Definition at line 384 of file sdsmooth_cli.py.

def sdsmooth_cli.sdsmooth_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 412 of file sdsmooth_cli.py.

References accum_cli.accum_cli_.parameters, sdsmooth_cli.sdsmooth_cli_.parameters, sdscale_cli.sdscale_cli_.parameters, sdsave_cli.sdsave_cli_.parameters, sdreduce_cli.sdreduce_cli_.parameters, sdplot_cli.sdplot_cli_.parameters, sdmath_cli.sdmath_cli_.parameters, sdlist_cli.sdlist_cli_.parameters, sdimprocess_cli.sdimprocess_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(), viewer_cli.viewer_cli_.defaults(), slsearch_cli.slsearch_cli_.defaults(), uvcontsub_cli.uvcontsub_cli_.defaults(), wvrgcal_cli.wvrgcal_cli_.defaults(), ssoflux_cli.ssoflux_cli_.defaults(), vishead_cli.vishead_cli_.defaults(), uvcontsub3_cli.uvcontsub3_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(), simanalyze_cli.simanalyze_cli_.defaults(), sdtpimaging_cli.sdtpimaging_cli_.defaults(), sdstat_cli.sdstat_cli_.defaults(), split_cli.split_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(), and specfit_cli.specfit_cli_.defaults().

def sdsmooth_cli.sdsmooth_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 265 of file sdsmooth_cli.py.

def sdsmooth_cli.sdsmooth_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file sdsmooth_cli.py.

Member Data Documentation

dictionary sdsmooth_cli.sdsmooth_cli_.__async__ [static, private]

Definition at line 20 of file sdsmooth_cli.py.

Referenced by sdsmooth_cli.sdsmooth_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(), and sdstat_cli.sdstat_cli_.result().

sdsmooth_cli.sdsmooth_cli_.__bases__ [private]

Definition at line 27 of file sdsmooth_cli.py.

sdsmooth_cli.sdsmooth_cli_.__doc__ [private]

Definition at line 28 of file sdsmooth_cli.py.

sdsmooth_cli.sdsmooth_cli_.__globals__ [private]

Definition at line 129 of file sdsmooth_cli.py.

string sdsmooth_cli.sdsmooth_cli_.__name__ [static, private]

Definition at line 19 of file sdsmooth_cli.py.

sdsmooth_cli.sdsmooth_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file sdsmooth_cli.py.

sdsmooth_cli.sdsmooth_cli_.parameters

Definition at line 30 of file sdsmooth_cli.py.

tuple sdsmooth_cli.sdsmooth_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 332 of file sdsmooth_cli.py.

tuple sdsmooth_cli.sdsmooth_cli_.retval [static]

Definition at line 345 of file sdsmooth_cli.py.

sdsmooth_cli.sdsmooth_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file sdsmooth_cli.py.

string sdsmooth_cli.sdsmooth_cli_.valornotval [static]

Definition at line 335 of file sdsmooth_cli.py.

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

sdsmooth_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