task_predictcomp Namespace Reference

Functions
def	predictcomp

---

Function Documentation

def task_predictcomp.predictcomp	(		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,
			bl0flux = None
	)

Writes a component list named clist to disk and returns a dict of
{'clist': clist,
 'objname': objname,
 'angdiam': angular diameter in radians (if used in clist),
 'standard': standard,
 'epoch': epoch,
 'freqs': pl.array of frequencies, in GHz,
 'uvrange': 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.
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: ''
antennalist: An array configuration file as used by simdata.
             If given, a plot of S vs. |u| will be made.
             Default: '' (None, just make clist.)
showplot: Whether or not to show the plot 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: True (save to prefix + '.png')
                   '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 lower limit of the amplitude axis to 0.
             Default: False
include0bl: Force the lower limit of the baseline length axis to 0.
blunit: Unit of the baseline length 
bl0flux: show zero baseline flux

Definition at line 10 of file task_predictcomp.py.

References taskinit.cltool, taskinit.imtool, taskinit.metool, and predictcomp_helper.predictSolarObjectCompList().