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

Constructor & Destructor Documentation

def uvcontsub3_cli.uvcontsub3_cli_.__init__ ( self )

Definition at line 26 of file uvcontsub3_cli.py.

Member Function Documentation

def uvcontsub3_cli.uvcontsub3_cli_.__call__	(	self,
		vis = `None`,
		fitspw = `None`,
		combine = `None`,
		fitorder = `None`,
		field = `None`,
		spw = `None`,
		scan = `None`,
		intent = `None`,
		correlation = `None`,
		observation = `None`,
		async = `None`
	)

An experimental clone of uvcontsub
  
uvcontsub3 is an experimental clone of uvcontsub with the goal of taking
less time and temporary disk space.

Continuum fitting and subtraction in the uv plane:

This task estimates the continuum emission by fitting polynomials to
the real and imaginary parts of the spectral windows and channels
selected by fitspw.  This fit represents a model of the continuum in 
all channels.

The fitted continuum spectrum is subtracted from all channels 
selected in spw, and the result (presumably only line emission)
is stored in a new MS (vis + ".contsub").
It will read from the CORRECTED_DATA column of vis if it is present,
or DATA if it is not.  Whichever column is read is presumed to have
already been calibrated.

Keyword arguments:
vis -- Name of input visibility file
default: none; example: vis='ngc5921.ms'

fitspw -- Selection of spectral windows and channels to use in the
  fit for the continuum, using general spw:chan syntax.
  See the note under combine.
default: '' (all)
example: fitspw='0:5~30;40~55'

combine -- Let the continuum estimation span multiple spectral windows.
   default = '' (Make separate estimates for each spw.)
   combine = 'spw': Necessary when one or more of the spws are
                    completely blanketed by lines, so the estimate
                    must be made in different spws.

fitorder -- Polynomial order for the fits of the continuum w.r.t.
    frequency.  fitorders > 1 are strongly discouraged
    because high order polynomials have more flexibility, may
    absorb line emission, and tend go wild at the edges of
    fitspw, which is not what you want.

default: 0 (constant); example: fitorder=1

field -- Field selection for continuum estimation and subtraction.
 The estimation and subtraction is done for each selected field
 in turn.  (Run listobs to get lists of the ID and names.)
       default: ''=all fields.  If the field string is a non-negative
        integer, it is assumed to be a field index
        otherwise, it is assumed to be a field name
       field='0~2'; field ids 0,1,2
       field='0,4,5~7'; field ids 0,4,5,6,7
       field='3C286,3C295'; fields named 3C286 and 3C295
       field = '3,4C*'; field id 3, all names starting with 4C

spw -- Select spectral windows for the output.
       default: ''=all spectral windows
       N.B. uvcontsub3 does not yet support exclusion by channels for
    the output.  Meanwhile, use split to further reduce the size
    of the output MS if desired.
       spw='0~2,4'; spectral windows 0,1,2,4
       spw='<2';  spectral windows less than 2 (i.e. 0,1)

scan -- Scan number range
    default: ''=all

intent -- Select by scan intent (state).  Case sensitive.
    default: '' = all
    Examples:
    intent = 'CALIBRATE_ATMOSPHERE_REFERENCE'
    intent = 'calibrate_atmosphere_reference'.upper() # same as above
    # Select states that include one or both of CALIBRATE_WVR.REFERENCE
    # or OBSERVE_TARGET_ON_SOURCE.
    intent = 'CALIBRATE_WVR.REFERENCE, OBSERVE_TARGET_ON_SOURCE'

correlation -- Select correlations, e.g. 'rr, ll' or ['XY', 'YX'].
       default '' (all).

observation -- Select by observation ID(s).
       default: '' = all

Definition at line 46 of file uvcontsub3_cli.py.

def uvcontsub3_cli.uvcontsub3_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 333 of file uvcontsub3_cli.py.

def uvcontsub3_cli.uvcontsub3_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 277 of file uvcontsub3_cli.py.

def uvcontsub3_cli.uvcontsub3_cli_.description	(	self,
		key = `'uvcontsub3'`,
		subkey = `None`
	)

Definition at line 364 of file uvcontsub3_cli.py.

def uvcontsub3_cli.uvcontsub3_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 383 of file uvcontsub3_cli.py.

Referenced by uvsub_cli.uvsub_cli_.defaults(), viewer_cli.viewer_cli_.defaults(), wvrgcal_cli.wvrgcal_cli_.defaults(), uvcontsub_cli.uvcontsub_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(), and widefield_cli.widefield_cli_.defaults().

