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

Constructor & Destructor Documentation

def sdsave_cli.sdsave_cli_.__init__ ( self )

Definition at line 26 of file sdsave_cli.py.

Member Function Documentation

def sdsave_cli.sdsave_cli_.__call__	(	self,
		infile = `None`,
		antenna = `None`,
		getpt = `None`,
		rowlist = `None`,
		scanlist = `None`,
		field = `None`,
		iflist = `None`,
		pollist = `None`,
		scanaverage = `None`,
		timeaverage = `None`,
		tweight = `None`,
		polaverage = `None`,
		pweight = `None`,
		restfreq = `None`,
		outfile = `None`,
		outform = `None`,
		overwrite = `None`,
		async = `None`
	)

ASAP SD task: save the sd spectra in various format
  Keyword arguments:
infile -- name of input SD dataset
antenna -- antenna name or id (only effective for MS input). 
getpt -- fill DIRECTION column properly, or reuse POINTING table 
 in original MS (only effective for MS input)
 default: True
 options: True (fill DIRECTION column properly)
          False (reuse POINTING table in original MS)
rowlist -- list of row numbers to process
default: [] (use all rows)
example: [0,2,4,6]
For expert users only!
this selection is applied first, and then followed by
the selection with scans, fields, ifs, and polarizations. 
scanlist -- list of 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 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
scanaverage --  average integrations within scans
options: (bool) True,False
default: False
example: if True, average integrations before it is saved
timeaverage -- average times for multiple scan cycles
options: (bool) True,False
default: False
>>>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)
restfreq -- rest frequencies of output data
Available types are a number, string, a list of numbers or
strings (see examples below), and list of dictionaries. 
The default unit of restfreq is Hz, if not specified.
A list can be used to set different rest frequencies to
each IF. the length of list input must be nIF. Dictionary 
input should be a pair of molecule name and frequency with 
keys of 'name' and 'value', respectively. The 'value's in the 
dictionary input follows the same manner as for single 
float or string input. 
default: '' (use current setting)
example: 4.6e10 (float value in Hz),
         '46GHz' (string with unit),
         ['345.8GHz', '347.0GHz', 356.7e9] (for each IF)
         [{'name':'CO','value':345e9}] (a value with name)
outfile -- name of output dataset
default: '' 
outform -- output data format
default: 'ASAP'
Options: 'ASAP', 'MS2', 'SDFITS', 'ASCII'
overwrite -- overwrite the output file if already exists
options: (bool) True,False
default: False
WARNING: if outform='ASCII', this parameter is ignored


DESCRIPTION:

Task sdsave writes the single dish data to a disk file in 
specified format (ASAP, MS2, SDFITS, ASCII). It is possible to 
save the subset of the data by selecting row numbers, scan numbers, 
IF ids, polarization ids and field names. The ASAP (scantable) format 
is recommended for further analysis using Sd tool. For further 
imaging using imager, save the data to the Measurement Set (MS2).

Note that setting getpt=False needs a lot of attention.
If you set getpt=False, the task retrieves pointing direction from 
MS's FIELD table, which might not be correct for single dish 
observation, instead to check MS's POINTING table, which is the 
default behavior of the task (getpt=True). To compensate this, 
absolute path to MS's POINTING table is stored, and it will be used 
for POINTING table when the data is converted back to MS format. 
In general, getpt=False is faster especially for large data. However, 
MS created from Scantable cannot have correct POINTING table if 
original MS's POINTING table doesn't exist. Such situation will 
happen when original MS is removed or renamed, or imported Scantable 
is moved to other computer alone.

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

def sdsave_cli.sdsave_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 391 of file sdsave_cli.py.

def sdsave_cli.sdsave_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 324 of file sdsave_cli.py.

def sdsave_cli.sdsave_cli_.description	(	self,
		key = `'sdsave'`,
		subkey = `None`
	)

Definition at line 422 of file sdsave_cli.py.

def sdsave_cli.sdsave_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 452 of file sdsave_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(), viewer_cli.viewer_cli_.defaults(), sdscale_cli.sdscale_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(), sdsave_cli.sdsave_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 sdsave_cli.sdsave_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 300 of file sdsave_cli.py.

def sdsave_cli.sdsave_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file sdsave_cli.py.

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

Definition at line 20 of file sdsave_cli.py.

Referenced by sdsave_cli.sdsave_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(), and sdscale_cli.sdscale_cli_.result().

sdsave_cli.sdsave_cli_.__bases__ [private]

Definition at line 27 of file sdsave_cli.py.

sdsave_cli.sdsave_cli_.__doc__ [private]

Definition at line 28 of file sdsave_cli.py.

sdsave_cli.sdsave_cli_.__globals__ [private]

Definition at line 159 of file sdsave_cli.py.

string sdsave_cli.sdsave_cli_.__name__ [static, private]

Definition at line 19 of file sdsave_cli.py.

sdsave_cli.sdsave_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file sdsave_cli.py.

sdsave_cli.sdsave_cli_.parameters

tuple sdsave_cli.sdsave_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 370 of file sdsave_cli.py.

tuple sdsave_cli.sdsave_cli_.retval [static]

Definition at line 383 of file sdsave_cli.py.

sdsave_cli.sdsave_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file sdsave_cli.py.

string sdsave_cli.sdsave_cli_.valornotval [static]

Definition at line 373 of file sdsave_cli.py.

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

sdsave_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