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

Constructor & Destructor Documentation

def sdcoadd_cli.sdcoadd_cli_.__init__ ( self )

Definition at line 26 of file sdcoadd_cli.py.

Member Function Documentation

def sdcoadd_cli.sdcoadd_cli_.__call__	(	self,
		infiles = `None`,
		antenna = `None`,
		fluxunit = `None`,
		telescopeparm = `None`,
		specunit = `None`,
		frame = `None`,
		doppler = `None`,
		scanaverage = `None`,
		timeaverage = `None`,
		tweight = `None`,
		polaverage = `None`,
		pweight = `None`,
		outfile = `None`,
		outform = `None`,
		overwrite = `None`,
		async = `None`
	)

ASAP SD task: coadd multiple scantables into one
  Keyword arguments:
infiles -- list of names of input SD dataset
antenna -- antenna name or id (only effective for MS input). 
fluxunit -- units for line flux
options: 'K','Jy',''
default: '' (keep current fluxunit of the first data in the infiles)

    >>> 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)
example: this will be the units for masklist
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
scanaverage -- average integrations within scans
options: (bool) True,False
default: False
example: if True, this happens in read-in
For GBT, set False!
timeaverage -- average times for multiple scan cycles
options: (bool) True,False
default: False
example: if True, this happens after calibration

    >>>timeaverage expandable parameter
 tweight -- weighting for time average
         options: 'none' 
                  'var'   (1/var(spec) weighted)
                  'tsys'  (1/Tsys**2 weighted)
                  'tint'  (integration time weighted)
                  'tintsys'  (Tint/Tsys**2)
                  'median'  ( median averaging)
         default: 'none'

polaverage -- average polarizations
options: (bool) True,False
default: False

    >>>polaverage expandable parameter
 pweight -- weighting for polarization average
         options: 'none'
                  'var'  (1/var(spec) weighted)
                  'tsys' (1/Tsys**2 weighted)
         default: 'none'

outfile -- Name of output file
default: '' (scantable)
example:
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 



DESCRIPTION:

Task sdcoadd performs co-add multiple single dish spectral data given by
a list of spectral data file names in any of the following formats,
ASAP, MS2,SDFITS, and ASCII.
The units of line flux, the units of spectral axis, frame, and doppler
are assumed to be those of the first one in the infiles if not
specified.
timaverage and polaverage are used to perform time
and polarization averaging over scans on the co-added scantable before
saving to a file on disk.

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

def sdcoadd_cli.sdcoadd_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 379 of file sdcoadd_cli.py.

def sdcoadd_cli.sdcoadd_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 309 of file sdcoadd_cli.py.

def sdcoadd_cli.sdcoadd_cli_.description	(	self,
		key = `'sdcoadd'`,
		subkey = `None`
	)

Definition at line 410 of file sdcoadd_cli.py.

def sdcoadd_cli.sdcoadd_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 438 of file sdcoadd_cli.py.

def sdcoadd_cli.sdcoadd_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 285 of file sdcoadd_cli.py.

def sdcoadd_cli.sdcoadd_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file sdcoadd_cli.py.

Member Data Documentation

dictionary sdcoadd_cli.sdcoadd_cli_.__async__ [static, private]

Definition at line 20 of file sdcoadd_cli.py.

Referenced by sdcoadd_cli.sdcoadd_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(), and sdfit_cli.sdfit_cli_.result().

sdcoadd_cli.sdcoadd_cli_.__bases__ [private]

Definition at line 27 of file sdcoadd_cli.py.

sdcoadd_cli.sdcoadd_cli_.__doc__ [private]

Definition at line 28 of file sdcoadd_cli.py.

sdcoadd_cli.sdcoadd_cli_.__globals__ [private]

Definition at line 151 of file sdcoadd_cli.py.

string sdcoadd_cli.sdcoadd_cli_.__name__ [static, private]

Definition at line 19 of file sdcoadd_cli.py.

sdcoadd_cli.sdcoadd_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file sdcoadd_cli.py.

sdcoadd_cli.sdcoadd_cli_.parameters

Definition at line 30 of file sdcoadd_cli.py.

tuple sdcoadd_cli.sdcoadd_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 358 of file sdcoadd_cli.py.

tuple sdcoadd_cli.sdcoadd_cli_.retval [static]

Definition at line 371 of file sdcoadd_cli.py.

sdcoadd_cli.sdcoadd_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file sdcoadd_cli.py.

string sdcoadd_cli.sdcoadd_cli_.valornotval [static]

Definition at line 361 of file sdcoadd_cli.py.

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

sdcoadd_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