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

Constructor & Destructor Documentation

def uvcontsub_cli.uvcontsub_cli_.__init__ ( self )

Definition at line 26 of file uvcontsub_cli.py.

Member Function Documentation

def uvcontsub_cli.uvcontsub_cli_.__call__	(	self,
		vis = `None`,
		field = `None`,
		fitspw = `None`,
		combine = `None`,
		solint = `None`,
		fitorder = `None`,
		spw = `None`,
		want_cont = `None`,
		async = `None`
	)

Continuum fitting and subtraction in the uv plane

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.

If want_cont is True, the continuum fit is placed in a second new MS
(vis + '.cont').  N.B. because the continuum model is necessarily a
smoothed fit, images made with it are liable to have their field of
view reduced in some strange way.  Images of the continuum should be
made by simply excluding the line channels (and probably averaging the
remaining ones) in clean.

Keyword arguments:
vis -- Name of input visibility file
default: none; example: vis='ngc5921.ms'
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: field = '' means select all fields
field = 1 # will get field_id=1 (if you give it an 
        integer, it will retrieve the source with that index.
field = '1328+307'  specifies source '1328+307'
field = '13*' will retrieve '1328+307' and any other fields
   beginning with '13'
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 -- Data axes to combine for the continuum estimate.
It must include 'spw' if spw contains spws that are not in
fitspw!
default: '' --> solutions will break at scan, field, and spw
      boundaries according to solint
      Options: '', 'spw'', 'scan', or 'spw, scan'
      example: combine='spw' --> form spw-merged continuum estimate
solint -- Timescale for per-baseline fit (units optional)
default (recommended): 'int' --> no time averaging, do a
                       fit for each integration and let the
                       noisy fits average out in the image.

example: solint='10s'  --> average to 10s before fitting
         10 or '10' --> '10s' (unitless: assumes seconds)
options: 'int' --> per integration
         'inf' --> per scan

If solint is longer than 'int', the continuum estimate can be
corrupted by time smearing!

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

spw -- Optional per spectral window selection of channels to include
       in the output.  See the note under combine.

       The spectral windows will be renumbered to start from 0, as in
       split.
want_cont -- Create vis + '.cont' to hold the continuum estimate.
default: 'False'; example: want_cont=True
The continuum estimate will be placed in vis + '.cont'
async -- Run task in a separate process (return CASA prompt)
default: False; example: async=True

Definition at line 46 of file uvcontsub_cli.py.

def uvcontsub_cli.uvcontsub_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 326 of file uvcontsub_cli.py.

def uvcontsub_cli.uvcontsub_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 272 of file uvcontsub_cli.py.

def uvcontsub_cli.uvcontsub_cli_.description	(	self,
		key = `'uvcontsub'`,
		subkey = `None`
	)

Definition at line 357 of file uvcontsub_cli.py.

def uvcontsub_cli.uvcontsub_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 374 of file uvcontsub_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(), 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 uvcontsub_cli.uvcontsub_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 248 of file uvcontsub_cli.py.

def uvcontsub_cli.uvcontsub_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file uvcontsub_cli.py.

References accum_cli.accum_cli_.__async__, uvcontsub_cli.uvcontsub_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 uvcontsub_cli.uvcontsub_cli_.__async__ [static, private]

Definition at line 20 of file uvcontsub_cli.py.

Referenced by uvcontsub_cli.uvcontsub_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(), and uvmodelfit_cli.uvmodelfit_cli_.result().

uvcontsub_cli.uvcontsub_cli_.__bases__ [private]

Definition at line 27 of file uvcontsub_cli.py.

uvcontsub_cli.uvcontsub_cli_.__doc__ [private]

Definition at line 28 of file uvcontsub_cli.py.

uvcontsub_cli.uvcontsub_cli_.__globals__ [private]

Definition at line 129 of file uvcontsub_cli.py.

string uvcontsub_cli.uvcontsub_cli_.__name__ [static, private]

Definition at line 19 of file uvcontsub_cli.py.

uvcontsub_cli.uvcontsub_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file uvcontsub_cli.py.

uvcontsub_cli.uvcontsub_cli_.parameters

Definition at line 30 of file uvcontsub_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 uvcontsub_cli.uvcontsub_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 305 of file uvcontsub_cli.py.

tuple uvcontsub_cli.uvcontsub_cli_.retval [static]

Definition at line 318 of file uvcontsub_cli.py.

uvcontsub_cli.uvcontsub_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file uvcontsub_cli.py.

string uvcontsub_cli.uvcontsub_cli_.valornotval [static]

Definition at line 308 of file uvcontsub_cli.py.

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

uvcontsub_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