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

Constructor & Destructor Documentation

def importasdm_cli.importasdm_cli_.__init__ ( self )

Definition at line 26 of file importasdm_cli.py.

Member Function Documentation

def importasdm_cli.importasdm_cli_.__call__	(	self,
		asdm = `None`,
		vis = `None`,
		singledish = `None`,
		antenna = `None`,
		corr_mode = `None`,
		srt = `None`,
		time_sampling = `None`,
		ocorr_mode = `None`,
		compression = `None`,
		asis = `None`,
		wvr_corrected_data = `None`,
		scans = `None`,
		ignore_time = `None`,
		process_syspower = `None`,
		process_caldevice = `None`,
		process_pointing = `None`,
		process_flags = `None`,
		tbuff = `None`,
		applyflags = `None`,
		savecmds = `None`,
		outfile = `None`,
		verbose = `None`,
		overwrite = `None`,
		showversion = `None`,
		useversion = `None`,
		async = `None`
	)

Convert an ALMA Science Data Model observation into a CASA visibility file (MS) or single-dish data format (Scantable)
Keyword arguments:
asdm -- Name of input ASDM file (directory)
default: none; example: asdm='ExecBlock3'

vis -- Root ms or scantable name, note a prefix (.ms or .asap) is NOT appended to this name
default: none

singledish -- Set True to write data as single-dish format (Scantable)
default: False

>>> singledish expandable parameter
antenna -- antenna name or id.

corr_mode -- correlation mode to be considered on input. Could
be one or more of the following, ao, co, ac, or all
default: 'all'

srt -- spectral resolution type. Could be one or more of
the following, fr, ca, bw, or all
default: 'all'

time_sampling -- specifies the time sampling, INTEGRATION and/or
SUBINTEGRAION. could be one or more of the following
i, si, or all.
default: 'all'

ocorr_mode -- output data for correlation mode AUTO_ONLY
(ao) or CROSS_ONLY (co) or CROSS_AND_AUTO (ca)
default: 'ca'

compression -- produces comrpressed columns in the resulting measurement set.
default: False

asis -- creates verbatim copies of the ASDM tables in
the output measurement set. The value given to
this option must be a list of table names separated
by space characters; the wildcard character '*' is
allowed in table names.
default: none

wvr_corrected_data -- specifies wich values are considered in the
ASDM binary data to fill the DATA column in
the MAIN table of the MS. Expected values for
this option are 'no' for the uncorrected data
(this is the default), 'yes' for the corrected
data and 'both' for corrected and uncorrected
data. In the latter case, two measurement sets
are created, one containing the uncorrected
data and the other one, whose name is suffixed
by '-wvr-corrected', containing the corrected
data.
default: 'no'

scans -- processes only the scans specified in the option's value. This value is a semicolon
separated list of scan specifications. A scan specification consists in an exec bock index
followed by the character ':' followed by a comma separated list of scan indexes or scan
index ranges. A scan index is relative to the exec block it belongs to. Scan indexes are
1-based while exec blocks's are 0-based. '0:1' or '2:2~6' or '0:1,1:2~6,8;2:,3:24~30' '1,2'
are valid values for the option. '3:' alone will be interpreted as 'all the scans of the
exec block#3'. An scan index or a scan index range not preceded by an exec block index will
be interpreted as 'all the scans with such indexes in all the exec blocks'. By default
all the scans are considered.
default: none (all scans)

ignore_time -- All the rows of the tables Feed, History, Pointing, Source, SysCal, CalDevice, SysPower,
and Weather are processed independently of the time range of the selected exec block / scan.
default: False

process_syspower -- The SysPower table is processed if and only if this parameter is set to True.
default: True

process_caldevice -- The CalDevice table is processed if and only if this parameter is set to True.
default: True

process_pointing -- The Pointing table is processed if and only if this parameter is set to True.
default: True

process_flags -- Create online flags based on the Flag.xml, Antenna.xml and SpectralWindow.xml files
and copy them to the FLAG_CMD sub-table of the MS. The flags will NOT be applied unless
the parameter applyflags is set to True. Optionally, the flags can also be saved to
an external ASCII file if savecmds is set to True.
default: True

>>> process_flags expandable parameter
tbuff -- Time padding buffer (in seconds)
default: 0.0

