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

Constructor & Destructor Documentation

def sdstat_cli.sdstat_cli_.__init__ ( self )

Definition at line 26 of file sdstat_cli.py.

Member Function Documentation

def sdstat_cli.sdstat_cli_.__call__	(	self,
		infile = `None`,
		antenna = `None`,
		fluxunit = `None`,
		telescopeparm = `None`,
		specunit = `None`,
		restfreq = `None`,
		frame = `None`,
		doppler = `None`,
		scanlist = `None`,
		field = `None`,
		iflist = `None`,
		pollist = `None`,
		masklist = `None`,
		invertmask = `None`,
		interactive = `None`,
		outfile = `None`,
		format = `None`,
		overwrite = `None`,
		async = `None`
	)

ASAP SD task: list statistics of spectral region
Keyword arguments:
infile -- name of input SD dataset
default: none - must input file name
example: 'mysd.asap'
         See sdcal for allowed formats.
antenna -- antenna name or id (only effective for MS input). 
fluxunit -- units for line flux
options: (str) 'K','Jy',''
default: '' (keep current fluxunit)
WARNING: For GBT data, see description below.
    >>> fluxunit expandable parameter
 telescopeparm -- the telescope characteristics
        options: (str) name or (list) list of gain info
        default: '' (none set)
        example: if telescopeparm='', it tries to get the telescope
                 name from the data.
                 Full antenna parameters (diameter,ap.eff.) known
                 to ASAP are
                 'ATPKSMB', 'ATPKSHOH', 'ATMOPRA', 'DSS-43',
                 'CEDUNA','HOBART'. For GBT, it fixes default fluxunit
                 to 'K' first then convert to a new fluxunit.
                 telescopeparm=[104.9,0.43] diameter(m), ap.eff.
                 telescopeparm=[0.743] gain in Jy/K
                 telescopeparm='FIX' to change default fluxunit
                 see description below

specunit -- units for spectral axis
options: (str) 'channel','km/s','GHz','MHz','kHz','Hz',''
default: '' (=current)
    >>> specunit expandable parameter
 restfreq -- rest frequency
         default: '' (use current setting)
         example: 4.6e10 (float value in Hz),
                  '46GHz' (string with unit),
                  ['345.8GHz', 347.0e9, 356.7e9] (for each IF)
                  [{'name':'CO','value':345e9}] (a value with name)
frame -- frequency frame for spectral axis
options: (str) 'LSRK','REST','TOPO','LSRD','BARY',
         'GEO','GALACTO','LGROUP','CMB'
default: currently set frame in scantable
WARNING: frame='REST' not yet implemented
doppler -- doppler mode
options: (str) 'RADIO','OPTICAL','Z','BETA','GAMMA'
default: currently set doppler in scantable
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, and pollist
iflist -- list of IF id numbers to select
default: [] (use all IFs)
example: [15]
this selection is in addition to field, scanlist, and pollist
pollist -- list of polarization id numbers to select
default: [] (use all pols)
example: [1]
this selection is in addition to field, scanlist, and iflist
masklist -- list of mask regions to INCLUDE in stats
default: [] (whole spectrum)
example: [4000,4500] for one region
         [[1000,3000],[5000,7000]]
         these must be pairs of [lo,hi] boundaries
invertmask -- invert mask (EXCLUDE masklist instead)
options: (bool) True,False
default: false
interactive -- determines interactive masking
options: (bool) True,False
default: False
example: interactive=True allows adding and deleting mask 
         regions by drawing rectangles on the plot with mouse. 
         Draw a rectangle with LEFT-mouse to ADD the region to 
         the mask and with RIGHT-mouse to DELETE the region. 
outfile -- name of output file for line statistics
default: '' (no output statistics file)
example: 'stat.txt'
format -- format string to print statistic values
default: '3.3f'
overwrite -- overwrite the statistics file if already exists 
options: (bool) True,False
default: False

-------------------------------------------------------------------
Returns: a Python dictionary of line statistics
   keys: 'rms','stddev','max','min','max_abscissa',
         'min_abscissa','sum','median','mean','totint','eqw'
