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

Constructor & Destructor Documentation

def widebandpbcor_cli.widebandpbcor_cli_.__init__ ( self )

Definition at line 26 of file widebandpbcor_cli.py.

Member Function Documentation

def widebandpbcor_cli.widebandpbcor_cli_.__call__	(	self,
		vis = `None`,
		imagename = `None`,
		nterms = `None`,
		threshold = `None`,
		action = `None`,
		reffreq = `None`,
		pbmin = `None`,
		field = `None`,
		spwlist = `None`,
		chanlist = `None`,
		weightlist = `None`,
		async = `None`
	)

Wideband PB-correction on the output of the MS-MFS algorithm

Wide-band Primary-beam correction

(1) Compute a set of Primary Beams at the specified frequencies
(2) Calculate Taylor-coefficient images that represent the PB spectrum
(3) Perform a polynomial division to PB-correct the output Taylor-coefficient
images from the MS-MFS algorithm ( clean(nterms>1) )
(4) Recompute spectral index (and curvature) using the corrected Taylor-coefficient images.

[ Optionally, skip PB-correction, and only recalculate spectral index
with a different threshold ]

This is a temporary task, meant for use until projection-based gridding algorithms
are available via the 'clean' task.

An output directory named imagename.pbcor.workdirectory is created, and filled with
an image-cube of the evaluated primary beams at all specified frequencies,
Taylor-coefficients, and a 'spectral index' due to the primary beam.
Note that for the actual pb-correction, only the Taylor-coefficient images are used.

Task parameters :

vis -- Name of input visibility file
example : vis = 'ngc5921.ms'
Only one MS can be specified here, and it must contain at-least one
timestep of data at all frequencies required to calculate the PB spectrum.
( In case of multiple MSs with different spectral windows, for now,
please split/concat a small fraction of the data to form such an MS )

imagename -- Pre-name of input and output images. Same as in the clean task.
example : imagename = 'run1'
Restored-images ( run1.image.tt0,etc) and residual images ( run1.residual.tt0, etc.. )
must be available on disk.

nterms -- Number of Taylor terms to be used to model the frequency-dependence
of the primary beam.
example : nterms = 2
nterms must be less than or equal to the number of frequencies specified via
spwlist, chanlist and weightlist.
nterms=1 will do a standard division by the average PB computed over all
specified frequencies.

threshold -- Flux level in the restored intensity map, below which to not
recalculate spectral index.
example : threshold = '0.1Jy'

action -- Choice of PB-correction with spectral-index recalculation
or only spectral-index recalculation (using the specified threshold)
example : action='pbcor' or action='calcalpha'

With action='pbcor', the following output images are created/overwritten.

- imagename.pbcor.workdirectory : This directory contains an image cube with
PBs at the list of specified frequencies, and Taylor-coefficient images that
describe the PB spectrum.
- imagename.pb.cube : Concatenated cube of PBs
- imagename.pb.tt0, tt1, ... : Taylor coefficients describing the PB spectrum
- imagename.pb.alpha : Spectral index of the PB (for information only)
- imagename.image.pbcor.tt0,tt1,... : Corrected Taylor coefficients
- imagename.pbcor.image.alpha : Corrected Spectral Index
- imagename.pbcor.image.alpha.error : New error map.

With action='calcalpha', the following output images are created/overwritten
- imagename.image.alpha : Corrected Spectral Index
- imagename.image.alpha.error : New error map.

reffreq -- Reference frequency about which the Taylor-expansion is defined.
example : reffreq = '1.5GHz'
If left unspecified, it is picked from the input restored image.
Note : If reffreq was specified during task clean to produce the images
it must be specified here.

pbmin -- PB gain level below which to not compute Taylor-coefficients or
apply PB-corrections.
example : pbmin = 0.1

field -- Field selection for the Primary Beam calculation.
example : field = '3C291'
This field selection must be identical to that used in 'clean'

spwlist -- List of SPW ids for which to make separate Primary Beams
chanlist -- List of channel ids, within the above SPW ids, at which to make PBs.

example : spwlist=[0,1,2], chanlist=[32,32,32]
Make PBs at frequencies corresponding to channel 32 of
spws 0,1 and 2.
example : spwlist=[0,0,0], chanlist=[0,10,20]
Make PBs at frequencies corresponding to channels 0,10,20
of spw 0

Primary beams are computed at these specified frequencies and
for pointings selected by 'field'. Taylor-coefficients that represent
the PB spectrum are computed from these images.

weightlist -- List of relative weights to apply to the PBs selected via the
spwlist,chanlist parameters. Weights should approximately represent the
sum-of-weights applicable during imaging each of these frequencies.
example : weightlist=[0.5,1.0,1.0]
The first frequency had less usable data due to flagged RFI,
but the other two had relatively equal weight.
These weights are applied to the PB spectrum while computing
PB Taylor-coefficients. Setting weights to anything other than 1.0
makes a difference only with very lop-sided weights.

Definition at line 46 of file widebandpbcor_cli.py.

