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

Constructor & Destructor Documentation

def sdcal_cli.sdcal_cli_.__init__ ( self )

Definition at line 26 of file sdcal_cli.py.

Member Function Documentation

def sdcal_cli.sdcal_cli_.__call__	(	self,
		infile = `None`,
		antenna = `None`,
		fluxunit = `None`,
		telescopeparm = `None`,
		specunit = `None`,
		frame = `None`,
		doppler = `None`,
		calmode = `None`,
		fraction = `None`,
		noff = `None`,
		width = `None`,
		elongated = `None`,
		markonly = `None`,
		plotpointings = `None`,
		scanlist = `None`,
		field = `None`,
		iflist = `None`,
		pollist = `None`,
		channelrange = `None`,
		scanaverage = `None`,
		timeaverage = `None`,
		tweight = `None`,
		averageall = `None`,
		polaverage = `None`,
		pweight = `None`,
		tau = `None`,
		verify = `None`,
		outfile = `None`,
		outform = `None`,
		overwrite = `None`,
		plotlevel = `None`,
		async = `None`
	)

ASAP SD task: do data selection, calibration, and averaging
  Keyword arguments:
infile -- name 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)
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)
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
calmode -- calibration mode
options: 'ps','nod','otf','otfraster',
         'fs','fsotf','quotient','none'
default: 'none'
example: choose mode 'none' if you have
         already calibrated and want to
         try averaging
WARNING: 'fsotf' is not implemented yet
    >>> calmode expandable parameter
 fraction -- Edge marking parameter for 'otf' and 'otfraster'.
             specify a number of OFF scans as a fraction of 
             total number of data points. 
         default: '10%'
         options: '20%' in string style or float value less 
                  than 1.0 (e.g. 0.15).
                  'auto' is available only for 'otfraster'. 
 noff -- Edge marking parameter for 'otfraster'.
         It is used to specify a number of OFF scans near 
         edge directly. Value of noff comes before setting 
         by fraction.
         default: -1 (use fraction)
         options: any positive integer
 width -- Edge marking parameter for 'otf'.
          Pixel width with respect to a median spatial 
          separation between neighboring two data in time.
          Default will be fine in most cases.
         default: 0.5
         options: float value
 elongated -- Edge marking parameter for 'otf'.
              Set True only if observed area is elongeted 
              in one direction.
         default: False
 markonly -- Set True if you want to save data just after 
             edge marking (i.e. uncalibrated data) to see 
             how OFF scans are defined.
         default: 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, 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
channelrange -- channel range selection
default: [] (use all channel)
example: [0,5000]
Note that specified values are recognized as 'channel'
regardless of the value of specunit 
scanaverage -- average integrations within scans
options: (bool) True,False
default: 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'

 averageall -- average multi-resolution spectra
               spectra are averaged by referring 
               their frequency coverage
         default: False

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'

tau -- atmospheric optical depth
default: 0.0 (no correction)
verify -- verify the results of calibration. Only effective if 
  calmode is not 'none'.
options: (bool) True,False
default: False
WARNING: Currently this just asks whether you accept
         the displayed calibration and if not, continues
         without doing any calibration. 
outfile -- Name of output file
default: '' (<infile>_cal)
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>_calspec.eps)
WARNING: be careful plotting in fsotf mode!


DESCRIPTION:

Task sdcal performs data selection, calibration for single-dish
spectra.  By setting calmode='none', one can run sdcal on already 
calibrated data, for further selection , averaging and atmospheric 
optical depth correction. To save the output spectra in a certain
range of channels, you set the range in channelrange.

If you give multiple IFs in iflist, then your scantable will have
multiple IFs by default. Averaging of multi-resolution (multi-IFs)
spectra can be achieved by setting a sub-parameter in timeaverage, 
averageall, to True. It handles multi-IFs by selecting overlaps in 
frequency coverages and assigning new IFs in the output spectra.

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), by leaving
the sub-parameter telescopeparm unset (telescopeparm=''),
it will use internal telescope parameters for
flux conversion for the data from AT telescopes and it will use an
approximate aperture efficiency conversion for the GBT data.
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.

Note that sdcal assumes that the fluxunit is set correctly in
the data already.  If not, then set telescopeparm='FIX' and it
will set the default units to fluxunit without conversion.
NOTE: If the data in infile is an ms from GBT and the default flux
unit is missing, this task automatically fixes the default fluxunit
to 'K' before the conversion.

Two new calmode, 'otf' and 'otfraster', are available. If you 
specify those modes, the task first try to define several scans 
near edge as OFF scans, then the data are calibrated using those 
OFF scans. Those modes are designed for OTF observations without 
explicit OFF scans. If the observing pattern is 'raster', you 
should use the 'otfraster' mode to calibrate data. Otherwise, the 
'otf' mode should be used. For detail about edge marking, see 
online help of sd.edgemarker module.

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

def sdcal_cli.sdcal_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 538 of file sdcal_cli.py.

def sdcal_cli.sdcal_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 450 of file sdcal_cli.py.

def sdcal_cli.sdcal_cli_.description	(	self,
		key = `'sdcal'`,
		subkey = `None`
	)

Definition at line 569 of file sdcal_cli.py.

def sdcal_cli.sdcal_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 613 of file sdcal_cli.py.

References accum_cli.accum_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.

def sdcal_cli.sdcal_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 426 of file sdcal_cli.py.

def sdcal_cli.sdcal_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file sdcal_cli.py.

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

Definition at line 20 of file sdcal_cli.py.

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

sdcal_cli.sdcal_cli_.__bases__ [private]

Definition at line 27 of file sdcal_cli.py.

sdcal_cli.sdcal_cli_.__doc__ [private]

Definition at line 28 of file sdcal_cli.py.

sdcal_cli.sdcal_cli_.__globals__ [private]

Definition at line 257 of file sdcal_cli.py.

string sdcal_cli.sdcal_cli_.__name__ [static, private]

Definition at line 19 of file sdcal_cli.py.

sdcal_cli.sdcal_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file sdcal_cli.py.

sdcal_cli.sdcal_cli_.parameters

Definition at line 30 of file sdcal_cli.py.

tuple sdcal_cli.sdcal_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 517 of file sdcal_cli.py.

tuple sdcal_cli.sdcal_cli_.retval [static]

Definition at line 530 of file sdcal_cli.py.

sdcal_cli.sdcal_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file sdcal_cli.py.

string sdcal_cli.sdcal_cli_.valornotval [static]

Definition at line 520 of file sdcal_cli.py.

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

sdcal_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