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

Constructor & Destructor Documentation

def sdtpimaging_cli.sdtpimaging_cli_.__init__ ( self )

Definition at line 26 of file sdtpimaging_cli.py.

Member Function Documentation

def sdtpimaging_cli.sdtpimaging_cli_.__call__	(	self,
		infile = `None`,
		calmode = `None`,
		masklist = `None`,
		blpoly = `None`,
		backup = `None`,
		flaglist = `None`,
		antenna = `None`,
		spw = `None`,
		stokes = `None`,
		createimage = `None`,
		outfile = `None`,
		imsize = `None`,
		cell = `None`,
		phasecenter = `None`,
		ephemsrcname = `None`,
		pointingcolumn = `None`,
		gridfunction = `None`,
		plotlevel = `None`,
		async = `None`
	)

SD task: do a simple calibration and imaging for total power data 
  Keyword arguments:
infile -- name of input SD (MS) dataset
calmode -- calibration mode (currently only baseline subtraction)
options: 'baseline','none'
default: 'none'
example: choose mode 'none' if you have
         already calibrated and want to do
         plotting nd/or imaging 
    >>> calmode='baseline' expandable parameters
       masklist -- mask in numbers of rows from each edge of each scan 
           to be included for baseline fitting
 default: none
 example: [30,30] or [30] 
          used first 30 rows and last 30 rows of each scan for 
          the baseline 
       blpoly -- polynomial order for the baseline fit
 default: 1
       backup -- set True to create backup for input data
 default: True
flaglist -- list of scan numbers to flag (ranges can be accepted)  
default: [] (use all scans)
example: [[0,3],80]
         flag the scan range [0,3] = [0,1,2,3] and scan 80 
antenna -- select data based on antenna name(s) or id(s) in string
default: '' (use all antennas)
example: '0,1', 'DV01'
WARNING: currently baseline subtraction properly 
         only one of the antennas.