NOTE: this time is in seconds. You should currently
set the value of tbuff to be 1.5x the correlator
integration time if greater than 1 second. For
example, if the SDM has integrations of 3 seconds,
set tbuff=4.5. Likewise, set tbuff=15.0 for 10-sec
integrations.

applyflags -- Apply the online flags to the MS.
default: False

savecmds -- Save the flag commands to an ASCII file given by the parameter outfile.
default: False

outfile -- Filename where to save the flag commands.
default: ' ' --> by default it will save on a filename composed from the MS name.
Example: vis='uid_A02.ms', the outfile will be 'uid_A02_cmd.txt'.

NOTE: The file is open to save in append mode.

verbose -- produce log output as asdm2MS is being run
default: False

showversion -- report the version of the asdm2MS being used.
default: False

useversion -- Selects the version of asdm2MS to be used (\'v3\' (default, should work for all data))
default: v3

Definition at line 46 of file importasdm_cli.py.

def importasdm_cli.importasdm_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 419 of file importasdm_cli.py.

def importasdm_cli.importasdm_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 347 of file importasdm_cli.py.

def importasdm_cli.importasdm_cli_.description	(	self,
		key = `'importasdm'`,
		subkey = `None`
	)

Definition at line 450 of file importasdm_cli.py.

def importasdm_cli.importasdm_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 488 of file importasdm_cli.py.

References accum_cli.accum_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, ft_cli.ft_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, browsetable_cli.browsetable_cli_.parameters, boxit_cli.boxit_cli_.parameters, blcal_cli.blcal_cli_.parameters, bandpass_cli.bandpass_cli_.parameters, autoclean_cli.autoclean_cli_.parameters, asdmsummary_cli.asdmsummary_cli_.parameters, and applycal_cli.applycal_cli_.parameters.

Referenced by rmtables_cli.rmtables_cli_.defaults(), listfits_cli.listfits_cli_.defaults(), listhistory_cli.listhistory_cli_.defaults(), importfitsidi_cli.importfitsidi_cli_.defaults(), uvsub_cli.uvsub_cli_.defaults(), importgmrt_cli.importgmrt_cli_.defaults(), uvcontsub2_cli.uvcontsub2_cli_.defaults(), plotweather_cli.plotweather_cli_.defaults(), importuvfits_cli.importuvfits_cli_.defaults(), plotants_cli.plotants_cli_.defaults(), imreframe_cli.imreframe_cli_.defaults(), importfits_cli.importfits_cli_.defaults(), smoothcal_cli.smoothcal_cli_.defaults(), listsdm_cli.listsdm_cli_.defaults(), tclean_cli.tclean_cli_.defaults(), splattotable_cli.splattotable_cli_.defaults(), sdflagmanager_cli.sdflagmanager_cli_.defaults(), testconcat_cli.testconcat_cli_.defaults(), sdlist_cli.sdlist_cli_.defaults(), msview_cli.msview_cli_.defaults(), viewer_cli.viewer_cli_.defaults(), imregrid_cli.imregrid_cli_.defaults(), listpartition_cli.listpartition_cli_.defaults(), sdscale_cli.sdscale_cli_.defaults(), imsubimage_cli.imsubimage_cli_.defaults(), msmoments_cli.msmoments_cli_.defaults(), slsearch_cli.slsearch_cli_.defaults(), peel_cli.peel_cli_.defaults(), predictcomp_cli.predictcomp_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(), sdimprocess_cli.sdimprocess_cli_.defaults(), virtualconcat_cli.virtualconcat_cli_.defaults(), listobs_cli.listobs_cli_.defaults(), sdsmooth_cli.sdsmooth_cli_.defaults(), visstat_cli.visstat_cli_.defaults(), imview_cli.imview_cli_.defaults(), widebandpbcor_cli.widebandpbcor_cli_.defaults(), sdcoadd_cli.sdcoadd_cli_.defaults(), uvmodelfit_cli.uvmodelfit_cli_.defaults(), listvis_cli.listvis_cli_.defaults(), sdsave_cli.sdsave_cli_.defaults(), simanalyze_cli.simanalyze_cli_.defaults(), sdmath_cli.sdmath_cli_.defaults(), listcal_cli.listcal_cli_.defaults(), sdgrid_cli.sdgrid_cli_.defaults(), importasdm_cli.importasdm_cli_.defaults(), sdtpimaging_cli.sdtpimaging_cli_.defaults(), sdstat_cli.sdstat_cli_.defaults(), makemask_cli.makemask_cli_.defaults(), split_cli.split_cli_.defaults(), sdimaging_cli.sdimaging_cli_.defaults(), statwt_cli.statwt_cli_.defaults(), sdflag_cli.sdflag_cli_.defaults(), importevla_cli.importevla_cli_.defaults(), partition_cli.partition_cli_.defaults(), simalma_cli.simalma_cli_.defaults(), sdfit_cli.sdfit_cli_.defaults(), sdcal_cli.sdcal_cli_.defaults(), simobserve_cli.simobserve_cli_.defaults(), polcal_cli.polcal_cli_.defaults(), sdbaseline_cli.sdbaseline_cli_.defaults(), setjy_cli.setjy_cli_.defaults(), mosaic_cli.mosaic_cli_.defaults(), widefield_cli.widefield_cli_.defaults(), pclean_cli.pclean_cli_.defaults(), plotxy_cli.plotxy_cli_.defaults(), specfit_cli.specfit_cli_.defaults(), plotms_cli.plotms_cli_.defaults(), and sdreduce_cli.sdreduce_cli_.defaults().

def importasdm_cli.importasdm_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 323 of file importasdm_cli.py.

def importasdm_cli.importasdm_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file importasdm_cli.py.

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

Definition at line 20 of file importasdm_cli.py.

Referenced by importasdm_cli.importasdm_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(), sdcoadd_cli.sdcoadd_cli_.result(), sdcal_cli.sdcal_cli_.result(), sdbaseline_cli.sdbaseline_cli_.result(), rmtables_cli.rmtables_cli_.result(), predictcomp_cli.predictcomp_cli_.result(), polcal_cli.polcal_cli_.result(), plotxy_cli.plotxy_cli_.result(), plotweather_cli.plotweather_cli_.result(), plotuv_cli.plotuv_cli_.result(), plotms_cli.plotms_cli_.result(), plotcal_cli.plotcal_cli_.result(), plotants_cli.plotants_cli_.result(), peel_cli.peel_cli_.result(), pclean_cli.pclean_cli_.result(), partition_cli.partition_cli_.result(), msview_cli.msview_cli_.result(), msmoments_cli.msmoments_cli_.result(), mosaic_cli.mosaic_cli_.result(), makemask_cli.makemask_cli_.result(), listvis_cli.listvis_cli_.result(), listsdm_cli.listsdm_cli_.result(), listpartition_cli.listpartition_cli_.result(), listobs_cli.listobs_cli_.result(), listhistory_cli.listhistory_cli_.result(), listfits_cli.listfits_cli_.result(), listcal_cli.listcal_cli_.result(), imview_cli.imview_cli_.result(), imval_cli.imval_cli_.result(), imtrans_cli.imtrans_cli_.result(), imsubimage_cli.imsubimage_cli_.result(), imstat_cli.imstat_cli_.result(), imsmooth_cli.imsmooth_cli_.result(), imregrid_cli.imregrid_cli_.result(), imreframe_cli.imreframe_cli_.result(), importvla_cli.importvla_cli_.result(), importuvfits_cli.importuvfits_cli_.result(), importgmrt_cli.importgmrt_cli_.result(), importfitsidi_cli.importfitsidi_cli_.result(), importfits_cli.importfits_cli_.result(), and importevla_cli.importevla_cli_.result().

importasdm_cli.importasdm_cli_.__bases__ [private]

Definition at line 27 of file importasdm_cli.py.

importasdm_cli.importasdm_cli_.__doc__ [private]

Definition at line 28 of file importasdm_cli.py.

importasdm_cli.importasdm_cli_.__globals__ [private]

Definition at line 170 of file importasdm_cli.py.

string importasdm_cli.importasdm_cli_.__name__ [static, private]

Definition at line 19 of file importasdm_cli.py.

importasdm_cli.importasdm_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file importasdm_cli.py.

importasdm_cli.importasdm_cli_.parameters

Definition at line 30 of file importasdm_cli.py.

tuple importasdm_cli.importasdm_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 398 of file importasdm_cli.py.

tuple importasdm_cli.importasdm_cli_.retval [static]

Definition at line 411 of file importasdm_cli.py.

importasdm_cli.importasdm_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file importasdm_cli.py.

string importasdm_cli.importasdm_cli_.valornotval [static]

Definition at line 401 of file importasdm_cli.py.

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

importasdm_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