def widebandpbcor_cli.widebandpbcor_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 360 of file widebandpbcor_cli.py.

def widebandpbcor_cli.widebandpbcor_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 307 of file widebandpbcor_cli.py.

def widebandpbcor_cli.widebandpbcor_cli_.description	(	self,
		key = `'widebandpbcor'`,
		subkey = `None`
	)

Definition at line 391 of file widebandpbcor_cli.py.

def widebandpbcor_cli.widebandpbcor_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 415 of file widebandpbcor_cli.py.

References accum_cli.accum_cli_.parameters, widebandpbcor_cli.widebandpbcor_cli_.parameters, visstat_cli.visstat_cli_.parameters, vishead_cli.vishead_cli_.parameters, virtualconcat_cli.virtualconcat_cli_.parameters, viewer_cli.viewer_cli_.parameters, uvsub_cli.uvsub_cli_.parameters, uvmodelfit_cli.uvmodelfit_cli_.parameters, uvcontsub_cli.uvcontsub_cli_.parameters, uvcontsub3_cli.uvcontsub3_cli_.parameters, uvcontsub2_cli.uvcontsub2_cli_.parameters, testconcat_cli.testconcat_cli_.parameters, tclean_cli.tclean_cli_.parameters, statwt_cli.statwt_cli_.parameters, ssoflux_cli.ssoflux_cli_.parameters, split_cli.split_cli_.parameters, splattotable_cli.splattotable_cli_.parameters, specfit_cli.specfit_cli_.parameters, smoothcal_cli.smoothcal_cli_.parameters, slsearch_cli.slsearch_cli_.parameters, simobserve_cli.simobserve_cli_.parameters, simanalyze_cli.simanalyze_cli_.parameters, simalma_cli.simalma_cli_.parameters, setjy_cli.setjy_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 wvrgcal_cli.wvrgcal_cli_.defaults(), widebandpbcor_cli.widebandpbcor_cli_.defaults(), and widefield_cli.widefield_cli_.defaults().

def widebandpbcor_cli.widebandpbcor_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 283 of file widebandpbcor_cli.py.

def widebandpbcor_cli.widebandpbcor_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file widebandpbcor_cli.py.

References accum_cli.accum_cli_.__async__, widebandpbcor_cli.widebandpbcor_cli_.__async__, visstat_cli.visstat_cli_.__async__, vishead_cli.vishead_cli_.__async__, virtualconcat_cli.virtualconcat_cli_.__async__, viewer_cli.viewer_cli_.__async__, uvsub_cli.uvsub_cli_.__async__, uvmodelfit_cli.uvmodelfit_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 widebandpbcor_cli.widebandpbcor_cli_.__async__ [static, private]

Definition at line 20 of file widebandpbcor_cli.py.

Referenced by widebandpbcor_cli.widebandpbcor_cli_.result(), wvrgcal_cli.wvrgcal_cli_.result(), and widefield_cli.widefield_cli_.result().

widebandpbcor_cli.widebandpbcor_cli_.__bases__ [private]

Definition at line 27 of file widebandpbcor_cli.py.

widebandpbcor_cli.widebandpbcor_cli_.__doc__ [private]

Definition at line 28 of file widebandpbcor_cli.py.

widebandpbcor_cli.widebandpbcor_cli_.__globals__ [private]

Definition at line 155 of file widebandpbcor_cli.py.

Referenced by wvrgcal_cli.wvrgcal_cli_.check_params(), widebandpbcor_cli.widebandpbcor_cli_.check_params(), widefield_cli.widefield_cli_.check_params(), wvrgcal_cli.wvrgcal_cli_.defaults(), widebandpbcor_cli.widebandpbcor_cli_.defaults(), widefield_cli.widefield_cli_.defaults(), wvrgcal_cli.wvrgcal_cli_.paramgui(), widebandpbcor_cli.widebandpbcor_cli_.paramgui(), and widefield_cli.widefield_cli_.paramgui().

string widebandpbcor_cli.widebandpbcor_cli_.__name__ [static, private]

Definition at line 19 of file widebandpbcor_cli.py.

widebandpbcor_cli.widebandpbcor_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file widebandpbcor_cli.py.

widebandpbcor_cli.widebandpbcor_cli_.parameters

Definition at line 30 of file widebandpbcor_cli.py.

Referenced by wvrgcal_cli.wvrgcal_cli_.itsdefault(), widebandpbcor_cli.widebandpbcor_cli_.itsdefault(), and widefield_cli.widefield_cli_.itsdefault().

tuple widebandpbcor_cli.widebandpbcor_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 339 of file widebandpbcor_cli.py.

tuple widebandpbcor_cli.widebandpbcor_cli_.retval [static]

Definition at line 352 of file widebandpbcor_cli.py.

widebandpbcor_cli.widebandpbcor_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file widebandpbcor_cli.py.

string widebandpbcor_cli.widebandpbcor_cli_.valornotval [static]

Definition at line 342 of file widebandpbcor_cli.py.

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

widebandpbcor_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