spw -- spectral window id
default: 0
example: 1
stokes -- select data based on stokes or polarization type 
default: '' (use all polarizations)
example: 'XX'
createimage -- do imaging? 
default: False 
    >>> createimage=True expandable parameters
       outfile -- output image name
 default: none
 example: 'mySDimage.im'
       imsize -- x and y image size in pixels, symmetric for single 
         value
 default: [256,256]
 example: imsize=200 (equivalent to [200,200])
       cell -- x and y cell size. default unit arcmin
 default: '1.0arcmin'
 example: cell=['0.2arcmin, 0.2arcmin']
          cell='0.2arcmin' (equivalent to example above)
       phasecenter -- image phase center: direction measure or fieldid 
 default: 0
 example: 'J2000 13h44m00 -17d02m00', 'AZEL -123d48m29 15d41m41'
       ephemsrcname -- ephemeris source name to proper shifting to 
               center on the moving source for imaging
 default: ''
          if the source name in the data matches one of the 
          known solar objects by the system, this task 
          automatically set the source name. 
 example: 'moon' 
       pointingcolumn -- pointing data column to use
 option: 'direction', 'target', 'pointing_offset', 
         'source_offset', 'encoder' 
 default: 'direction'
       gridfunction -- gridding function for imaging
 options: 'BOX' (Box-car), 'SF' (Spheroidal), 
          'PB' (Primary-beam), 'GAUSS' (Gaussian),
          'GJINC' (Gaussian*Jinc)
 default: 'BOX'
 example: 'SF'
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 plot 
             (will be named <infile>_scans.eps)
          1: plot raw data, calibrated data 
             (for calmode='baseline)
             plot raw or if exist calibrated data 
             (for calmode='none')
          2: plot raw data, progressively display baseline 
             fitting for each scan, and final calibrated data 
             (for calmode='baseline')  


DESCRIPTION:

Task sdtpimaging performs data selection, calibration, and imaging for 
single-dish totalpower raster scan data.  This is a still experimental 
task made to work mostly for the data taken at the ALMA Testing 
Facility (ATF) or OSF. Currently, this task directly accesses the 
Measurement Set data only because of the data access efficiency. So it 
differs from other single-dish tasks that mostly operate on the ASAP 
scantable data format.  By setting calmode='none', one can run 
sdtpimaging to plot the data (raw or calibrated, if exists) and 
further imaging by setting createimage=True. 

The calibration available at this moment is just a simple baseline 
subtraction for each scan. The fitted regions set by masklist are the 
common for all the scans. Selection of the antennas can be made by 
setting antennaid(s) or antenna name(s) in string (e.g. '0', '0,1', 
'DV01',etc.). 

For baseline subtraction, it currently works properly for a single 
antenna selection. So a separate sdtpimaging task needs to be ran for 
each antenna. It currently assumes that the data has a single spw(=0) 
and fieldid(=0). By setting flaglist, one can set flag by scan numbers 
to be excluded from imaging. (Note: 'scan numbers' are determined from 
state id and related to SUB_SCAN column in STATE subtable and not to 
SCAN_NUMBER in MS.) By default, baseline subtraction stage overwrites 
(FLOAT_)DATA column of input data. You can keep original data by 
setting backup parameter to True. In this case, the task make a copy 
of input data specified by infile parameter. Name of backup file is 
<infile>.sdtpimaging.bak.<timestamp>.  

The selection of polarizations can be made by specifying the 
polarization name in stokes, such as 'XX' or 'YY' for linear 
polarizations. For example, with createimage=True, stokes='XXYY' will 
produces an image cube with each plane contains the image of one of
the polarizations while stokes='' or stokes='I' will produces a 'total 
intensity' or Stokes I image. 

Among the imaging sub-parameters, ephemsrcname is used to set the name 
of a moving source such as planets to produce a stationary image (can 
be omitted), and pointingcolumn is used to specify which pointing data 
column to use for imaging. Convolution kernel for imaging can be 
specified by using gridfunction. Available options are 'Box' (Box-car),
'SF' (Spheroidal), 'PB' (Primary-beam), 'GAUSS' (Gaussian), and 
'GJINC' (Gaussian*Jinc), where Jinc(x) = J_1(pi*x/c)/(pi*x/c) with a 
first order Bessel function J_1. Sub-parameters for convolution 
functions cannot be specified in this task. To costomize your 
convolution function, please do imaging using sdimaging task or 
imager tool.

Definition at line 46 of file sdtpimaging_cli.py.

def sdtpimaging_cli.sdtpimaging_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 412 of file sdtpimaging_cli.py.

def sdtpimaging_cli.sdtpimaging_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 352 of file sdtpimaging_cli.py.

def sdtpimaging_cli.sdtpimaging_cli_.description	(	self,
		key = `'sdtpimaging'`,
		subkey = `None`
	)

Definition at line 443 of file sdtpimaging_cli.py.

def sdtpimaging_cli.sdtpimaging_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 474 of file sdtpimaging_cli.py.

References accum_cli.accum_cli_.parameters, sdtpimaging_cli.sdtpimaging_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(), 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 sdtpimaging_cli.sdtpimaging_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 328 of file sdtpimaging_cli.py.

def sdtpimaging_cli.sdtpimaging_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file sdtpimaging_cli.py.

References accum_cli.accum_cli_.__async__, sdtpimaging_cli.sdtpimaging_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 sdtpimaging_cli.sdtpimaging_cli_.__async__ [static, private]

Definition at line 20 of file sdtpimaging_cli.py.

Referenced by sdtpimaging_cli.sdtpimaging_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(), and setjy_cli.setjy_cli_.result().

sdtpimaging_cli.sdtpimaging_cli_.__bases__ [private]

Definition at line 27 of file sdtpimaging_cli.py.

sdtpimaging_cli.sdtpimaging_cli_.__doc__ [private]

Definition at line 28 of file sdtpimaging_cli.py.

sdtpimaging_cli.sdtpimaging_cli_.__globals__ [private]

Definition at line 182 of file sdtpimaging_cli.py.

string sdtpimaging_cli.sdtpimaging_cli_.__name__ [static, private]

Definition at line 19 of file sdtpimaging_cli.py.

sdtpimaging_cli.sdtpimaging_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file sdtpimaging_cli.py.

sdtpimaging_cli.sdtpimaging_cli_.parameters

Definition at line 30 of file sdtpimaging_cli.py.

tuple sdtpimaging_cli.sdtpimaging_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 391 of file sdtpimaging_cli.py.

tuple sdtpimaging_cli.sdtpimaging_cli_.retval [static]

Definition at line 404 of file sdtpimaging_cli.py.

sdtpimaging_cli.sdtpimaging_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file sdtpimaging_cli.py.

string sdtpimaging_cli.sdtpimaging_cli_.valornotval [static]

Definition at line 394 of file sdtpimaging_cli.py.

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

sdtpimaging_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