def uvcontsub3_cli.uvcontsub3_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 253 of file uvcontsub3_cli.py.

def uvcontsub3_cli.uvcontsub3_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file uvcontsub3_cli.py.

References accum_cli.accum_cli_.__async__, uvcontsub3_cli.uvcontsub3_cli_.__async__, uvcontsub2_cli.uvcontsub2_cli_.__async__, testconcat_cli.testconcat_cli_.__async__, tclean_cli.tclean_cli_.__async__, statwt_cli.statwt_cli_.__async__, ssoflux_cli.ssoflux_cli_.__async__, split_cli.split_cli_.__async__, splattotable_cli.splattotable_cli_.__async__, specfit_cli.specfit_cli_.__async__, smoothcal_cli.smoothcal_cli_.__async__, slsearch_cli.slsearch_cli_.__async__, simobserve_cli.simobserve_cli_.__async__, simanalyze_cli.simanalyze_cli_.__async__, simalma_cli.simalma_cli_.__async__, setjy_cli.setjy_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 uvcontsub3_cli.uvcontsub3_cli_.__async__ [static, private]

Definition at line 20 of file uvcontsub3_cli.py.

Referenced by uvcontsub3_cli.uvcontsub3_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(), and uvcontsub_cli.uvcontsub_cli_.result().

uvcontsub3_cli.uvcontsub3_cli_.__bases__ [private]

Definition at line 27 of file uvcontsub3_cli.py.

uvcontsub3_cli.uvcontsub3_cli_.__doc__ [private]

Definition at line 28 of file uvcontsub3_cli.py.

uvcontsub3_cli.uvcontsub3_cli_.__globals__ [private]

Definition at line 130 of file uvcontsub3_cli.py.

Referenced by uvsub_cli.uvsub_cli_.check_params(), viewer_cli.viewer_cli_.check_params(), uvcontsub_cli.uvcontsub_cli_.check_params(), vishead_cli.vishead_cli_.check_params(), wvrgcal_cli.wvrgcal_cli_.check_params(), uvcontsub3_cli.uvcontsub3_cli_.check_params(), virtualconcat_cli.virtualconcat_cli_.check_params(), visstat_cli.visstat_cli_.check_params(), widebandpbcor_cli.widebandpbcor_cli_.check_params(), uvmodelfit_cli.uvmodelfit_cli_.check_params(), widefield_cli.widefield_cli_.check_params(), uvsub_cli.uvsub_cli_.defaults(), viewer_cli.viewer_cli_.defaults(), wvrgcal_cli.wvrgcal_cli_.defaults(), uvcontsub_cli.uvcontsub_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(), widefield_cli.widefield_cli_.defaults(), uvsub_cli.uvsub_cli_.paramgui(), viewer_cli.viewer_cli_.paramgui(), wvrgcal_cli.wvrgcal_cli_.paramgui(), uvcontsub_cli.uvcontsub_cli_.paramgui(), vishead_cli.vishead_cli_.paramgui(), uvcontsub3_cli.uvcontsub3_cli_.paramgui(), virtualconcat_cli.virtualconcat_cli_.paramgui(), visstat_cli.visstat_cli_.paramgui(), widebandpbcor_cli.widebandpbcor_cli_.paramgui(), uvmodelfit_cli.uvmodelfit_cli_.paramgui(), and widefield_cli.widefield_cli_.paramgui().

string uvcontsub3_cli.uvcontsub3_cli_.__name__ [static, private]

Definition at line 19 of file uvcontsub3_cli.py.

uvcontsub3_cli.uvcontsub3_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file uvcontsub3_cli.py.

uvcontsub3_cli.uvcontsub3_cli_.parameters

Definition at line 30 of file uvcontsub3_cli.py.

Referenced by vishead_cli.vishead_cli_.itsdefault(), wvrgcal_cli.wvrgcal_cli_.itsdefault(), widebandpbcor_cli.widebandpbcor_cli_.itsdefault(), visstat_cli.visstat_cli_.itsdefault(), uvmodelfit_cli.uvmodelfit_cli_.itsdefault(), and widefield_cli.widefield_cli_.itsdefault().

tuple uvcontsub3_cli.uvcontsub3_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 312 of file uvcontsub3_cli.py.

tuple uvcontsub3_cli.uvcontsub3_cli_.retval [static]

Definition at line 325 of file uvcontsub3_cli.py.

uvcontsub3_cli.uvcontsub3_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file uvcontsub3_cli.py.

string uvcontsub3_cli.uvcontsub3_cli_.valornotval [static]

Definition at line 315 of file uvcontsub3_cli.py.

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

uvcontsub3_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