example: xstat=sdstat(); print "rms = ",xstat['rms']
         these can be used for testing in scripts or
         for regression

         'max_abscissa' and 'min_abscissa' refer to the abscissa
         (channel/frequency/velocity) of max and min intensity.
         'totint' is the integrated intensity (sum*dx)
         where dx is the abscissa interval in 'specunit'.
         'eqw' is equivalent width (totint/mag) where mag
         is either max or min depending on which has
         greater magnitude. 
         Note that 'max_abscissa', 'min_abscissa', 'totint' 
         and 'eqw' are quantities (python dictionaries with
         keys, 'unit' and 'value').


       DESCRIPTION:

Task sdstat computes basic statistics (rms,mean,median,sum)
for single-dish spectra.  It assumes that the spectra have
been calibrated.  Furthermore, it assumes that any
time and channel averaging/smoothing has also already been done as
there are no controls for these. 

Note that multiple scans and IFs can in principle be handled, but
we recommend that you use scanlist, field, iflist, and pollist to give 
a single selection for each run.

WARNING: If you do have multiple scantable rows, then the returning 
values will be lists.

ASAP recognizes the data of the "AT" telescopes, but currently
does not know about the GBT or any other telescope. This task
does know about GBT. Telescope name is obtained from the data.
If you wish to change the fluxunit (see below), and telescopeparm='',
for the AT telescopes it will use internal telescope parameters for
flux conversion. For GBT, it will use an approximate aperture
efficiency conversion.  If you give telescopeparm a list, then
if the list has a single float it is assumed to be the gain in Jy/K,
if two or more elements they are assumed to be telescope diameter (m)
and aperture efficiency respectively.

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

def sdstat_cli.sdstat_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 429 of file sdstat_cli.py.

def sdstat_cli.sdstat_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 353 of file sdstat_cli.py.

def sdstat_cli.sdstat_cli_.description	(	self,
		key = `'sdstat'`,
		subkey = `None`
	)

Definition at line 460 of file sdstat_cli.py.

def sdstat_cli.sdstat_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 491 of file sdstat_cli.py.

References accum_cli.accum_cli_.parameters, sdstat_cli.sdstat_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(), 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 sdstat_cli.sdstat_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 329 of file sdstat_cli.py.

def sdstat_cli.sdstat_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file sdstat_cli.py.

References accum_cli.accum_cli_.__async__, sdstat_cli.sdstat_cli_.__async__, sdsmooth_cli.sdsmooth_cli_.__async__, sdscale_cli.sdscale_cli_.__async__, sdsave_cli.sdsave_cli_.__async__, sdreduce_cli.sdreduce_cli_.__async__, sdplot_cli.sdplot_cli_.__async__, sdmath_cli.sdmath_cli_.__async__, sdlist_cli.sdlist_cli_.__async__, sdimprocess_cli.sdimprocess_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 sdstat_cli.sdstat_cli_.__async__ [static, private]

Definition at line 20 of file sdstat_cli.py.

Referenced by sdstat_cli.sdstat_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(), and sdtpimaging_cli.sdtpimaging_cli_.result().

sdstat_cli.sdstat_cli_.__bases__ [private]

Definition at line 27 of file sdstat_cli.py.

sdstat_cli.sdstat_cli_.__doc__ [private]

Definition at line 28 of file sdstat_cli.py.

sdstat_cli.sdstat_cli_.__globals__ [private]

Definition at line 186 of file sdstat_cli.py.

string sdstat_cli.sdstat_cli_.__name__ [static, private]

Definition at line 19 of file sdstat_cli.py.

sdstat_cli.sdstat_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file sdstat_cli.py.

sdstat_cli.sdstat_cli_.parameters

Definition at line 30 of file sdstat_cli.py.

tuple sdstat_cli.sdstat_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 408 of file sdstat_cli.py.

tuple sdstat_cli.sdstat_cli_.retval [static]

Definition at line 421 of file sdstat_cli.py.

sdstat_cli.sdstat_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file sdstat_cli.py.

string sdstat_cli.sdstat_cli_.valornotval [static]

Definition at line 411 of file sdstat_cli.py.

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

sdstat_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