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

Constructor & Destructor Documentation

def peel_cli.peel_cli_.__init__ ( self )

Definition at line 26 of file peel_cli.py.

Member Function Documentation

def peel_cli.peel_cli_.__call__	(	self,
		vis = `None`,
		dirs = `None`,
		remove = `None`,
		calmode = `None`,
		async = `None`
	)

Do direction dependent selfcal(s) and optionally remove annoying sources.
Unfortunately at some level gains are direction-dependent, typically
because of either deviations between the true antenna voltage patterns and
the models being used, and/or fluctuations in one layer or another of the
Earth's atmosphere.  Bright sources located in the edges of the primary
beam therefore corrupt images of the central portions of the primary beam
in two ways.  The most obvious way is by throwing a corrupted version of
the PSF across the image.  Since it is corrupted, it cannot be deconvolved
away without first correcting the gains.  The second problem is that a
bright source can dominate the solutions of "classical" selfcalibration,
essentially forcing it to solve the gains for the direction of the bright
source instead of the pointing center.

Solving for and removing the effects of direction-dependent gains is known
in various forms as "peeling", "modcal", or most prosaically,
direction-dependent selfcalibration.  This task attempts
direction-dependent selfcalibration in the requested list of directions,
and optionally removes the associated sources.

The usual risks of selfcalibration (imperfect model and possibly
insufficient constraints) are particularly severe for peeling.  Approach it
with trepidation and stop as soon as possible.  Peeling can ameliorate the
effects of heterogeneous arrays, but it is better to use the right antenna
voltage patterns a priori.

Do not peel unless necessary.

Still here?  All right...read carefully...

Your desire to peel probably stems from the center of your "science field"
being spoiled by the distorted PSFs of bright sources near the edge of the
primary beam.  The fact that their PSFs are interfering with your field of
interest means that your science sources are interfering with the sources
to be peeled!  Thus before doing any peeling you should remove a model of
your science field from the visibilities.  However, the model should not
include any artifacts from the sources to be peeled.  The easiest way to
produce such a model is to clean down to the threshhold of the brightest
artifacts.  peel does not (yet) do this for you!  You are also of course
responsible for returning the model of your science field to the
visibilities once you have finished peeling.  Obviously, if your science
sources are fainter than the artifacts, removing them and replacing them is
not necessary.

If more than one source must be peeled there is a chance (calculated using
Murphy's Law) that they are interfering with each other.  peel does not yet
simultaneously solve for the gains in more than direction, so interfering
sources must be approached by peeling the brightest source down to the
level of the brightest artifacts in its vicinity, and next peeling whatever
is currently causing the worst artifacts, continuing as necessary.

If the interactions are especially strong, the cycle will have to be
iterated, refining the model(s) along the way.  The convergence is often
safer and faster if the first iteration of the cycle only solves for the
phases, and leaves phase + amplitude selfcalibration to the final
iteration.

Any given run of peel is nearly guaranteed to reduce the artifacts from the
source being peeled, so it can be tempting to continue peeling until the
artifacts drop below the noise.  Resist that temptation!  The number of
fitted parameters accumulates with each peel, so repeated peels force the
image toward the originally assumed model.  Even if the total number of
fitted parameters remains much smaller than the number of visibilities, the
interactions between peeled sources and the central field take their toll
on the science field.  peel sees residual PSF sidelobes from the science
region as artifacts that must be minimized.  Whether removing some flux
from the science source(s) is a risk or a certainty, the number of peels
should be kept down.  Overpeeling becomes easier to spot with experience,
but the symptoms are strongly telescope-dependent.




Example:

# Start with a phase-only peel, and keep the source so it can be phase +
# amplitude peeled if necessary.
peel(vis='my.ms', calmode="p", remove=False)

# Examine the result with viewer.

# OK, do a phase + amplitude removal.
peel(vis='my.ms', calmode="pa")

Definition at line 46 of file peel_cli.py.

def peel_cli.peel_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 317 of file peel_cli.py.

def peel_cli.peel_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 267 of file peel_cli.py.

def peel_cli.peel_cli_.description	(	self,
		key = `'peel'`,
		subkey = `None`
	)

Definition at line 348 of file peel_cli.py.

def peel_cli.peel_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 361 of file peel_cli.py.

def peel_cli.peel_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 243 of file peel_cli.py.

def peel_cli.peel_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file peel_cli.py.

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

Definition at line 20 of file peel_cli.py.

Referenced by peel_cli.peel_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(), and plotants_cli.plotants_cli_.result().

peel_cli.peel_cli_.__bases__ [private]

Definition at line 27 of file peel_cli.py.

peel_cli.peel_cli_.__doc__ [private]

Definition at line 28 of file peel_cli.py.

peel_cli.peel_cli_.__globals__ [private]

Definition at line 132 of file peel_cli.py.

string peel_cli.peel_cli_.__name__ [static, private]

Definition at line 19 of file peel_cli.py.

peel_cli.peel_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file peel_cli.py.

peel_cli.peel_cli_.parameters

Definition at line 30 of file peel_cli.py.

tuple peel_cli.peel_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 296 of file peel_cli.py.

tuple peel_cli.peel_cli_.retval [static]

Definition at line 309 of file peel_cli.py.

peel_cli.peel_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file peel_cli.py.

string peel_cli.peel_cli_.valornotval [static]

Definition at line 299 of file peel_cli.py.

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

peel_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