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

Constructor & Destructor Documentation

def predictcomp_cli.predictcomp_cli_.__init__ ( self )

Definition at line 26 of file predictcomp_cli.py.

Member Function Documentation

def predictcomp_cli.predictcomp_cli_.__call__	(	self,
		objname = `None`,
		standard = `None`,
		epoch = `None`,
		minfreq = `None`,
		maxfreq = `None`,
		nfreqs = `None`,
		prefix = `None`,
		antennalist = `None`,
		showplot = `None`,
		savefig = `None`,
		symb = `None`,
		include0amp = `None`,
		include0bl = `None`,
		blunit = `None`,
		showbl0flux = `None`,
		async = `None`
	)

Make a component list for a known calibrator

    Writes a component list to disk and returns a dict of
    {'clist': filename of the component list,
     'objname': objname,
     'angdiam': angular diameter in radians (if used in clist),
     'standard': standard,
     'epoch': epoch,
     'freqs': pl.array of frequencies, in GHz,
     'antennalist': pl.array of baseline lengths, in m,
     'amps':  pl.array of predicted visibility amplitudes, in Jy,
     'savedfig': False or, if made, the filename of a plot.}
    or False on error.

    objname: An object supported by standard.
    standard: A standard for calculating flux densities, as in setjy.
      Default: 'Butler-JPL-Horizons 2010'
    epoch: The epoch to use for the calculations.   Irrelevant for
   extrasolar standards. (Uses UTC)
   Examples: '2011-12-31/5:34:12', '2011-12-31-5:34:12'
    minfreq: The minimum frequency to use.
     Example: '342.0GHz'
    maxfreq: The maximum frequency to use.
     Default: minfreq
     Example: '346.0GHz'
     Example: '', anything <= 0, or None: use minfreq.
    nfreqs:  The number of frequencies to use.
     Default: 1 if minfreq == maxfreq,
      2 otherwise.
    prefix: The component list will be saved to
       prefix + 'spw0_<objname>_<minfreq><epoch>.cl'
    Default: '' 
    Example: "Bands3to7_"
     (which could produce 'Bands3to7_spw0_Uranus_100GHz55877d.cl',
      depending on the other parameters)
    antennalist: 'Observe' and plot the visibility amplitudes for this
 antenna configuration.  The file should be in a format usable
 by simdata.  The search path is:
     .:casa['dirs']['data'] + '/alma/simmos/'
     Default: '' (None, just make clist.)
     Example: 'alma.cycle0.extended.cfg'

    Subparameters of antennalist:
    showplot: Whether or not to show a plot of S vs. |u| on screen.
      Subparameter of antennalist.
      Default: Necessarily False if antennalist is not specified.
       True otherwise.
    savefig: Filename for saving a plot of S vs. |u|.
     Subparameter of antennalist.
     Default: False (necessarily if antennalist is not specified)
     Examples: ''           (do not save the plot)
       'myplot.png' (save to myplot.png)
    symb: One of matplotlib's codes for plot symbols: .:,o^v<>s+xDd234hH|_
  Default: ',':  The smallest points I could find.
    include0amp: Force the amplitude axis to start at 0?
 Default: False
    include0bl: Force the baseline axis to start at 0?
Default: False
    blunit: unit of the baseline axis ('' or 'klambda')
    Default:''=use a unit in the data
    showbl0flux: Print the zero baseline flux? 
 Default: False

Definition at line 46 of file predictcomp_cli.py.

def predictcomp_cli.predictcomp_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 328 of file predictcomp_cli.py.

def predictcomp_cli.predictcomp_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 271 of file predictcomp_cli.py.

def predictcomp_cli.predictcomp_cli_.description	(	self,
		key = `'predictcomp'`,
		subkey = `None`
	)

Definition at line 359 of file predictcomp_cli.py.

def predictcomp_cli.predictcomp_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 387 of file predictcomp_cli.py.

Referenced by rmtables_cli.rmtables_cli_.defaults(), uvsub_cli.uvsub_cli_.defaults(), uvcontsub2_cli.uvcontsub2_cli_.defaults(), smoothcal_cli.smoothcal_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(), viewer_cli.viewer_cli_.defaults(), sdscale_cli.sdscale_cli_.defaults(), slsearch_cli.slsearch_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(), sdsmooth_cli.sdsmooth_cli_.defaults(), visstat_cli.visstat_cli_.defaults(), widebandpbcor_cli.widebandpbcor_cli_.defaults(), sdcoadd_cli.sdcoadd_cli_.defaults(), uvmodelfit_cli.uvmodelfit_cli_.defaults(), sdsave_cli.sdsave_cli_.defaults(), simanalyze_cli.simanalyze_cli_.defaults(), sdmath_cli.sdmath_cli_.defaults(), sdgrid_cli.sdgrid_cli_.defaults(), sdtpimaging_cli.sdtpimaging_cli_.defaults(), sdstat_cli.sdstat_cli_.defaults(), split_cli.split_cli_.defaults(), sdimaging_cli.sdimaging_cli_.defaults(), statwt_cli.statwt_cli_.defaults(), sdflag_cli.sdflag_cli_.defaults(), simalma_cli.simalma_cli_.defaults(), sdfit_cli.sdfit_cli_.defaults(), sdcal_cli.sdcal_cli_.defaults(), simobserve_cli.simobserve_cli_.defaults(), sdbaseline_cli.sdbaseline_cli_.defaults(), setjy_cli.setjy_cli_.defaults(), widefield_cli.widefield_cli_.defaults(), specfit_cli.specfit_cli_.defaults(), and sdreduce_cli.sdreduce_cli_.defaults().

def predictcomp_cli.predictcomp_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 247 of file predictcomp_cli.py.

def predictcomp_cli.predictcomp_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file predictcomp_cli.py.

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

Definition at line 20 of file predictcomp_cli.py.

Referenced by predictcomp_cli.predictcomp_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(), and rmtables_cli.rmtables_cli_.result().

predictcomp_cli.predictcomp_cli_.__bases__ [private]

Definition at line 27 of file predictcomp_cli.py.

predictcomp_cli.predictcomp_cli_.__doc__ [private]

Definition at line 28 of file predictcomp_cli.py.

predictcomp_cli.predictcomp_cli_.__globals__ [private]

Definition at line 114 of file predictcomp_cli.py.

string predictcomp_cli.predictcomp_cli_.__name__ [static, private]

Definition at line 19 of file predictcomp_cli.py.

predictcomp_cli.predictcomp_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file predictcomp_cli.py.

predictcomp_cli.predictcomp_cli_.parameters

Definition at line 30 of file predictcomp_cli.py.

tuple predictcomp_cli.predictcomp_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 307 of file predictcomp_cli.py.

tuple predictcomp_cli.predictcomp_cli_.retval [static]

Definition at line 320 of file predictcomp_cli.py.

predictcomp_cli.predictcomp_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file predictcomp_cli.py.

string predictcomp_cli.predictcomp_cli_.valornotval [static]

Definition at line 310 of file predictcomp_cli.py.

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

predictcomp_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