|
casa
$Rev:20696$
|
|
casa
$Rev:20696$
|
Definition at line 1 of file parameter_dictionary.py.
| def parameter_dictionary.par.acaconfig | ( | ) | [static] |
Antenna configuration of ACA 7-m array [''|'cycle1'|'i'|'ns'] Available configurations are: * '' (default) : automatically defines based on antennalist. If antennalist is Cycle-1 configuration, acaconfig='cycle1'. Otherwise, acaconfig='i' * 'cycle1' : Cycle-1 ACA-7m configuration. Uses 'aca_cycle1.cfg'. * 'i' : Normal ACA configuration in full operation. Uses 'aca.i.cfg'. * 'ns': North-South extended configuration in full operation. Uses 'aca.ns.cfg'.
Definition at line 4 of file parameter_dictionary.py.
| def parameter_dictionary.par.acaratio | ( | ) | [static] |
Ratio of the total observation time of ACA relative to that of 12m array. Set 0 for no ACA observation. For Cycle-1 with ACA, set acaratio = 3.
Definition at line 17 of file parameter_dictionary.py.
| def parameter_dictionary.par.accumtime | ( | ) | [static] |
Cumulative table timescale when creating from scratch. This is the sampling interval upon which to accumulate *if* an input calibration table (tablein) has not been specified. [units=seconds]
Definition at line 25 of file parameter_dictionary.py.
| def parameter_dictionary.par.addwn | ( | ) | [static] |
addwn -- additional wave number(s) of sinusoids to be used
for fitting.
(list) and (int) are accepted to specify every
wave numbers. also (str) can be used in case
you need to specify wave numbers in a certain range,
example: 'a-b' (= a, a+1, a+2, ..., b-1, b),
'<a' (= 0,1,...,a-2,a-1),
'>=a' (= a, a+1, ... up to the maximum wave
number corresponding to the Nyquist
frequency for the case of FFT).
default: []
Definition at line 31 of file parameter_dictionary.py.
| def parameter_dictionary.par.alg | ( | ) | [static] |
alg -- Algorithm to use:
default: 'csclean'; example: alg='clark';
Options: 'clark','hogbom','csclean'
csclean is Cotton-Schwab and cleans entire image
hogbom and clark clean inner quarter of imageDefinition at line 47 of file parameter_dictionary.py.
| def parameter_dictionary.par.algorithm | ( | ) | [static] |
algorithm -- autoflag algorithm name
default: 'timemed'
options: 'timemed','freqmed','uvbin','sprej'
column -- the column on which to operate (DATA, CORRECTED, MODEL)
expr -- expression to use
default: 'ABS I'; example: expr='RE XX'
Options: 'ABS','ARG','RE','IM','NORM' + ' ' + 'I','XX','YY','RR','LL'
thr -- flagging threshold as a multiple of standard-deviation ( n sigma )
window -- half width for sliding window median filters
Definition at line 58 of file parameter_dictionary.py.
| def parameter_dictionary.par.antenna | ( | ) | [static] |
antenna -- Select data by antenna/baseline
default: 0 for sdimaging, '' (means all) for the other tasks
Non-negative integers are assumed to be antenna indices, and
anything else is taken as an antenna name.
Examples:
antenna='5&6': baseline between antenna index 5 and index 6.
antenna='VA05&VA06': baseline between VLA antenna 5 and 6.
antenna='5&6:7&8': baselines 5-6 and 7-8
antenna='5': all baselines with antenna 5
antenna='5,6,10': all baselines including antennas 5, 6, or 10
antenna='5,6,10&': all baselines with *only* antennas 5, 6, or 10
(cross-correlations only. Use && to include
autocorrelations, and &&& to get only
autocorrelations.)
antenna='!ea03,ea12,ea17': all baselines except those that include
EVLA antennas ea03, ea12, or ea17
---
(for single dish tasks except for sdimaging and sdtpimaging)
antenna -- antenna name or id (only effective for MS input)
antenna selection syntax doesn't work since current
single dish tasks is not able to handle multiple
antenna simultaneously
Definition at line 74 of file parameter_dictionary.py.
Referenced by task_sdmath.sdmath_worker.execute(), task_sdsmooth.sdsmooth_worker.initialize_scan(), task_sdplot.sdplot_worker.initialize_scan(), task_sdcal.sdcal_worker.initialize_scan(), task_sdfit.sdfit_worker.initialize_scan(), task_sdbaseline.sdbaseline_worker.initialize_scan(), task_sdstat.sdstat_worker.initialize_scan(), and task_sdflag.sdflag_worker.initialize_scan().
| def parameter_dictionary.par.antennalist | ( | ) | [static] |
antennalist -- antenna position ascii file (each row has x y z diam)
Definition at line 103 of file parameter_dictionary.py.
| def parameter_dictionary.par.antnamescheme | ( | ) | [static] |
antnamescheme -- 'old' or 'new' antenna names.
default = 'new' gives antnenna names
'VA04' for VLA telescope 4 or
'EA13' for EVLA telescope 13.
'old' gives names '4' and '13'
Definition at line 109 of file parameter_dictionary.py.
| def parameter_dictionary.par.append | ( | ) | [static] |
Append calibration solutions to an existing calibration table. Options: True, False Fluxscale: append -- Append solutions to the table. default: False; (will overwrite if already existing) example: append=True
Definition at line 119 of file parameter_dictionary.py.
| def parameter_dictionary.par.applyfft | ( | ) | [static] |
Automatically set wave numbers of sinusoids. options: True, False default: True
Definition at line 132 of file parameter_dictionary.py.
| def parameter_dictionary.par.asdm | ( | ) | [static] |
Input ALMA Science Data Model observation.
Definition at line 140 of file parameter_dictionary.py.
| def parameter_dictionary.par.async | ( | ) | [static] |
Run task in a separate process (return CASA prompt) default: False; example: async=True
Definition at line 144 of file parameter_dictionary.py.
| def parameter_dictionary.par.autocorr | ( | ) | [static] |
autocorr -- Flag autocorrelations ?
default: False
options: True,False
importvla:
autocorr -- import autocorrelations to ms
default = False (no autocorrelations)Definition at line 149 of file parameter_dictionary.py.
| def parameter_dictionary.par.average | ( | ) | [static] |
average -- averaging on spectral data default: False options: True, False
Definition at line 162 of file parameter_dictionary.py.
| def parameter_dictionary.par.averageall | ( | ) | [static] |
averageall -- average multi-resolution spectra
spectra are averaged by referring
their frequency coverage
default: False
options: True, False
Definition at line 171 of file parameter_dictionary.py.
Referenced by task_sdcal.sdcal_worker.execute().
| def parameter_dictionary.par.avg_limit | ( | ) | [static] |
avg_limit -- channel averaging for broad lines
default: 4
example: a number of consecutive channels not greater than
this parameter can be averaged to search for broad lines
Definition at line 181 of file parameter_dictionary.py.
Referenced by task_sdfit.sdfit_worker._set_linelist_auto().
| def parameter_dictionary.par.axis | ( | ) | [static] |
axis -- The moment axis (0-based) default: 3 (spectral axis); example: axis=3
Definition at line 190 of file parameter_dictionary.py.
| def parameter_dictionary.par.backup | ( | ) | [static] |
backup -- set True to create backup for input data default: True
Definition at line 196 of file parameter_dictionary.py.
Referenced by task_sdtpimaging.sdtpimaging_worker.__backup().
| def parameter_dictionary.par.bandname | ( | ) | [static] |
VLA frequency band. Options: '4' = 48 -96 MHz 'P' = 298 - 345 MHz 'L' = 1.15 - 1.75 GHz 'C' = 4.2 - 5.1 GHz 'X' = 6.8 - 9.6 GHz 'U' = 13.5 - 16.3 GHz 'K' = 20.8 - 25.8 GHz 'Q' = 38 -51 GHz
Definition at line 203 of file parameter_dictionary.py.
| def parameter_dictionary.par.bandtype | ( | ) | [static] |
Type of bandpass solution ('B', 'BPOLY'). Definition at line 218 of file parameter_dictionary.py.
| def parameter_dictionary.par.baseline | ( | ) | [static] |
baseline -- Baseline index identifiers default: [-1] (all); example: baseline=[0,6,11]
Definition at line 222 of file parameter_dictionary.py.
| def parameter_dictionary.par.beamsize | ( | ) | [static] |
beamsize -- beam size default: 0.0 example: 10.0 (interpreted as '10 arcsec'), '1arcmin'
Definition at line 229 of file parameter_dictionary.py.
Referenced by task_sdimprocess.sdimprocess_worker.__execute_press().
| def parameter_dictionary.par.bitpix | ( | ) | [static] |
bitpix -- Bits per pixel default: -32 (floating point) <Options: -32 (floating point), 16 (integer)>
Definition at line 237 of file parameter_dictionary.py.
| def parameter_dictionary.par.blfunc | ( | ) | [static] |
blfunc -- baseline model function options: (str) 'poly','cspline','sinusoid' default: 'poly' example: blfunc='poly' uses a single polynomial line of any order which should be given as an expandable parameter 'order' to fit baseline. blfunc='cspline' uses a cubic spline function, a piecewise cubic polynomial having C2-continuity (i.e., the second derivative is continuous at the joining points). blfunc='sinusoid' uses a combination of sinusoidal curves.
Definition at line 245 of file parameter_dictionary.py.
| def parameter_dictionary.par.box | ( | ) | [static] |
box -- A box region in the directional portion of an image. The directional portion of an image are the axes for right ascension and declination, for example. Boxes are specified by there bottom-left corner (blc) and top-right corner (trc) as follows: blcx, blcy, trcx, trcy; ONLY pixel values acceptable at this time. Default: none (all); Example: box='0,0,50,50' Example: box='10,20,30,40,100,100,150,150'
Definition at line 260 of file parameter_dictionary.py.
| def parameter_dictionary.par.box_size | ( | ) | [static] |
box_size -- running mean box size default: 0.2 example: a running mean box size specified as a fraction of the total spectrum length
Definition at line 274 of file parameter_dictionary.py.
Referenced by task_sdfit.sdfit_worker._set_linelist_auto().
| def parameter_dictionary.par.bptable | ( | ) | [static] |
Bandpass calibration solutions table:
Definition at line 283 of file parameter_dictionary.py.
| def parameter_dictionary.par.caldescid | ( | ) | [static] |
Calibrator data description index identifier. A unique data description identifier describes a single combination of spectral window and polarization:
Definition at line 287 of file parameter_dictionary.py.
| def parameter_dictionary.par.calfield | ( | ) | [static] |
List of field names in the incremental calibration table to use. calfield specifies the names to select from 'incrtable' when applying to 'tablein'. See syntax in 'help par.selectdata' - same as for field parameter.
Definition at line 292 of file parameter_dictionary.py.
| def parameter_dictionary.par.calmode | ( | ) | [static] |
(for sdcal, sdreduce, sdtpimaging)
calmode -- SD calibration mode
options: 'ps', 'nod', 'fs', 'fsotf', 'quotient', 'none' (for sdcal/sdreduce)
'baseline', 'none' (for sdtpimaging)
default: 'none'
example: choose 'none' if you have already calibrated
WARNING: 'fsotf' is not implemented yet
-----------------------------------------------------------
(for the other tasks)
calmode -- Solutions to solve for when using the gaincal task.
options: 'p', 'a', and 'ap'.
Definition at line 303 of file parameter_dictionary.py.
| def parameter_dictionary.par.calselect | ( | ) | [static] |
Optional subset of calibration data to select (e.g., field name):
Definition at line 322 of file parameter_dictionary.py.
| def parameter_dictionary.par.caltable | ( | ) | [static] |
Output calibration table:
Definition at line 326 of file parameter_dictionary.py.
| def parameter_dictionary.par.calwt | ( | ) | [static] |
Apply calibration to data weights in addition to the visibilities (boolean):
Definition at line 330 of file parameter_dictionary.py.
| def parameter_dictionary.par.cell | ( | ) | [static] |
(for sdimaging, sdtpimaging)
cell -- x and y cell size. default unit arcmin.
default: ['1.0arcmin', '1.0arcmin']
example: cell=['0.2arcmin', '0.2arcmin']
cell='0.2arcmin' (equivalent to example above)
-----------------------------------------------------
(for simanalyze)
cell -- output cell/pixel size
default: '' # uses incell value for the output cell size
example: '0.1arcsec'
-----------------------------------------------------
(for sdgrid)
cell -- x and y cell size. default unit arcsec
default: '' (automatically calculated from npix if it is
set, otherwise '1.0arcmin')
example: cell=['0.2arcmin, 0.2arcmin']
cell='0.2arcmin' (equivalent to example above)
cell=12.0 (interpreted as '12.0arcsec'='0.2arcmin')
Definition at line 335 of file parameter_dictionary.py.
Referenced by task_sdplot.sdplot_worker.__get_grid_parameters().
| def parameter_dictionary.par.center | ( | ) | [static] |
center -- grid center
default: '' (automatically calculated from the data)
example: 'J2000 13h44m00 -17d02m00'
['05:34:48.2', '-05.22.17.7'] (in J2000 frame)
[1.46, -0.09] (interpreted as radian in J2000 frame)
Definition at line 362 of file parameter_dictionary.py.
Referenced by task_sdplot.sdplot_worker.__get_grid_parameters(), and task_sdplot.sdplot_worker.plot_grid().
| def parameter_dictionary.par.channelrange | ( | ) | [static] |
channelrange -- channel range selection
default: [] #use all channel
example: [0, 5000]
Note that specified values are recognized as
'channel' regardless of the value of specunit
Definition at line 372 of file parameter_dictionary.py.
Referenced by task_sdcal.sdcal_worker.execute().
| def parameter_dictionary.par.chans | ( | ) | [static] |
Range of channels:
uvcontsub - It takes a simple list of channels or anything that will
produce such a list of integer channel values:
examples chans=[0,1,2,3,55,56,57,58,59,60,61]
chans=range(0,4)+range(55,62)
immath, imstat, and imcontsub - It takes a string listing of channel
numbers, much like the spw paramter such as:
examples chans="0,3,4,8"
chans="3~20;50,51" #channels 3to20 and 50 and 51
chans="<10;>=55" #chanls 0to9 and 55 and greater (inclusively)Definition at line 382 of file parameter_dictionary.py.
| def parameter_dictionary.par.chanwidth | ( | ) | [static] |
chanwidth -- channel width default: '5' (for sdsmooth) or '10MHz' (for the other tasks)
Definition at line 398 of file parameter_dictionary.py.
| def parameter_dictionary.par.circ | ( | ) | [static] |
circ -- A circle region in the directional portion of an image. The directional portion of an image are the axes for right ascension and declination, for example. Circles are specified by there center and radius as follows: cx, xy, r ONLY pixel values acceptable at this time. Default: none (all); Example: circ='[10,10,5];[105,110,10]' # defines 2 cirlces
Definition at line 405 of file parameter_dictionary.py.
| def parameter_dictionary.par.cleanbox | ( | ) | [static] |
cleanbox -- Cleaning region: default: [] defaults to inner quarter of image Two specification types: Explicit pixel ranges example: cleanbox=[110,110,150,145] cleans one regiong defined by the pixel ranges Filename with pixel values with ascii format: <fieldindex blc-x blc-y trc-x trc-y> on each line
Definition at line 417 of file parameter_dictionary.py.
| def parameter_dictionary.par.clearpanel | ( | ) | [static] |
clearpanel -- Don't clear any of the plots, clear any areas affected by current plot, clear the current plotting area only, or clear the whole plot panel. options: None, Auto, Current, All default: Auto example: clearpanel='Current'
Definition at line 429 of file parameter_dictionary.py.
| def parameter_dictionary.par.clip | ( | ) | [static] |
clip -- flag data that are outside a specified range options: (bool)True,False default: False
Definition at line 440 of file parameter_dictionary.py.
Referenced by task_sdflag.sdflag_worker.command_flag(), and task_sdflag.sdflag_worker.prior_plot().
| def parameter_dictionary.par.clipcolumn | ( | ) | [static] |
clipcolumn -- Column to use for clipping. default: 'DATA' options: 'DATA','CORRECTED','MODEL'
Definition at line 448 of file parameter_dictionary.py.
| def parameter_dictionary.par.clipcorr | ( | ) | [static] |
Defines the correlation to clip. Options are: 'I','RR','LL','XX','LL'
Definition at line 456 of file parameter_dictionary.py.
| def parameter_dictionary.par.clipexpr | ( | ) | [static] |
clipexpr -- Clip using the following: default: 'ABS I'; example: clipexpr='RE XX' Options: 'ABS','ARG','RE','IM','NORM' + ' ' + 'I','XX','YY','RR','LL'
Definition at line 463 of file parameter_dictionary.py.
| def parameter_dictionary.par.clipfunction | ( | ) | [static] |
Defines the function used in evaluating data for clipping. Options are: 'ABS','ARG','RE','IM','NORM'
Definition at line 471 of file parameter_dictionary.py.
| def parameter_dictionary.par.clipminmax | ( | ) | [static] |
(for flagdata) clipminmax -- Range of data (Jy) that will NOT be flagged default: [] means do not use clip option example: [0.0,1.5] ----------------------------------------------------- (for sdgrid) clipminmax -- do min/max cliping if True default: False
Definition at line 478 of file parameter_dictionary.py.
Referenced by task_sdgrid.sdgrid_worker.execute().
| def parameter_dictionary.par.clipniter | ( | ) | [static] |
clipniter -- maximum number of iteration in spline fitting default: 1
Definition at line 493 of file parameter_dictionary.py.
| def parameter_dictionary.par.clipoutside | ( | ) | [static] |
clipoutside -- Clip OUTSIDE the range ? default: True example: False -> flag data WITHIN the range.
Definition at line 500 of file parameter_dictionary.py.
Referenced by task_sdflag.sdflag_worker.do_clip(), and task_sdflag.sdflag_worker.prior_plot().
| def parameter_dictionary.par.clipthresh | ( | ) | [static] |
clipthresh -- clipping threshold for iterative spline fitting default: 3
Definition at line 508 of file parameter_dictionary.py.
| def parameter_dictionary.par.colormap | ( | ) | [static] |
colormap -- the colours to be used for plot lines
default: None
example: colormap='green red black cyan magenta' (HTML standard)
colormap='g r k c m' (abbreviation)
colormap='#008000 #00FFFF #FF0090' (RGB tuple)
The plotter will cycle through these colours
when lines are overlaid (stacking mode)
Definition at line 515 of file parameter_dictionary.py.
Referenced by task_sdplot.sdplot_worker.__setup_plotter().
| def parameter_dictionary.par.combinespw | ( | ) | [static] |
combinespw -- Combine all spectral windows at one time default: True; all spectral windows must have same shape. successful aips transferral must have default=true
Definition at line 527 of file parameter_dictionary.py.
| def parameter_dictionary.par.comment | ( | ) | [static] |
comment -- Short description of a versionname (used for mode='save') default: ''; example: comment='Clip above 1.85' comment = versionname
Definition at line 536 of file parameter_dictionary.py.
Referenced by task_sdflagmanager.sdflagmanager_worker.execute().
| def parameter_dictionary.par.complist | ( | ) | [static] |
complist -- Name of component list default: None; ; example: complist='test.cl' components tool not yet available
Definition at line 544 of file parameter_dictionary.py.
| def parameter_dictionary.par.comptype | ( | ) | [static] |
comptype -- component model type default: 'P'; example: comptype='G' <Options: 'P' (point source), 'G' (gaussian), 'D' (elliptical disk)>
Definition at line 553 of file parameter_dictionary.py.
| def parameter_dictionary.par.concatvis | ( | ) | [static] |
concatvis -- Name of visibility file to append to the input' default: none; example: concatvis='src2.ms'
Definition at line 561 of file parameter_dictionary.py.
| def parameter_dictionary.par.connect | ( | ) | [static] |
connect -- Specifies what points to join with lines, when the
plotsymbol specifies line drawing. Valid values
include: 'none'(no connections), 'row' (along time and baseline),
and 'chan' (joined along channels).
default: 'none'; example: connect='chan'
Definition at line 568 of file parameter_dictionary.py.
| def parameter_dictionary.par.constpb | ( | ) | [static] |
Used in Sault weighting, the flux scale is constant above this value:
Definition at line 578 of file parameter_dictionary.py.
| def parameter_dictionary.par.constrainflux | ( | ) | [static] |
constrainflux -- Constrain image to match target flux; otherwise, targetflux is used to initialize model only. default: False; example: constrainflux=True
Definition at line 582 of file parameter_dictionary.py.
| def parameter_dictionary.par.contfile | ( | ) | [static] |
contfile -- Name of output continuum image Default: none; Example: contfile='ngc5921_cont.im'
Definition at line 590 of file parameter_dictionary.py.
| def parameter_dictionary.par.convsupport | ( | ) | [static] |
convsupport -- convolution support for 'SF' default: -1 (use default for each gridfunction) example: 3
Definition at line 597 of file parameter_dictionary.py.
Referenced by task_sdimaging.sdimaging_worker.execute().
| def parameter_dictionary.par.correlations | ( | ) | [static] |
correlation -- Select correlators: default: 'RR LL' both parallel hands. Other options are '' (all stokes),'RR','LL','RR LL','XX','YY','XX YY','LR','RL','LR RL','RL LR'
Definition at line 612 of file parameter_dictionary.py.
| def parameter_dictionary.par.createimage | ( | ) | [static] |
createimage -- do imaging? default: False
Definition at line 605 of file parameter_dictionary.py.
Referenced by task_sdtpimaging.sdtpimaging_worker.compile(), and task_sdtpimaging.sdtpimaging_worker.execute().
| def parameter_dictionary.par.cyclefactor | ( | ) | [static] |
cyclefactor -- Change the threshold at which the deconvolution cycle will stop and degrid and subtract from the visibilities. For bad PSFs, reconcile often (cyclefactor=4 or 5); For good PSFs, use cyclefactor 1.5 to 2.0. default: 1.5; example: cyclefactor=4 <cycle threshold = cyclefactor * max sidelobe * max residual>
Definition at line 621 of file parameter_dictionary.py.
| def parameter_dictionary.par.cyclespeedup | ( | ) | [static] |
cyclespeedup -- Cycle threshold doubles in this number of iterations default: -1; example: cyclespeedup=500
Definition at line 632 of file parameter_dictionary.py.
| def parameter_dictionary.par.datacolumn | ( | ) | [static] |
Which data column to use (for plotting, splitting, etc):
plotxy: Visibility file (MS) data column
default: 'data'; example: datacolumn='model'
Options: 'data' (raw),'corrected','model','residual'(corrected-model),'weight'
split: Visibility file (MS) data column
default: 'corrected'; example: datacolumn='data'
Options: 'data' (raw), 'corrected', 'model', 'all',
'float_data' (single dish), 'lag_data',
'float_data,data', and 'lag_data,data'.
note: 'all' = whichever of the above that are present.
Definition at line 639 of file parameter_dictionary.py.
| def parameter_dictionary.par.degamp | ( | ) | [static] |
Polynomial degree for amplitude bandpass solutions.
Definition at line 655 of file parameter_dictionary.py.
| def parameter_dictionary.par.deglast | ( | ) | [static] |
deglast -- Put degenerate axes last in header? default: False; example: deglast=True
Definition at line 659 of file parameter_dictionary.py.
| def parameter_dictionary.par.degphase | ( | ) | [static] |
Polynomial degree for phase bandpass solutions.
Definition at line 666 of file parameter_dictionary.py.
| def parameter_dictionary.par.direction | ( | ) | [static] |
(for sdimprocess) direction -- scan direction in unit of degree default: [] example: [0.0, 90.0] --------------------------------------------- (for simobserve) direction -- center of map or "" to center on the model * can optionally be a list of pointings, which will override pointingspacing. When direction is a list, the centroid of direction will be used as the center. * otherwise simobserve will fill mapsize according to maptype default: "" example: 'J2000 19h00m00 -40d00m00'
Definition at line 670 of file parameter_dictionary.py.
| def parameter_dictionary.par.dirtol | ( | ) | [static] |
dirtol -- Direction shift tolerance for considering data as the same field default: ;; means always combine example: dirtol='1.arcsec' will not combine data for a field unless their phase center is less than 1 arcsec.
Definition at line 690 of file parameter_dictionary.py.
| def parameter_dictionary.par.dochannelmap | ( | ) | [static] |
dochannelmap -- channel map image or total power image options: True (channel map), False (total power) default: False (total power)
Definition at line 699 of file parameter_dictionary.py.
| def parameter_dictionary.par.doppler | ( | ) | [static] |
doppler -- doppler mode options: 'RADIO', 'OPTICAL', 'Z', 'BETA', 'GAMMA' default: currently set doppler in scantable
Definition at line 707 of file parameter_dictionary.py.
Referenced by task_sdplot.sdplot_worker.initialize_scan(), and task_sdplot.sdplot_worker.plot_grid().
| def parameter_dictionary.par.dropdeg | ( | ) | [static] |
dropdeg -- Drop degenerate axes? default: False; example: dropdeg=True
Definition at line 715 of file parameter_dictionary.py.
| def parameter_dictionary.par.edge | ( | ) | [static] |
edge -- channels to drop at beginning and end of spectrum
default: 0
example: [1000] drops 1000 channels at beginning AND end
[1000,500] drops 1000 from beginning and 500 from end
Definition at line 722 of file parameter_dictionary.py.
Referenced by task_sdfit.sdfit_worker._set_linelist_auto().
| def parameter_dictionary.par.ephemsrcname | ( | ) | [static] |
ephemsrcname -- ephemeris source name for moving source default: '' if the source name in the data matches one of the known solar objects by the system, the tasks sdimaging and sdtpimaging automatically set the source name
Definition at line 731 of file parameter_dictionary.py.
Referenced by task_sdtpimaging.sdtpimaging_worker.__execute_imaging().
| def parameter_dictionary.par.estfile | ( | ) | [static] |
estfile -- Name of the file containing an image profile fit
estimate.
default:; example: estfile='myimage.estimate'
Definition at line 741 of file parameter_dictionary.py.
| def parameter_dictionary.par.estimate | ( | ) | [static] |
estimate -- Create an estimate of the profile (yes/no)? default: False; example: estimate=True
Definition at line 749 of file parameter_dictionary.py.
| def parameter_dictionary.par.excludemask | ( | ) | [static] |
excludemask -- Range of masks to exclude default: [-1] (don't exclude channels); example=[100,200]
Definition at line 763 of file parameter_dictionary.py.
| def parameter_dictionary.par.excludepix | ( | ) | [static] |
excludepix -- Range of pixel values to exclude default: [-1] (don't exclude pixels); example=[100.,200.]
Definition at line 756 of file parameter_dictionary.py.
| def parameter_dictionary.par.expr | ( | ) | [static] |
expr -- mathematical expression using scantables
default: ''
example: expr='("orion_on.asap"-"orion_off.asap")/"orion_off.asap"'
In the expression, input file names should be put inside
of single or double quotes
Definition at line 770 of file parameter_dictionary.py.
| def parameter_dictionary.par.factor | ( | ) | [static] |
factor -- scaling factor default: 1.0 (no scaling)
Definition at line 781 of file parameter_dictionary.py.
| def parameter_dictionary.par.fftmethod | ( | ) | [static] |
fftmethod -- ethod to be used when applyfft=True. options: 'fft' default: 'fft'
Definition at line 788 of file parameter_dictionary.py.
| def parameter_dictionary.par.fftthresh | ( | ) | [static] |
fftthresh -- threshold to select wave numbers to be used for
sinusoidal fitting. both (float) and (str) accepted.
given a float value, the unit is set to sigma.
for string values, allowed formats include:
example: '3sigma' (= 3-sigma level)
'3' (= 3-sigma level)
'top5' (= the 5 strongest ones)
default: 3.0 (unit: sigma).
Definition at line 796 of file parameter_dictionary.py.
| def parameter_dictionary.par.field | ( | ) | [static] |
field -- Select field using field id(s) or field name(s).
[run listobs to obtain the list ids or names]
default: 0 (for sdimaging)
'' = all fields (for the other ASAP tasks)
If field string is a non-negative integer, it is assumed a field index
otherwise, it is assumed a field name
field='0~2'; field ids 0,1,2
field='0,4,5~7'; field ids 0,4,5,6,7
field='3C286,3C295'; field named 3C286 adn 3C295
field = '3,4C*'; field id 3, all names starting with 4C
This selection is in addition to scanlist, iflist, and pollist.
See help par.selectdata for additional syntax.
See specific task for any additional details.
Definition at line 809 of file parameter_dictionary.py.
References alma-ngc3256-analysis-regression.name.
| def parameter_dictionary.par.fieldid | ( | ) | [static] |
Field index identifier; 0-based.
Definition at line 829 of file parameter_dictionary.py.
| def parameter_dictionary.par.figfile | ( | ) | [static] |
File name to store the plotte figure in. File format
is determined by the file extension '.png' is
recommended.
Definition at line 833 of file parameter_dictionary.py.
| def parameter_dictionary.par.fitfunc | ( | ) | [static] |
fitfunc -- function for fitting options: 'gauss', 'lorentz' default: 'gauss'
Definition at line 840 of file parameter_dictionary.py.
Referenced by task_sdfit.sdfit_worker.__initial_guess(), and task_sdfit.sdfit_worker.__store_fit().
| def parameter_dictionary.par.fitmode | ( | ) | [static] |
(for sdfit)
fitmode -- mode for fitting
options: 'list', 'auto', 'interact'
default: 'auto'
example: 'list' will use maskline to define regions to
fit for lines with nfit in each
'auto' will use the linefinder to fir for lines
using the following parameters
'interact' allows adding and deleting mask
regions by drawing rectangles on the plot
with mouse. Draw a rectangle with LEFT-mouse
to ADD the region to the mask and with RIGHT-mouse
to DELETE the region
-------------------------------------------------------------------
(for uvcontsub)
fitmode -- use of the continuum fit model
options: 'subtract' -- store continuum model and subtract from data
'replace' -- replace vis with continuum model
'model' -- only store continuum model
default: 'subtract'
Definition at line 848 of file parameter_dictionary.py.
| def parameter_dictionary.par.fitorder | ( | ) | [static] |
Polynomial order for fit:
Definition at line 875 of file parameter_dictionary.py.
| def parameter_dictionary.par.fitsfile | ( | ) | [static] |
Name of input UV FITS file:
Definition at line 879 of file parameter_dictionary.py.
| def parameter_dictionary.par.fitsimage | ( | ) | [static] |
fitsimage -- Name of input image FITS file default: none; example='3C273XC1.fits'
Definition at line 883 of file parameter_dictionary.py.
| def parameter_dictionary.par.fixpar | ( | ) | [static] |
fixpar -- Control which parameters to let vary in the fit default: [] (all vary); example: vary=[False,True,True] (this would fix the flux to that set in sourcepar but allow the x and y offset positions to be fit).
Definition at line 890 of file parameter_dictionary.py.
| def parameter_dictionary.par.flaglist | ( | ) | [static] |
flaglist -- list of scan numbers to flag (ranges can be accepted)
default: [] (use all scans)
example: [[0,3],80]
flag the scan range [0,3] = [0,1,2,3] and scan 80
Definition at line 899 of file parameter_dictionary.py.
Referenced by task_sdtpimaging.sdtpimaging_worker.__execute_flag().
| def parameter_dictionary.par.flagmode | ( | ) | [static] |
flagmode -- flag mode
options: 'flag', 'unflag', 'restore'
in 'restore' mode, a history of flagging is
displayed and current flag state is returned
default: 'flag'
Definition at line 908 of file parameter_dictionary.py.
Referenced by task_sdflag.sdflag_worker.command_flag(), task_sdflag.sdflag_worker.posterior_plot(), and task_sdflag.sdflag_worker.prior_plot().
| def parameter_dictionary.par.flagrow | ( | ) | [static] |
flagrow -- list of row numbers to apply flag/unflag (row based) default: [] (no row selection) example: [0,2,3] This parameter is effective only when one or more row numbers are given explicitly and also clip=False
Definition at line 918 of file parameter_dictionary.py.
Referenced by task_sdflag.sdflag_worker.command_flag(), task_sdflag.sdflag_worker.do_row_flag(), and task_sdflag.sdflag_worker.prior_plot().
| def parameter_dictionary.par.flrange | ( | ) | [static] |
flrange -- range for flux axis of plot for spectral plotting options: (list) [min,max] default: [] (full range) example: flrange=[-0.1,2.0] if 'K' assumes current fluxunit
Definition at line 929 of file parameter_dictionary.py.
| def parameter_dictionary.par.fluxdensity | ( | ) | [static] |
fluxdensity -- Specified flux density [I,Q,U,V] in Jy default=-1, which causes setjy to look up standard I flux densities Otherwise, use the specified flux density. If a model image is also specified, only stokes I will be used. example: fluxdensity=[2.63,0.21,-0.33,0.02]
Definition at line 938 of file parameter_dictionary.py.
| def parameter_dictionary.par.fluxtable | ( | ) | [static] |
fluxtable -- Name of output, flux-scaled calibration table
default: none; example: fluxtable='ngc5921.gcal2'
This gains in this table have been corrected after the
flux density determination of each source. The MODEL_DATA
column has NOT been updated for the flux density of the
calibrator. Use setjy to do this. see task correct for more
information.
Definition at line 948 of file parameter_dictionary.py.
| def parameter_dictionary.par.fluxunit | ( | ) | [static] |
fluxunit -- units for line flux options: 'K', 'Jy', '' default: '' (keep current fluxunit) For GBT data, see description for par.telescopeparm
Definition at line 960 of file parameter_dictionary.py.
Referenced by task_sdmath.sdmath_worker.execute(), task_sdplot.sdplot_worker.initialize_scan(), task_sdplot.sdplot_worker.plot_grid(), and task_sdmath.sdmath_worker.save().
| def parameter_dictionary.par.fontsize | ( | ) | [static] |
fontsize -- Font size for labels default: 10; example: fontsize=2
Definition at line 970 of file parameter_dictionary.py.
| def parameter_dictionary.par.format | ( | ) | [static] |
format -- format string to print statistic values default: '3.3f'
Definition at line 977 of file parameter_dictionary.py.
| def parameter_dictionary.par.frame | ( | ) | [static] |
frame -- frequency frame for spectral axis
options: 'LSRK', 'REST', 'TOPO', 'LSRD', 'BARY',
'GEO', 'GALACTO', 'LGROUP', 'CMB'
default: currently set frame in scantable
WARNING: frame='REST' not yet implemented
Definition at line 984 of file parameter_dictionary.py.
Referenced by task_sdplot.sdplot_worker.initialize_scan(), and task_sdplot.sdplot_worker.plot_grid().
| def parameter_dictionary.par.freqdep | ( | ) | [static] |
Solve for frequency dependent solutions Default: False (gain; True=bandpass); example: freqdep=True
Definition at line 994 of file parameter_dictionary.py.
| def parameter_dictionary.par.freqtol | ( | ) | [static] |
freqtol -- Frequency shift tolerance for considering data as the same spwid default: '' means always combine example: freqtol='10MHz' will not combine spwid unless they are within 10 MHz
Definition at line 1000 of file parameter_dictionary.py.
| def parameter_dictionary.par.frequencytol | ( | ) | [static] |
frequencytol -- Tolerance in frequency shift in making spectral windows default: 150000 (Hz). For Doppler shifted data, <10000 Hz may may produce too many unnecessary spectral windows. example: frequencytol = 1500000.0 (units = Hz)
Definition at line 1009 of file parameter_dictionary.py.
| def parameter_dictionary.par.ftmachine | ( | ) | [static] |
ftmachine -- Gridding method for the image; ft (standard interferometric gridding), sd (standard single dish) both (ft and sd as appropriate), mosaic (gridding use PB as conv fn) default: 'mosaic'; example: ftmachine='ft'
Definition at line 1018 of file parameter_dictionary.py.
| def parameter_dictionary.par.gain | ( | ) | [static] |
Loop gain for CLEANing:
Definition at line 1027 of file parameter_dictionary.py.
| def parameter_dictionary.par.gaincurve | ( | ) | [static] |
Apply VLA antenna gain curve correction:
Definition at line 1031 of file parameter_dictionary.py.
| def parameter_dictionary.par.gainfield | ( | ) | [static] |
Select a calibration table by field:
Definition at line 1041 of file parameter_dictionary.py.
| def parameter_dictionary.par.gaintable | ( | ) | [static] |
Gain calibration solutions table:
Definition at line 1045 of file parameter_dictionary.py.
| def parameter_dictionary.par.gaintype | ( | ) | [static] |
Type of gain calibration solution to solve for. This can be either 'G' or 'GSPLINE'.
Definition at line 1035 of file parameter_dictionary.py.
| def parameter_dictionary.par.getpt | ( | ) | [static] |
getpt -- fill DIRECTION column properly, or reuse POINTING table in original MS
(only effective for MS input)
default: True
options: True (fill DIRECTION column properly)
False (reuse POINTING table in original MS)
Definition at line 1049 of file parameter_dictionary.py.
| def parameter_dictionary.par.gridfunction | ( | ) | [static] |
gridfunction -- gridding function
options: 'BOX' (Box-car), 'SF' (Spheroidal),
'GAUSS' (Gaussian), 'PB' (Primary-beam),
'GJINC' (Gaussian*Jinc)
default: 'BOX'
'PB' is not implemented yet.
Definition at line 1059 of file parameter_dictionary.py.
Referenced by task_sdtpimaging.sdtpimaging_worker.__execute_imaging(), task_sdgrid.sdgrid_worker.execute(), and task_sdimaging.sdimaging_worker.execute().
| def parameter_dictionary.par.gwidth | ( | ) | [static] |
gwidth -- HWHM for gaussian. Effective only for
'GAUSS' and 'GJINC'.
default: '-1' (use default for each gridfunction)
example: 3, '20arcsec', '3pixel'
Definition at line 1070 of file parameter_dictionary.py.
Referenced by task_sdgrid.sdgrid_worker.execute(), and task_sdimaging.sdimaging_worker.execute().
| def parameter_dictionary.par.hditem | ( | ) | [static] |
hditem -- Header item to change default: ''; example: hditem='telescope' Options: 'object','telescope','observer'
Definition at line 1078 of file parameter_dictionary.py.
| def parameter_dictionary.par.hdvalue | ( | ) | [static] |
hdvalue -- Value to set Header item to
default: ''; example: hdvalue='VLA'
Examples:
hditem='epoch',hdvalue='2007/06/20/00:00:00'
hditem='beam',hdvalue=['55arcsec','55arcsec','0deg']
hditem='restfrequency',hdvalue='1.421GHz'
hditem='restfrequency',hdvalue='1.421GHz 115.272GHz'
hditem='projection',hdvalue='TAN'
hditem='cdelt4',hdvalue=24415.05
hditem='cdelt1',hdvalue=7.75e-5
Definition at line 1086 of file parameter_dictionary.py.
| def parameter_dictionary.par.header | ( | ) | [static] |
header -- print header information on plot options: (bool) True, False default: True
Definition at line 1101 of file parameter_dictionary.py.
| def parameter_dictionary.par.headsize | ( | ) | [static] |
headsize -- header font size options: (int) default: 9
Definition at line 1109 of file parameter_dictionary.py.
| def parameter_dictionary.par.highres | ( | ) | [static] |
Name of high resolution (interferometer) image:
Definition at line 1117 of file parameter_dictionary.py.
| def parameter_dictionary.par.histogram | ( | ) | [static] |
histogram -- plot histogram options: (bool) True, False default: False
Definition at line 1121 of file parameter_dictionary.py.
| def parameter_dictionary.par.iflist | ( | ) | [static] |
iflist -- list of IF id numbers to select default: [] (use all IFs) example: [15] This selection is in addition to scanlist, field, and pollist
Definition at line 1129 of file parameter_dictionary.py.
| def parameter_dictionary.par.ifno | ( | ) | [static] |
ifno -- IFNO to be gridded default: -1 (only process IFNO in the first row) example: 1
Definition at line 1139 of file parameter_dictionary.py.
Referenced by task_sdgrid.sdgrid_worker.execute().
| def parameter_dictionary.par.ignoreables | ( | ) | [static] |
Let time bins ignore boundaries in array, scan, and/or state.
default = '' (separate time bins by all of the above)
examples:
ignorables = 'scan': Can be useful when the scan number
goes up with each integration,
as in many WSRT MSes.
ignorables = ['array', 'state']: disregard array and state
IDs when time averaging.
ignorables = 'state,subarr': Same as above. ignorables
matches on 'arr', 'scan', and
'state'.
Definition at line 1147 of file parameter_dictionary.py.
| def parameter_dictionary.par.imagename | ( | ) | [static] |
(for boxit, deconvolve, exportfits, imcontsub, imfit, imhead,
immath, immoments, imregrid, imsmooth, imstat, imval,
and specfit)
imagename -- input image name(s)
------------------------------------------------------------
(for feather, importfits, and makemask)
imagename -- output image name
------------------------------------------------------------
(for autoclean, clean, mosaic, and widefield)
imagename -- pre-name of output image(s)
For output image files, imagename is followed by
'.residual', '.model', '.image', etc.
------------------------------------------------------------
Definition at line 1163 of file parameter_dictionary.py.
References casa.image, and alma-ngc3256-analysis-regression.name.
| def parameter_dictionary.par.imagermode | ( | ) | [static] |
imagermode -- Determines advanced imaging/gridding scheme.
options: '', 'mosaic', 'csclean'
default: '' means single field clean
example: imagermode='mosaic' (image fields as a mosaic)
imagermode='csclean' (use Cotton-schwab cleaning)
Definition at line 1186 of file parameter_dictionary.py.
| def parameter_dictionary.par.imsize | ( | ) | [static] |
imsize -- image pixel size [x,y]
default: [256,256]
example: imsize=[500,500]
imsize=500 (equivalent to [500,500])
Need not be a power of 2, but not a prime number
Definition at line 1196 of file parameter_dictionary.py.
| def parameter_dictionary.par.inbright | ( | ) | [static] |
(for simobserve) inbright -- peak surface brightness to scale input image in Jy/pixel. default: 'unchanged' [alert] If you specify 'unchanged' it will take the numerical values in your image and assume they are in Jy/pixel, even if it says some other unit in the header. This will be made more flexible in the future.
Definition at line 1206 of file parameter_dictionary.py.
| def parameter_dictionary.par.incell | ( | ) | [static] |
incell -- pixel size of the model image. options: 'header' or pixel size, e.g. '0.1arcsec' default: 'header'
Definition at line 1220 of file parameter_dictionary.py.
| def parameter_dictionary.par.includemask | ( | ) | [static] |
(for msmoments) includemask -- Range of masks to include default: [-1] (include all channels); example=[2,100]
Definition at line 1235 of file parameter_dictionary.py.
| def parameter_dictionary.par.includepix | ( | ) | [static] |
includepix -- Range of pixel values to include default: [-1] (all pixels); example=[0.02,100.0]
Definition at line 1228 of file parameter_dictionary.py.
| def parameter_dictionary.par.incremental | ( | ) | [static] |
incremental -- Add to the existing MODEL_DATA column? default: False; example: incremental=True
Definition at line 1243 of file parameter_dictionary.py.
| def parameter_dictionary.par.incrtable | ( | ) | [static] |
Input (incremental) calibration table (any type):
Definition at line 1250 of file parameter_dictionary.py.
| def parameter_dictionary.par.infile | ( | ) | [static] |
infile -- Input file name
Definition at line 1254 of file parameter_dictionary.py.
Referenced by task_sdtpimaging.sdtpimaging_worker.__backup(), task_sdtpimaging.sdtpimaging_worker.__execute_baseline(), task_sdtpimaging.sdtpimaging_worker.__execute_flag(), task_sdtpimaging.sdtpimaging_worker.__execute_imaging(), task_sdscale.sdscale_worker.__get_outform(), task_sdsave.sdsave_worker.cleanup(), task_sdimaging.sdimaging_worker.execute(), sdutil.sdtask_template.initialize(), sdutil.sdtask_template_imaging.initialize(), task_sdsmooth.sdsmooth_worker.initialize_scan(), task_sdplot.sdplot_worker.initialize_scan(), task_sdcal.sdcal_worker.initialize_scan(), task_sdfit.sdfit_worker.initialize_scan(), task_sdbaseline.sdbaseline_worker.initialize_scan(), task_sdstat.sdstat_worker.initialize_scan(), task_sdflag.sdflag_worker.initialize_scan(), and task_sdtpimaging.sdtpimaging_worker.parameter_check().
| def parameter_dictionary.par.infiles | ( | ) | [static] |
infiles -- Input file names
Definition at line 1260 of file parameter_dictionary.py.
Referenced by sdutil.sdtask_template.initialize(), and task_sdcoadd.sdcoadd_worker.merge().
| def parameter_dictionary.par.integration | ( | ) | [static] |
integration -- integration (sampling) time default: '10s'
Definition at line 1266 of file parameter_dictionary.py.
| def parameter_dictionary.par.intent | ( | ) | [static] |
Observing intent (a.k.a "scan intent") to be processed
default: '' (all)
examples: intent='*BANDPASS*' selects data labelled with BANDPASS intent
intent='*POINTING*,*BAND*' selects data labelled either with POINTING
or BAND
Definition at line 1273 of file parameter_dictionary.py.
| def parameter_dictionary.par.interactive | ( | ) | [static] |
(for sdflag) interactive -- determines interactive flagging options: True, False default: False ---------------------------------------------------------- (for sdstat) interactive -- determines interactive masking options: True, False default: False example: interactive=True allows adding and deleting mask regions by drawing rectangles on the plot with mouse. Draw a rectangle with LEFT-mouse to ADD the region to the mask and with RIGHT-mouse to DELETE the region. ---------------------------------------------------------- (for widefield) interactive -- use interactive clean (with GUI viewer) options: True, False default: False
Definition at line 1283 of file parameter_dictionary.py.
| def parameter_dictionary.par.interp | ( | ) | [static] |
Setting of the time-dependent interpolation scheme when applying calibration solutions. The options are: 'nearest' - calibrate each datum with the calibration value nearest in time. 'linear' - calibrate each datum with calibration phases and amplitudes linearly interpolated from neighboring (in time) values. In the case of phase, this mode will assume that phase jumps greater than 180 degrees between neighboring points indicate a cycle slip, and the interpolated value will follow this change in cycle accordingly. 'aipslin' - emulate the interpolation mode used in classic AIPS, i.e., linearly interpolated amplitudes, with phases derived from interpolation of the complex calibration values. While this method avoids having to track cycle slips (which is unstable for solutions with very low SNR), it will yield a phase interpolation which becomes increasingly non-linear as the spanned phase difference increases. The non-linearity mimics the behavior of interp='nearest' as the spanned phase difference approaches 180 degrees (the phase of the interpolated complex calibration value initially changes very slowly, then rapidly jumps to the second value at the midpoint of the interval). If the uncalibrated phase is changing rapidly, a 'nearest' interpolation is not desirable. Usually, interp='linear' is the best choice.
Definition at line 1310 of file parameter_dictionary.py.
| def parameter_dictionary.par.invertmask | ( | ) | [static] |
invertmask -- invert mask (EXCLUDE masklist instead) options: True, False default: False
Definition at line 1334 of file parameter_dictionary.py.
Referenced by task_sdfit.sdfit_worker._set_linelist_auto(), task_sdfit.sdfit_worker._set_linelist_interact(), and task_sdfit.sdfit_worker._set_linelist_list().
| def parameter_dictionary.par.iteration | ( | ) | [static] |
iteration -- Iterate plots: default: ''; no interation Options: 'field', 'antenna', 'baseline'. Use the 'NEXT' button on gui to iterate through values. To abort an iteration, close the gui window.
Definition at line 1342 of file parameter_dictionary.py.
| def parameter_dictionary.par.jwidth | ( | ) | [static] |
jwidth -- Width of jinc function. Effective only for
'GJINC'.
default: '-1' (use default for each gridfunction)
example: 3, '20arcsec', '3pixel'
Definition at line 1352 of file parameter_dictionary.py.
Referenced by task_sdgrid.sdgrid_worker.execute(), and task_sdimaging.sdimaging_worker.execute().
| def parameter_dictionary.par.kernel | ( | ) | [static] |
(for imsmooth) kernel -- type of kernel to use when smoothing. Currently, only gaussian is supported. options: 'gaussian', 'boxcar' default: 'gaussian' ----------------------------------------------------------- (for sdreduce, sdplot, and sdsmooth) kernel -- type of spectral smoothing options: 'none', 'hanning', 'gaussian', 'boxcar' default: 'hanning' for sdsmooth, 'none' for the other tasks
Definition at line 1361 of file parameter_dictionary.py.
| def parameter_dictionary.par.kwidth | ( | ) | [static] |
kwidth -- width of spectral smoothing kernel
options: (int) in channels
default: 5
example: 5 or 10 seem to be popular for boxcar
ignored for hanning (fixed at 5 chans)
(0 will turn off gaussian or boxcar)
Definition at line 1378 of file parameter_dictionary.py.
| def parameter_dictionary.par.legendloc | ( | ) | [static] |
legendloc -- legend location on the axes (0-10)
options: (integer) 0 -10
Note that 0 ('best') is very slow.
The list of legend positions:
0: best
1: upper right
2: upper left
3: lower left
4: lower right
5: right
6: center left
7: center right
8: lower center
9: upper center
10: center
default: 1 ('upper right')
Definition at line 1389 of file parameter_dictionary.py.
| def parameter_dictionary.par.linecat | ( | ) | [static] |
linecat -- control for line catalog plotting for spectral plotting
options: (str) 'all', 'none', or by molecule
default: 'none' (no lines plotted)
example: linecat='SiO' for SiO lines
linescat='*OH' for alcohols
uses sprange to limit catalog
Definition at line 1410 of file parameter_dictionary.py.
Referenced by task_sdplot.sdplot_worker.__overlay_linecatalog(), and task_sdplot.sdplot_worker.plot_spectra().
| def parameter_dictionary.par.linedop | ( | ) | [static] |
linedop -- doppler offset for line catalog plotting (spectral plotting) options: (float) doppler velocity (km/s) default: 0.0 example: linedop=-30.0
Definition at line 1421 of file parameter_dictionary.py.
Referenced by task_sdplot.sdplot_worker.__overlay_linecatalog().
| def parameter_dictionary.par.linefile | ( | ) | [static] |
linefile -- Name of output line image Default: none; Example: outline='ngc5921_line.im'
Definition at line 1430 of file parameter_dictionary.py.
| def parameter_dictionary.par.linestyles | ( | ) | [static] |
linestyles -- the linestyles to be used for plotting lines
default: None
example: linestyles='line dashed dotted dashdot dashdotdot dashdashdot'
The plotter will cycle through these linestyles
when lines are overlaid (stacking mode).
warning: linestyles can be specified only one color has been set.
Definition at line 1437 of file parameter_dictionary.py.
| def parameter_dictionary.par.linewidth | ( | ) | [static] |
linewidth -- Width of plotted lines. default: 1 example: linewidth=0.75
Definition at line 1449 of file parameter_dictionary.py.
| def parameter_dictionary.par.listfile | ( | ) | [static] |
listfile -- output file name (will not overwrite) default: '' (no output file)
Definition at line 1457 of file parameter_dictionary.py.
| def parameter_dictionary.par.lowres | ( | ) | [static] |
Name of low resolution (single dish) image:
Definition at line 1464 of file parameter_dictionary.py.
| def parameter_dictionary.par.margin | ( | ) | [static] |
margin -- a list of subplot margins in figure coordinate (0-1),
i.e., fraction of the figure width or height.
The order of elements should be:
[left, bottom, right, top, horizontal space btw panels,
vertical space btw panels]
Definition at line 1468 of file parameter_dictionary.py.
| def parameter_dictionary.par.markersize | ( | ) | [static] |
markersize -- Size of the plotted marks default: 1.0
Definition at line 1478 of file parameter_dictionary.py.
| def parameter_dictionary.par.mask | ( | ) | [static] |
In clean, name(s) of mask image(s) used for CLEANing.
In the image analysis tasks tool methods and tasks, a
mask can be specified two ways: 1. as a Lattice
Expression, which may be mask filename. The full
description of the syntax can be found at
http://www.astron.nl/aips++/docs/notes/223/node11.html,
eg
mask='mask(myimage.mask)'
mask='mask(otherimage:othermask)'
mask='myimage>0.5'
or 2. an image containing numerical valued pixels,
in which case pixels values >= 0.5 are masked True
(good) and < 0.5 are masked False (bad). This
functionality is primarily meant to support clean mask
images, but will work for any image with numerical
valued pixels. eg,
mask='mycleanmask.im'
Definition at line 1485 of file parameter_dictionary.py.
References casa.image, and alma-ngc3256-analysis-regression.name.
| def parameter_dictionary.par.maskcenter | ( | ) | [static] |
Controls how many channels at the center of each input spectral window are ignored on-the-fly. It is usually best to flag these channels directly.
Definition at line 1506 of file parameter_dictionary.py.
| def parameter_dictionary.par.maskedge | ( | ) | [static] |
Controls how many channels at the edge of each input spectral window are ignored on-the-fly. It is usually better to flag these channels directly.
Definition at line 1511 of file parameter_dictionary.py.
| def parameter_dictionary.par.maskflag | ( | ) | [static] |
maskflag -- list of mask regions to apply flag/unflag
default: [] (entire spectrum)
example: [[1000,3000],[5000,7000]]
warning: if one or more rows are given in flagrow, or
clip=True, this parameter is ignored
Definition at line 1516 of file parameter_dictionary.py.
Referenced by task_sdflag.sdflag_worker.command_flag(), and task_sdflag.sdflag_worker.execute().
| def parameter_dictionary.par.maskline | ( | ) | [static] |
maskline -- list of mask regions to INCLUDE in LINE fitting
default: all
example: maskline=[[3900,4300]] for a single region, or
maskline=[[3900,4300],[5000,5400]] for two, etc.
Definition at line 1526 of file parameter_dictionary.py.
Referenced by task_sdfit.sdfit_worker._set_linelist_auto(), task_sdfit.sdfit_worker._set_linelist_interact(), and task_sdfit.sdfit_worker._set_linelist_list().
| def parameter_dictionary.par.masklist | ( | ) | [static] |
(for sdbaseline and sdreduce)
masklist -- list or string of mask regions to INCLUDE in BASELINE fitting
a string masklist allows per IF selection of channels as the
parameter 'spw'. See the parameter help of 'spw' for more details.
default: [] (entire spectrum)
example: [[1000,3000],[5000,7000]]
'0:1000~3000;5000~7000, 1:200~350;450~600'
if blmode='auto' then this mask will be applied
before fitting
---------------------------------------------------------------
(for sdstat)
masklist -- list of mask regions to INCLUDE in stats
default: [] (entire spectrum)
example: [4000,4500] for one region
[[1000,3000],[5000,7000]] for two regions, etc.
---------------------------------------------------------------
(for sdtpimaging)
masklist -- mask in numbers of rows from each edge of each scan
for baseline fitting
default: none
example: [30,30] or [30]
uses first 30 rows and last 30 rows of each scan
for baseline
---------------------------------------------------------------
(for sdimprocess)
masklist -- mask width for Basket-Weaving on percentage
default: 1.0 (1.0% of map size)
Definition at line 1535 of file parameter_dictionary.py.
Referenced by task_sdimprocess.sdimprocess_worker.__execute_basket_weaving(), and task_sdbaseline.sdbaseline_engine.drive().
| def parameter_dictionary.par.maskmode | ( | ) | [static] |
maskmode -- mode for baseline fitting default: 'auto' for sdbaseline, 'none' for sdreduce options: 'auto', 'list', 'interact', 'none'(for sdreduce) example: maskmode='auto' runs linefinder to detect line regions to be excluded from fitting. this mode requires three expandable parameters: thresh, avg_limit, and edge. USE WITH CARE! May need to tweak the expandable parameters. maskmode='list' uses the given masklist only: no additional masks applied. maskmode='interact' allows users to manually modify the mask regions by dragging mouse on the spectrum plotter GUI. use LEFT or RIGHT button to add or delete regions, respectively.
Definition at line 1573 of file parameter_dictionary.py.
| def parameter_dictionary.par.maxpix | ( | ) | [static] |
maxpix -- Maximum pixel value default: 0 = autoscale
Definition at line 1591 of file parameter_dictionary.py.
| def parameter_dictionary.par.merge | ( | ) | [static] |
merge -- Merge operation default: 'replace'; will write (or overwrite) a flag file with mode = 'save' Options: 'or','and' not recommended for now.
Definition at line 1598 of file parameter_dictionary.py.
Referenced by task_sdflagmanager.sdflagmanager_worker.execute(), and task_sdcoadd.sdcoadd_worker.execute().
| def parameter_dictionary.par.min_nchan | ( | ) | [static] |
min_nchan -- minimum number of consecutive channels for linefinder default: 3 example: minimum number of consecutive channels required to pass threshold
Definition at line 1635 of file parameter_dictionary.py.
Referenced by task_sdfit.sdfit_worker._set_linelist_auto().
| def parameter_dictionary.par.minnrow | ( | ) | [static] |
minnrow -- minimum number of input spectra to show progress status default: 1000
Definition at line 1607 of file parameter_dictionary.py.
| def parameter_dictionary.par.minpb | ( | ) | [static] |
minpb -- Minimum PB level to use default=0.01; example: minpb=0.1
Definition at line 1621 of file parameter_dictionary.py.
| def parameter_dictionary.par.minpix | ( | ) | [static] |
minpix -- Minimum pixel value default: 0 = autoscale
Definition at line 1614 of file parameter_dictionary.py.
| def parameter_dictionary.par.minpix | ( | ) | [static] |
minpix -- Minimum pixel value default: 0 = autoscale
Definition at line 1628 of file parameter_dictionary.py.
| def parameter_dictionary.par.mode | ( | ) | [static] |
(for flagdata)
mode -- mode of operation
options: 'manualflag', 'autoflag', 'summary', 'quack', 'shadow', 'rfi'
'manualflag' = flagging based on specific selection parameter
plus clipping and flagging autocorrelations
'autoflag' = experimental auto-flagging outliers
'summary' = report the amount of flagged data
'quack' = remove/keep specific time range at scan
beginning/end
'shadow' = remove antenna-shadowed data
'rfi' = Redio Frequency Interference auto-flagging
default: 'manualflag'
--------------------------------------------------------------------------
(for imhead)
mode -- Mode, either 'get' or 'put'
options: 'list', 'get', 'put', 'history', 'summary', 'add', 'del'
'list' = lists the image header keywords and values
'get' = get the specified keyword value(s) from the image
'put' = put the specified keyword value(s) into the image
'history' = display the history information in the CASA logger
'summary' = information summarizing the CASA image file
'add' = adds a new header key. use with caution
'del' = deletes a header key, hdkey. use with caution
default: 'summary'
--------------------------------------------------------------------------
(for immath)
mode -- mode for mathematical operation
options: 'evalexpr' = evaluate a mathematical expression defined in 'expr'
'spix' = spectralindex image
'pola' = polarization position angle image
'poli' = polarization intensity image
default: 'evalexpr'
--------------------------------------------------------------------------
(for makemask)
mode -- type of data selection
options: 'mfs', 'channel'
default: 'mfs'
--------------------------------------------------------------------------
(for mosaic, widefield)
mode -- frequency specification; type of selection
options: 'mfs' = produce one image from all specified data
'channel' = use with nchan, start, width to specify
output image cube.
'velocity' = channels are specified in velocity
'frequency' = channels are specified in frequency
default: 'mfs'
--------------------------------------------------------------------------
(for sdimprocess)
mode -- processing mode
options: 'basket', 'press'
default: 'basket'
--------------------------------------------------------------------------
(for specfit)
mode -- operation mode
options: 'single' = fits a 1-D model to a single profile
'all' = fits a 1-D model to all profiles
'poly' = fits 1-D polynomials to profiles
default: 'single'
--------------------------------------------------------------------------
(for vishead)
mode -- operation mode
options: 'list' = list all keywords that are recognized, and list the
value(s) for each. Only these keywords can be
obtained (get) or changed (put).
'summary' = equivalent to running taskname='listobs'; verbose=False
'get' = get the specified keyword value(s) from the ms
'put' = put the specified keyword value(s) into the ms
default: 'list'
Definition at line 1643 of file parameter_dictionary.py.
| def parameter_dictionary.par.model | ( | ) | [static] |
Name of input model for pointcal (component list or image). ft: model -- Name of input model image default: None; example: model='/usr/lib/casapy/data/nrao/VLA/CalModels/3C286_X.im'
Definition at line 1730 of file parameter_dictionary.py.
| def parameter_dictionary.par.modelimage | ( | ) | [static] |
(for mosaic)
modelimage -- name of output(/input) model image
default: '' (none=imagename.model)
note: this specifies the output model if a single dish image is
input or the output model name from the imaging
Optional model image from which to predict visibilities
This can be either a model image from a previous deconvolution
or an image from a single dish image if single dish uv coverage
is being introduced in the imaging
Definition at line 1747 of file parameter_dictionary.py.
| def parameter_dictionary.par.modifymodel | ( | ) | [static] |
modifymodel -- modify model image WCS or flux scale options: True, False default: False
Definition at line 1762 of file parameter_dictionary.py.
| def parameter_dictionary.par.modimage | ( | ) | [static] |
modimage -- Optional model image (I only, please) from which to predict visibilities if specified, setjy will insist that only one field be selected. this model image will be scaled to match the flux implied by the fluxdensity and standard parameters
Definition at line 1739 of file parameter_dictionary.py.
| def parameter_dictionary.par.moments | ( | ) | [static] |
moments -- List of moments you would like to compute
default: 0 (integrated spectrum);example: moments=[0,1]
moments=-1 - mean value of the spectrum
moments=0 - integrated value of the spectrum
moments=1 - intensity weighted coordinate;traditionally used to get
'velocity fields'
moments=2 - intensity weighted dispersion of the coordinate; traditionally
used to get 'velocity dispersion'
moments=3 - median of I
moments=4 - median coordinate
moments=5 - standard deviation about the mean of the spectrum
moments=6 - root mean square of the spectrum
moments=7 - absolute mean deviation of the spectrum
moments=8 - maximum value of the spectrum
moments=9 - coordinate of the maximum value of the spectrum
moments=10 - minimum value of the spectrum
moments=11 - coordinate of the minimum value of the spectrum
Definition at line 1770 of file parameter_dictionary.py.
| def parameter_dictionary.par.msselect | ( | ) | [static] |
Optional subset of data to select: See: http://aips2.nrao.edu/docs/notes/199/199.htlm
Definition at line 1793 of file parameter_dictionary.py.
| def parameter_dictionary.par.multicolor | ( | ) | [static] |
multicolor -- Multi-color plotting of channels and polarizations options: 'none','both','chan','corr' default: 'none'; example: multicolor='chan'
Definition at line 1801 of file parameter_dictionary.py.
| def parameter_dictionary.par.multiplot | ( | ) | [static] |
multiplot -- Automatically Plot calibration for different antennas in separate frames as indicated by subplot (see above) default: False; only one frame is made (with subplots maybe) If true; will cycle antennas through frames
Definition at line 1809 of file parameter_dictionary.py.
| def parameter_dictionary.par.multisource | ( | ) | [static] |
multisource -- Write in multi-source format default: True; false if one source is selected
Definition at line 1818 of file parameter_dictionary.py.
| def parameter_dictionary.par.nchan | ( | ) | [static] |
(for exportuvfits, makemask) nchan -- number of channels to select default: -1 (all) ---------------------------------------------------- (for mosaic, sdimaging, widefield) nchan -- number of channels (planes) in output image default: 1
Definition at line 1826 of file parameter_dictionary.py.
Referenced by asap.scantable.scantable.__setitem__(), asap.scantable.scantable._check_ifs(), asap.scantable.scantable.fft(), asap.scantable.scantable.parse_maskexpr(), and asap.scantable.scantable.set_spectrum().
| def parameter_dictionary.par.negcomponent | ( | ) | [static] |
--- Multi-scale parameters negcomponent -- Stop component search when the largest scale has found this number of negative components; -1 means continue component search even if the largest component is negative. default: 2; example: negcomponent=-1
Definition at line 1840 of file parameter_dictionary.py.
| def parameter_dictionary.par.nfit | ( | ) | [static] |
nfit -- list of number of Gaussian lines to fit in maskline region
default: 0 (no fitting)
example: nfit=[1] for single line in single region
nfit=[2] for two lines in single region
nfit=[1,1] for single lines in each of two regions, etc.
Definition at line 1850 of file parameter_dictionary.py.
| def parameter_dictionary.par.ngauss | ( | ) | [static] |
ngauss -- Number of Gaussian elements to use when fitting profiles default: 1;
Definition at line 1860 of file parameter_dictionary.py.
| def parameter_dictionary.par.niter | ( | ) | [static] |
Number of iterations; set niter=0 for no CLEANing:
Definition at line 1866 of file parameter_dictionary.py.
| def parameter_dictionary.par.noise | ( | ) | [static] |
--- superuniform/briggs weighting parameter noise -- noise parameter to use for rmode='abs' in briggs weighting example noise='1.0mJy'
Definition at line 1870 of file parameter_dictionary.py.
| def parameter_dictionary.par.noise_thermal | ( | ) | [static] |
noise_thermal -- add thermal noise options: True, False default: False * [alpha] currently only knows about ALMA (and (E)VLA) receivers
Definition at line 1878 of file parameter_dictionary.py.
| def parameter_dictionary.par.npercycle | ( | ) | [static] |
-- interactive masking npercycle -- when cleanbox is set to 'interactive', this is the number of iterations between each clean to update mask interactively. Set to about niter/5.
Definition at line 1888 of file parameter_dictionary.py.
| def parameter_dictionary.par.npiece | ( | ) | [static] |
npiece -- number of the element polynomials of cubic spline curve options: (int) (<0 turns off baseline fitting) default: 2
Definition at line 1896 of file parameter_dictionary.py.
| def parameter_dictionary.par.npix | ( | ) | [static] |
npix -- x and y image size in pixels, symmetric for single value default: -1 (automatically calculated from cell size and the data) example: npix=200 (equivalent to [200,200])
Definition at line 1911 of file parameter_dictionary.py.
| def parameter_dictionary.par.npixels | ( | ) | [static] |
--- superuniform/briggs weighting parameter npixels -- number of pixels to determine uv-cell size for weight calculation
Definition at line 1904 of file parameter_dictionary.py.
| def parameter_dictionary.par.npointaver | ( | ) | [static] |
Number of points to average together for tuning the GSPLINE phase wrapping algorithm.
Definition at line 1919 of file parameter_dictionary.py.
| def parameter_dictionary.par.numpoly | ( | ) | [static] |
numpoly -- order of polynomial fit in Pressed-out default: 2
Definition at line 1924 of file parameter_dictionary.py.
Referenced by task_sdimprocess.sdimprocess_worker.__execute_press().
| def parameter_dictionary.par.nxpanel | ( | ) | [static] |
Panel number in the x-direction:
Definition at line 1931 of file parameter_dictionary.py.
| def parameter_dictionary.par.nypanel | ( | ) | [static] |
Panel number in the y-direction:
Definition at line 1935 of file parameter_dictionary.py.
| def parameter_dictionary.par.opacity | ( | ) | [static] |
Opacity correction to apply (nepers):
Definition at line 1939 of file parameter_dictionary.py.
| def parameter_dictionary.par.optical | ( | ) | [static] |
optical -- Use the optical (rather than radio) velocity convention default: True;
Definition at line 1943 of file parameter_dictionary.py.
| def parameter_dictionary.par.order | ( | ) | [static] |
order -- order of baseline polynomial
options: (int) (<0 turns off baseline fitting)
default: 5 for sdbaseline/sdreduce, 1 for sdtpimaging
example: typically in range 2-9 (higher values
seem to be needed for GBT)
Definition at line 1950 of file parameter_dictionary.py.
Referenced by task_sdbaseline.sdbaseline_worker.parameter_check(), tests.test_report.version_test.test_build_build_1(), tests.test_report.version_test.test_build_build_2(), tests.test_report.version_test.test_build_r_1(), tests.test_report.version_test.test_build_r_2(), tests.test_report.version_test.test_r_r_1(), tests.test_report.version_test.test_r_r_2(), and tests.test_report.version_test.test_r_r_3().
| def parameter_dictionary.par.outfile | ( | ) | [static] |
(for immath)
outfile -- output image file name.
default: 'immath_results.im'
Overwriting an existing outfile is not permitted.
----------------------------------------------------------------
(for immoments)
outfile -- output image file name (or root for multiple moments)
default: '' (input+auto-determined suffix)
example: outfile='source_moment'
----------------------------------------------------------------
(for msmoments)
outfile -- output MS file name (or root for multiple moments)
default: '' (input+auto-determined suffix)
example: outfile='source_moment'
----------------------------------------------------------------
(for imsmooth)
outfile -- output image file name.
default: 'imsmooth_results.im'
----------------------------------------------------------------
(for sd*)
outfile -- output file name
default: ''
Given default value ('') for outfile, some ASAP tasks set output
file name as infile (=input file name) with suffix as follows:
<infile>_cal for sdcal and sdreduce,
<infile>_bs for sdbaseline,
<infile>_f for sdflag,
<infile>.grid for sdgrid,
<infile>_scaleed<factor> for sdscale, and
<infile>_sm for sdsmooth.
----------------------------------------------------------------
(for uvmodelfit)
outfile -- optional output component list table
default: ''
example: outfile='componentlist.cl'
Definition at line 1960 of file parameter_dictionary.py.
Referenced by task_sdfit.sdfit_worker.__store_fit(), task_sdlist.sdlist_worker.execute(), task_sdimaging.sdimaging_worker.execute(), task_sdflag.sdflag_worker.parameter_check(), task_sdimaging.sdimaging_worker.parameter_check(), task_sdplot.sdplot_worker.plot_azel(), task_sdplot.sdplot_worker.plot_pointing(), task_sdscale.sdscale_worker.save(), task_sdsave.sdsave_worker.save(), task_sdfit.sdfit_worker.save(), task_sdplot.sdplot_worker.save(), task_sdstat.sdstat_worker.save(), and task_sdmath.sdmath_worker.save().
| def parameter_dictionary.par.outform | ( | ) | [static] |
outform -- output file format options: 'ASAP','ASCII','MS2','SDFITS' default: 'ASAP' the ASAP format is easiest for further sd processing; use MS2 for CASA imaging. If ASCII, then will append some stuff to the output file.
Definition at line 2012 of file parameter_dictionary.py.
| def parameter_dictionary.par.outputvis | ( | ) | [static] |
Name of output visibility file (MS)
Definition at line 2024 of file parameter_dictionary.py.
| def parameter_dictionary.par.overplot | ( | ) | [static] |
overplot -- Overplot these values on current plot (if possible) default: False; example: overplot= True
Definition at line 2028 of file parameter_dictionary.py.
| def parameter_dictionary.par.overwrite | ( | ) | [static] |
overwrite -- overwrite pre-existing imagename or output file options: True, False default: False
Definition at line 2035 of file parameter_dictionary.py.
Referenced by task_sdimprocess.sdimprocess_worker.__execute_basket_weaving(), task_sdimprocess.sdimprocess_worker.__execute_press(), task_sdimaging.sdimaging_worker.parameter_check(), task_sdscale.sdscale_worker.save(), task_sdsave.sdsave_worker.save(), task_sdsmooth.sdsmooth_worker.save(), task_sdbaseline.sdbaseline_worker.save(), task_sdcoadd.sdcoadd_worker.save(), task_sdstat.sdstat_worker.save(), task_sdmath.sdmath_worker.save(), and task_sdflag.sdflag_worker.save().
| def parameter_dictionary.par.panel | ( | ) | [static] |
panel -- code for splitting into multiple panels for spectral plotting
options: 'p','b','i','t','s' or
'pol','beam','if','time','scan'
default: 'i'
example: maximum of 25 panels
panel by pol, beam, if, time, scan
Definition at line 2043 of file parameter_dictionary.py.
Referenced by task_sdplot.sdplot_worker.__setup_plotter().
| def parameter_dictionary.par.pbcor | ( | ) | [static] |
Correct final image for primary beam or not. default: False; example pbcor=True
Definition at line 2054 of file parameter_dictionary.py.
| def parameter_dictionary.par.phasecenter | ( | ) | [static] |
phasecenter -- image phase center (for ASAP tasks) or mosaic center:
direction measure or fieldid
default: '' (imply field=0 as center)
example: phasecenter=6
phasecenter='J2000 19h30m00 -40d00m00'
Definition at line 2063 of file parameter_dictionary.py.
Referenced by task_sdtpimaging.sdtpimaging_worker.__execute_imaging().
| def parameter_dictionary.par.phasewrap | ( | ) | [static] |
Difference in phase (degrees) between points for tuning the GSPLINE phase wrapping algorithm.
Definition at line 2073 of file parameter_dictionary.py.
| def parameter_dictionary.par.planes | ( | ) | [static] |
planes -- Range of planes to include in the moment
default: '' (all);
example: axis=3; planes='3~9'
This will select channels 3-9 from axis 3 (spectral axis)
Definition at line 2079 of file parameter_dictionary.py.
| def parameter_dictionary.par.plot | ( | ) | [static] |
plot -- Plot result or not default: False (not plot) example: if True, result will be plotted
Definition at line 2088 of file parameter_dictionary.py.
Referenced by task_sdgrid.sdgrid_worker.finalize().
| def parameter_dictionary.par.plotcolor | ( | ) | [static] |
plotcolor -- pylab color. Overrides plotsymbol color settings.
See cookbook for details
default: 'darkcyan'
example: plotcolor='g' (green)
plotcolor='slateblue'
plotcolor='#7FFF34' (RGB tuple)
Definition at line 2096 of file parameter_dictionary.py.
| def parameter_dictionary.par.plotfile | ( | ) | [static] |
plotfile -- file name for hardcopy output options: (str) filename.eps, .ps, .png default: '' (no hardcopy)
Definition at line 2107 of file parameter_dictionary.py.
| def parameter_dictionary.par.plotlevel | ( | ) | [static] |
plotlevel -- control for plotting of results options: (int) 0(none), 1(some), 2(more), <0(hardcopy) default: 0 (no plotting) Given a negative value, hardcopy plot will be named <infile>_scans.eps.
Definition at line 2115 of file parameter_dictionary.py.
Referenced by task_sdcal.sdcal_engine.epilogue(), task_sdsmooth.sdsmooth_engine.epilogue(), task_sdflag.sdflag_worker.initialize_scan(), task_sdflag.sdflag_worker.posterior_plot(), task_sdflag.sdflag_worker.prior_plot(), task_sdsmooth.sdsmooth_engine.prologue(), task_sdcal.sdcal_engine.prologue(), and task_sdbaseline.sdbaseline_engine.prologue().
| def parameter_dictionary.par.plotrange | ( | ) | [static] |
plotrange -- Specifies the size of the plot [xmin, xmax, ymin, ymax] default: [0,0,0,0]; example: [-20,100,15,30] Note that if xmin=xmax the values will be ignored and a best guess will be made, simlarly if ymin=ymax. time axes coordinate is in Julian Days, unfortunately.
Definition at line 2125 of file parameter_dictionary.py.
| def parameter_dictionary.par.plotstyle | ( | ) | [static] |
plotstyle -- customise plot settings options: (bool) True, False default: True
Definition at line 2135 of file parameter_dictionary.py.
| def parameter_dictionary.par.plotsymbol | ( | ) | [static] |
plotsymbol -- pylab plot symbol. See cookbook for details default: '.': large points ',' = small points '-' = connect points by line
Definition at line 2143 of file parameter_dictionary.py.
| def parameter_dictionary.par.plottype | ( | ) | [static] |
plottype -- type of plot options: 'spectra','totalpower','pointing','azel' default: 'spectra'
Definition at line 2153 of file parameter_dictionary.py.
| def parameter_dictionary.par.pointingcolumn | ( | ) | [static] |
pointingcolumn -- pointing data column to use options: 'direction','target','pointing_offset','source_offset','encoder' default: 'direction'
Definition at line 2161 of file parameter_dictionary.py.
Referenced by task_sdtpimaging.sdtpimaging_worker.__execute_imaging(), and task_sdimaging.sdimaging_worker.execute().
| def parameter_dictionary.par.pointingspacing | ( | ) | [static] |
pointingspacing -- spacing in between beams default: '1arcmin'
Definition at line 2169 of file parameter_dictionary.py.
| def parameter_dictionary.par.pointtable | ( | ) | [static] |
Name of pointing calibration table:
Definition at line 2176 of file parameter_dictionary.py.
| def parameter_dictionary.par.polaverage | ( | ) | [static] |
polaverage -- average polarizations options: True,False default: False
Definition at line 2180 of file parameter_dictionary.py.
Referenced by task_sdcal.sdcal_worker.execute(), and task_sdplot.sdplot_worker.execute().
| def parameter_dictionary.par.pollist | ( | ) | [static] |
pollist -- list of polarization id numbers to select default: [] (all) example: [1] this selection is in addition to scanlist, field, and iflist.
Definition at line 2188 of file parameter_dictionary.py.
| def parameter_dictionary.par.poly | ( | ) | [static] |
poly -- A polygonial region in the directional portion of an image. The directional portion of an image are the axes for right ascension and declination, for example. Polygons are specified as a list of points, the end points of each line segment in the polygon as follows: x1, y1, x2, y2, x3, y3,... ONLY pixel values acceptable at this time. Default: none (all); Example: poly='0,10,25,25,25,0' Example: poly='20,20,0,25,25,0;100,110,133,110,112,125,100,110'
Definition at line 2198 of file parameter_dictionary.py.
| def parameter_dictionary.par.prior | ( | ) | [static] |
------parameters useful for mem only prior -- Prior image to guide mem mosaic: prior -- Name of MEM prior images default: ['']; example: prior='source_mem.image'
Definition at line 2213 of file parameter_dictionary.py.
| def parameter_dictionary.par.project | ( | ) | [static] |
project -- root for output file names default: 'sim'
Definition at line 2225 of file parameter_dictionary.py.
Referenced by task_sdsmooth.sdsmooth_engine.epilogue(), and task_sdsmooth.sdsmooth_engine.prologue().
| def parameter_dictionary.par.psf | ( | ) | [static] |
psf -- Name of psf image to use e.g psf='mypsf.image' .
But if the psf has 3 parameter, then
a gaussian psf is assumed with the values representing
the major , minor and position angle values
e.g psf=['3arcsec', '2.5arcsec', '10deg']
Definition at line 2232 of file parameter_dictionary.py.
| def parameter_dictionary.par.psfmode | ( | ) | [static] |
psfmode -- Distinguish between Clark and Hogbom style of clean default='clark' example: psfmode='hogbom'
Definition at line 2241 of file parameter_dictionary.py.
| def parameter_dictionary.par.pweight | ( | ) | [static] |
pweight -- weighting for polarization average
options: 'var' = 1/var(spec) weighted
'tsys' = 1/Tsys**2 weighted
default: 'tsys'
Definition at line 2249 of file parameter_dictionary.py.
Referenced by task_sdcal.sdcal_worker.execute(), and task_sdplot.sdplot_worker.execute().
| def parameter_dictionary.par.pwv | ( | ) | [static] |
precipitable water vapor if constructing an atmospheric model. Set 0 for noise-free simulation.
Definition at line 2258 of file parameter_dictionary.py.
| def parameter_dictionary.par.quackinterval | ( | ) | [static] |
quackinterval -- Time interval (n timestamps) at scan boundary for VLA quack-flagging
Definition at line 2265 of file parameter_dictionary.py.
| def parameter_dictionary.par.quackmode | ( | ) | [static] |
quackmode -- 'beg','end','both'
Definition at line 2271 of file parameter_dictionary.py.
| def parameter_dictionary.par.refant | ( | ) | [static] |
Reference antenna:
Definition at line 2277 of file parameter_dictionary.py.
| def parameter_dictionary.par.refdate | ( | ) | [static] |
refdate -- central time of simulated observation default: '2012/05/21/22:05:00' * [alpha] observations are centered at the nearest transit.
Definition at line 2281 of file parameter_dictionary.py.
| def parameter_dictionary.par.refdirection | ( | ) | [static] |
refdirection -- reference direction of the model image.
options: (str) 'direction', 'header', or reference
direction, e.g., 'J2000 19h00m00 -40d00m00'
default: 'direction'
Definition at line 2290 of file parameter_dictionary.py.
| def parameter_dictionary.par.reference | ( | ) | [static] |
reference -- Reference field name(s)
The names of the fields with a known flux densities or structures.
The syntax is similar to field. Hence source index or
names can be used.
default: none; example: reference='1328+307'
The model visibility is determined by using task setjy or task ft
with a given source structure.
Definition at line 2299 of file parameter_dictionary.py.
References alma-ngc3256-analysis-regression.name.
| def parameter_dictionary.par.refpixel | ( | ) | [static] |
refpixel -- reference pixel (CRPIX) options: '[x,y]' or 'center' or 'header' default: 'center' example: '[100,100]'
Definition at line 2311 of file parameter_dictionary.py.
| def parameter_dictionary.par.refspwmap | ( | ) | [static] |
refspwmap -- Vector of spectral windows enablings scaling across spectral windows
default: [-1]==> none.
Example with 4 spectral windows: if the reference fields were observed only in spw=1 & 3,
and the transfer fields were observed in all 4 spws (0,1,2,3), specify refspwmap=[1,1,3,3].
This will ensure that transfer fields observed in spws 0,1,2,3 will be referenced to
reference field data only in spw 1 or 3. Pray you don't have to do this.
Definition at line 2320 of file parameter_dictionary.py.
| def parameter_dictionary.par.region | ( | ) | [static] |
Region over which to carry out the operation. For ia tool methods, this is usually specified
as a python dictionary returned from an rg tool method (rg.box(), rg.fromtextfile() etc).
In image analysis tasks, the region can be specified in one of several ways:
(a) Using the CASA region format
(http://casaguides.nrao.edu/index.php?title=CASA_Region_Format)
Example : region='box [ [ 100pix , 130pix] , [120pix, 150pix ] ]'
region='circle [ [ 120pix , 40pix] ,6pix ]'
region='circle[[19h58m52.7s,+40d42m06.04s ], 30.0arcsec]'
Multiple regions may be specified as a list of pixel ranges.
(b) Filename with cleanbox shapes defined using the CASA region format.
Example: region='myregion.txt'
The file 'myregion.txt' contains :
box [ [ 100pix , 130pix ] , [ 120pix, 150pix ] ]
circle [ [ 150pix , 150pix] ,10pix ]
rotbox [ [ 60pix , 50pix ] , [ 30pix , 30pix ] , 30deg ]
(c) Filename for region in binary format (e.g. from viewer or rg.tofile()).
Example: region='myregion.rgn'
Definition at line 2331 of file parameter_dictionary.py.
| def parameter_dictionary.par.rejwn | ( | ) | [static] |
redwn -- wave number(s) of sinusoids NOT to be used for fitting.
can be set just as addwn but has higher priority:
wave numbers which are specified both in addwn and
rejwn will NOT be used.
(list) and (int) are accepted to specify every
wave numbers. also (str) can be used in case
you need to specify wave numbers in a certain range,
example: 'a-b' (= a, a+1, a+2, ..., b-1, b),
'<a' (= 0,1,...,a-2,a-1),
'>=a' (= a, a+1, ... up to the maximum wave
number corresponding to the Nyquist
frequency for the case of FFT).
default: []
Definition at line 2353 of file parameter_dictionary.py.
| def parameter_dictionary.par.relmargin | ( | ) | [static] |
relmargin -- how close pointing centers may approach the edge of the output image, as a fraction of pointingspacing. * ignored if direction is a list. options: (float) default: 1.0
Definition at line 2371 of file parameter_dictionary.py.
| def parameter_dictionary.par.removeoldpanels | ( | ) | [static] |
removeoldpanels -- Turn on/off automatic clearing of plot panels that lie under the current panel plotting. default: True (removed underlying panels).
Definition at line 2381 of file parameter_dictionary.py.
| def parameter_dictionary.par.replacetopplot | ( | ) | [static] |
replacetopplot -- When overplotting, replace the last plot only default: False
Definition at line 2389 of file parameter_dictionary.py.
| def parameter_dictionary.par.residualfile | ( | ) | [static] |
Residual image file. Contains the residual of the
original image and its fitted image.
default:
example: residualfile="myimage.fit.residual"
Definition at line 2396 of file parameter_dictionary.py.
| def parameter_dictionary.par.restfreq | ( | ) | [static] |
restfreq -- Specify rest frequency to use for image
options: (float) or (string with unit) : see example
default: '' (try to use the one specified in input data)
example: 4.6e10, '46GHz'
Allowed units are 'THz','GHz','MHz','kHz', and 'Hz'
Definition at line 2404 of file parameter_dictionary.py.
Referenced by task_sdplot.sdplot_worker.initialize_scan().
| def parameter_dictionary.par.rmode | ( | ) | [static] |
Robustness mode; used for weighting='briggs':
Definition at line 2414 of file parameter_dictionary.py.
| def parameter_dictionary.par.robust | ( | ) | [static] |
Brigg's robustness parameter. Options: -2.0 (close to uniform) to 2.0 (close to natural)
Definition at line 2418 of file parameter_dictionary.py.
| def parameter_dictionary.par.rowlist | ( | ) | [static] |
rowlist -- list of row numbers to process
default: [] (use all rows)
example: [0,2,4,6]
For expert users only!
this selection is applied first, and then followed by
the selection with scans, fields, ifs, and polarizations.
Definition at line 2426 of file parameter_dictionary.py.
| def parameter_dictionary.par.scales | ( | ) | [static] |
--- Multiscale parameter scales -- in pixel numbers; the size of component to deconvolve default = [0,3,10]
Definition at line 2437 of file parameter_dictionary.py.
| def parameter_dictionary.par.scaletsys | ( | ) | [static] |
scaletsys -- scaling of associated Tsys options: True,False default: True
Definition at line 2445 of file parameter_dictionary.py.
Referenced by task_sdscale.sdscale_worker.execute().
| def parameter_dictionary.par.scaletype | ( | ) | [static] |
Image plane flux scale type. Options: 'SAULT', 'PBCOR'
Definition at line 2453 of file parameter_dictionary.py.
| def parameter_dictionary.par.scan | ( | ) | [static] |
Scan number range default: ''=all
Definition at line 2461 of file parameter_dictionary.py.
| def parameter_dictionary.par.scanaverage | ( | ) | [static] |
scanaverage -- average integrations within scans options: (bool) True,False default: False
Definition at line 2466 of file parameter_dictionary.py.
Referenced by task_sdcal.sdcal_worker.execute(), task_sdsmooth.sdsmooth_worker.execute(), task_sdplot.sdplot_worker.execute(), and task_sdplot.sdplot_worker.initialize_scan().
| def parameter_dictionary.par.scanlist | ( | ) | [static] |
scanlist -- list of scan numbers to process
default: [] (use all scans)
example: [21,22,23,24]
this selection is in addition to field, iflist, and pollist
Definition at line 2474 of file parameter_dictionary.py.
Referenced by task_sdimaging.sdimaging_worker.execute().
| def parameter_dictionary.par.selectdata | ( | ) | [static] |
selectdata()
CASA selectdata syntax (March 13, 2008):
In CASA, there is a common data selection syntax that is used for the all
tasks that need a specific subset of the data from visibility data (measurement
set). These are:
field: the selection of names associated with a source or mosaic group.
spw: the selection of spectral windows and channels associated with
all sources specified by field
selectdata: The subset of other parameters which may be needed for the
appropriate selection of data.
The field and spw parameters are always visible when displaying the input parameters,
but the additional parameters are only visible when <selectdata = true>.
The input and help file documentation for each of the tasks should provide an adequate
description of the data selection syntax needed to process the appopriate data for
most applications. However, the data selection capabilities are powerful and still
evolving, hence a full description of the syntax is needed, and given below.
All of the parameter values must be placed within quotes since they are formally
strings, even though they often represent integers. The string property allows a
richer set of parameter usage. The field and antenna parameters can be either the
field_id or antenna_id (the array index used in CASA for this parameter) or the actual
names of the field or antenna. For these two parameters, if the string is a
non-negative integer, it is interpreted as an array index. Otherwise, it is interpreted
as the name. REMEMBER, CASA INDICES START WITH 0. Illegal strings are ',',';','"','/'.
Execute <inp='plotxy'>, for example, to determine the parameters of the visibility data.
field -- The field names (sources) processed by the task or tool:
field = '' data for all field_ids
field = '1' data for field_id = 1
field = 'P1151+3435' data for field P1151+3435
field = '2~4' data for field_ids 2,3,4
field = '2,3,4' data for field_ids 2,3,4
field = 'P11*,3,4~6' data for field_ids 3,4,5,6 and any source name
beginning with P11
field = '*11,8' data for field_id 8 and any source ending with 11
spw -- The spectral window/channel selection for all fields to be processed:
spw = '0' spectral window_id=0, all channels
spw = '0:0~63' sp id=0, channels 0 to 63, INCLUSIVE.
spw = '0,1,4~7' sp ids=0,1,4,5,6,7, all channels
spw = '*:3~64' channels 3 through 64 for all sp ids
spw = ' :3~64' will NOT work.
spw = '*:0;60~63' channel 0 and channels 60,61,62,63 for all IFs
';' needed to separate different channel ranges in one spw
spw = '0:34, 2:10~12,3~4:0~33'
sp id=0, channel 34; sp id=2, channels 10,11,12;
sp ids 3 and 4, channels 0 through 33, inclusive.
There is also a skipping parameter, denoted by '^'
spw = '0:0~14^3' sp id=0, every third channel in 0 to 14
i.e. channels 0,3,6,9,12
spw = '0:0~6^2 ,0:6~38^4'
sp id=1. channels, 0,2,4,6,10,14,18,22,26,30,34,38
spw = '*:^2' all spw, every second channel
NOTE: Channel ranges in velocity or frequency have limited functionality.
selectdata = true will open some or all of the following parameters:
antenna -- The antennas and/or baselines for all fields/spw to be processed:
NOTE: Some tasks require specific antennas, some tasks require specific
baselines. See help for each task.
NOTE: Antennas can be designated by index or by antenna name depending on
how the data were written into CASA.
antenna-oriented syntax:
antenna = '' all antennas and (of course) baselines
antenna = '0,2~18' baselines that contain antenna indices 0, or 2 thru 18.
antenna = '0,VA05' baselines that contain antenna index 0 and VLA antenna 5
antenna = 'VA*,EA13,EA14' baselines that contain all VLA antennas and
EVLA antennas 13,14
antenna = 'MK,SC,PT,LA' baselines that contain VLBA antennas at MK, SC
PT, LA
baseline-oriented syntax:
antenna = '0 & 1' baseline with antenna index 0 and 1
antenna = 'VA05 & VA06' baseline with VLA antenna 5 and 6
antenna = 'VA* & EV*' baselines between VLA and EVLA antennas
antenna = '0~5 & 23~25,27' all baselines betweeen antennas 0 through 5
versus 23 through 25, and all baselines
associated with 27.
timerange -- The time range to be processed:
The time syntax is T = 'YYYY/MM/DD/HH:MM:SS.FF'
Most applications will use a time range such as:
timerange = 'T0~T1' timer range between T0 and T1
timerange = '2007/5/3/5:44:13.33 ~ 2007/5/3/6:44:13.33'
timerange = '5:44:13.33 ~ 6:44:13.33' same as above if the earliest visibility
data point is on day 2007/5/3
timerange = '5:44:13.33 + 0:2:0' Time from 5:44:13.33 to 2 min later
timerange = '>6:12:20.0' Time after 6:12:20
timerange = '<8:12:20.0' Time before 8:12:20 (on data of first data point)
timerange = '2007/5/3/5:44:13.33' Time stamp within one data sampling time interval
Other short-cuts
'2007/06/03/6' 2007June03 at 6h
'2007/06/03/5:44' 2007June03 at 5h44m
if part of the year, month and day are missing, the date (egs. 2000/06/03) of the
earliest visibility data point is assumed:
03/5:44 2007/06 assumed
23:24:23 2007/06/03 assumed
25:18:44 2007/06/03 assumed, i.e
2007/06/04/01:18:44
correlation -- the correlators to be processed:
Antenna-based correlations are: 'R', 'L', 'X', 'Y'
Baseline-base correlations are: 'RR', 'LL', 'RL', 'LR',
'XX', 'YY', 'XY', 'YX'
Various combinations are allowed, and these are task specific
egs. correlation = 'RR LL' in plotxy
uvrange -- The uvrange to be processed:
uvrange = 'UVMIN ~ UVMAXklambda' uvrange from UVMIN to UVMAX in klambda
uvrange = 'UVMIN ~ UVMAXkm' uvrange from UVMIN to UMMAX in km
klambda, km, m, ml, l available
uvrange = '<100km' uvrange less than 100 km
uvrange = '<100km,>1000km' uvrange less than 100 km, but more than 1000 km
The default units for uvrange are METERS!
scan -- The scan range to be processed:
Syntax associated with non-negative integers
scan = '0~20' scan range 0 through 20
scan = '2,5,8' scans 2, 5 and 8
feed -- The multi-feed number to be processed
Not yet implemented. Syntax associated with non-negative integers
feed = '0~20' feed range 0 through 20
feed = '2,5,8' feeds 2, 5 and 8
array -- The array number associated with the data
Not yet implemented.
Definition at line 3185 of file parameter_dictionary.py.
| def parameter_dictionary.par.showflags | ( | ) | [static] |
showflags -- Show the flagged and unflagged data. default: False; example: showflags=True
Definition at line 2483 of file parameter_dictionary.py.
| def parameter_dictionary.par.showgui | ( | ) | [static] |
showgui -- Turn on/off the displaying of the plotting GUI default: True; example: showgui=False
Definition at line 2490 of file parameter_dictionary.py.
| def parameter_dictionary.par.showprogress | ( | ) | [static] |
showprogress -- show progress status for large data default: True
Definition at line 2497 of file parameter_dictionary.py.
| def parameter_dictionary.par.sigma | ( | ) | [static] |
------parameters useful for mem only sigma -- Estimated noise for image mosaic: sigma -- Target image sigma default: '0.001Jy'; example: sigma='0.1Jy'
Definition at line 2504 of file parameter_dictionary.py.
| def parameter_dictionary.par.sigmafile | ( | ) | [static] |
sigmafile -- File contain weights to be applied to an image file when doing profile fitting. default: example: sigmafile='myimage.weights'
Definition at line 2516 of file parameter_dictionary.py.
| def parameter_dictionary.par.singledish | ( | ) | [static] |
singledish -- Set True to write data as single-dish format (Scantable)
default: False
task: importasdm
Definition at line 2525 of file parameter_dictionary.py.
| def parameter_dictionary.par.smallscalebias | ( | ) | [static] |
smallscalebias -- A bias toward smaller scales in multiscale clean. The peak flux found at each scale is weighted by a factor = 1 - smallscalebias*scale/max_scale, so that weighted peak flux = peak flux*factor. Typically the values range from 0.2 to 1.0. default: 0.6
Definition at line 2533 of file parameter_dictionary.py.
| def parameter_dictionary.par.smoothsize | ( | ) | [static] |
smoothsize -- smoothing beam in Pressed-out default: 2.0 (interpreted as 2.0 * beamsize) example: '1arcmin' (set smoothsize directly)
Definition at line 2544 of file parameter_dictionary.py.
Referenced by task_sdimprocess.sdimprocess_worker.__execute_press().
| def parameter_dictionary.par.smoothtime | ( | ) | [static] |
The smoothing filter time (sec).
Definition at line 2552 of file parameter_dictionary.py.
| def parameter_dictionary.par.smoothtype | ( | ) | [static] |
The smoothing filter to be used for calibration solutions. Options: 'mean','median','smean'(sliding mean),'smedian'(sliding median), 'none'(copy table)
Definition at line 2556 of file parameter_dictionary.py.
| def parameter_dictionary.par.solint | ( | ) | [static] |
Solution interval (in seconds):
Definition at line 2565 of file parameter_dictionary.py.
| def parameter_dictionary.par.solnorm | ( | ) | [static] |
Normalize the resulting solutions after the solve (True/False):
Definition at line 2569 of file parameter_dictionary.py.
| def parameter_dictionary.par.sourcepar | ( | ) | [static] |
sourcepar -- Starting guess for component parameters (flux,xoffset,yoffset) default: [1,0,0]; example: sourcepar=[2.5,0.3,0.1] Note: Flux is in Jy, xoffset is in arcsec, yoffset is in arcsec.
Definition at line 2574 of file parameter_dictionary.py.
| def parameter_dictionary.par.specunit | ( | ) | [static] |
specunit -- units for spectral axis options: (str) 'channel','km/s','GHz','MHz','kHz','Hz' default: '' (=current) example: this will be the units for masklist
Definition at line 2582 of file parameter_dictionary.py.
Referenced by task_sdplot.sdplot_worker.initialize_scan(), and task_sdplot.sdplot_worker.plot_grid().
| def parameter_dictionary.par.splinetime | ( | ) | [static] |
Spline timescale (sec); used for gaintype='GSPLINE'
Definition at line 2591 of file parameter_dictionary.py.
| def parameter_dictionary.par.splitdata | ( | ) | [static] |
splitdata -- Split out continuum and continuum subtracted line data default: 'False'; example: splitdata=True The continuum data will be in: vis.cont The continuum subtracted data will be in: vis.contsub
Definition at line 2595 of file parameter_dictionary.py.
| def parameter_dictionary.par.sprange | ( | ) | [static] |
sprange -- range for spectral axis of plot options: (list) [min,max] default: [] (full range) example: sprange=[42.1,42.5] if 'GHz' assumes current specunit
Definition at line 2604 of file parameter_dictionary.py.
Referenced by task_sdplot.sdplot_worker.__overlay_linecatalog().
| def parameter_dictionary.par.spw | ( | ) | [static] |
(for sdimaging)
spw -- spectral window id
default: 0
example: 1
this selection is in addition to scanlist and field
-----------------------------------------------------------------
(for other tasks)
spw -- Select spectral window/channels
default: '' (all spectral windows and channels)
example: spw='0~2,4' = spectral windows 0,1,2,4 (all channels))
spw='<2' = spectral windows less than 2 (i.e. 0,1))
spw='0:5~61' = spw 0, channels 5 to 61)
spw='0,10,3:3~45' = spw 0,10 all channels, spw 3, channels 3 to 45.
spw='0~2:2~6' = spw 0,1,2 with channels 2 through 6 in each.
spw='0:0~10;15~60' = spectral window 0 with channels 0-10,15-60
spw='0:0~10,1:20~30,2:1;2;3' = spw 0, channels 0-10,
spw 1, channels 20-30, and
spw 2, channels, 1,2 and 3
Definition at line 2613 of file parameter_dictionary.py.
Referenced by task_sdtpimaging.sdtpimaging_worker.__execute_imaging().
| def parameter_dictionary.par.spwmap | ( | ) | [static] |
This parameter is used to indicate how solutions derived from different spectral windows should be applied to other spectral windows. Nominally data in each spectral window will be corrected by solutions derived from the same spectral window. This is the default behavior of spwmap, i.e., if spwmap is not specified, data will be corrected by solutions from the same spectral window. Otherwise, spwmap[j]=i causes soutions derived from the i-th spectral window to be used to correct the j-th spectral window. For example, if bandpass solutions are available for spectral windows 1 and 3, and it is desired that these be applied to spws 2 and 4 (as well as 1 and 3), use spwmap=[1,1,3,3].
Definition at line 2639 of file parameter_dictionary.py.
| def parameter_dictionary.par.stack | ( | ) | [static] |
stack -- code for stacking on single plot for spectral plotting
options: 'p','b','i','t','s' or
'pol', 'beam', 'if', 'time', 'scan'
default: 'p'
example: maximum of 25 stacked spectra
stack by pol, beam, if, time, scan
Definition at line 2651 of file parameter_dictionary.py.
Referenced by task_sdplot.sdplot_worker.__setup_plotter().
| def parameter_dictionary.par.standard | ( | ) | [static] |
Flux density standard: Options: 'Baars', 'Perley 90', 'Perley-Taylor 95', 'Perley-Taylor 99', 'Perley-Butler 2010', 'Butler-JPL-Horizons 2010'
Definition at line 2662 of file parameter_dictionary.py.
| def parameter_dictionary.par.start | ( | ) | [static] |
start -- start channel default: 0
Definition at line 2671 of file parameter_dictionary.py.
| def parameter_dictionary.par.startfreq | ( | ) | [static] |
startfreq -- frequency of first channel default: '89GHz'
Definition at line 2678 of file parameter_dictionary.py.
| def parameter_dictionary.par.starttime | ( | ) | [static] |
starttime -- Time after which data will be considered for importing
default: '1970/1/31/00:00:00'
starttime = '' gives error message
Definition at line 2685 of file parameter_dictionary.py.
| def parameter_dictionary.par.step | ( | ) | [static] |
step -- increment between channels default: 1
Definition at line 2693 of file parameter_dictionary.py.
| def parameter_dictionary.par.stokes | ( | ) | [static] |
stokes -- stokes parameters to select/image options: 'I','IV','QU','IQUV',... 'RR', 'LL', can only be done by flagging one polarization
Definition at line 2700 of file parameter_dictionary.py.
| def parameter_dictionary.par.stoptime | ( | ) | [static] |
stoptime -- Time before which data will be considered for importing
default: '2199/1/31/23:59:59'
stoptime = '' gives error message
Definition at line 2708 of file parameter_dictionary.py.
| def parameter_dictionary.par.stretch | ( | ) | [static] |
If mask is specified, stretch is true and if the number of mask
dimensions is less than or equal to the number of image dimensions
and some axes in the mask are degenerate while the corresponding
axes in the image are not, the mask will be stetched in the
degenerate dimensions. For example, if the input image has shape
[100, 200, 10] and the input mask has shape [100, 200, 1] and stretch
is true, the mask will be stretched along the third dimension to shape
[100, 200, 10]. However if the mask is shape [100, 200, 2], stretching
is not possible and an error will result.
Definition at line 2716 of file parameter_dictionary.py.
| def parameter_dictionary.par.subplot | ( | ) | [static] |
(for sdplot)
subplot -- number of subplots (row and column) on a page.
NOTICE plotter will slow down when a large number is
specified
default: -1 (auto)
example: 23 (2 rows by 3 columns)
---------------------------------------------------------------
(for the others)
subplot -- Panel number on the display screen
default: 111 (full screen display); example:
if iteration is non-blank, then
subplot=yx1 window will produce y by x plots in the window.
if iteration = '', then
subplot=yxn; means the window will have y rows, and x columns
with the present execution placing the plot in location n
n = 1,..., xy, in order upper left to right, then down. An
example is the plotting of four fields on one frame
field='0'; subplot=221; plotxy()
field='1'; subplot=222; plotxy()
field='2'; subplot=223; plotxy()
field='3'; subplot=224; plotxy()Definition at line 2730 of file parameter_dictionary.py.
| def parameter_dictionary.par.t_atm | ( | ) | [static] |
t_atm -- atmospheric temperature in K default: 260.0
Definition at line 2757 of file parameter_dictionary.py.
| def parameter_dictionary.par.t_ground | ( | ) | [static] |
t_ground -- ambient temperature in K default: 269.0
Definition at line 2764 of file parameter_dictionary.py.
| def parameter_dictionary.par.tablein | ( | ) | [static] |
Input calibration table:
Definition at line 2771 of file parameter_dictionary.py.
| def parameter_dictionary.par.tablename | ( | ) | [static] |
tablename -- Name of table file on disk (MS, calibration table, image)
default: none; example: tablename='ngc5921.ms'
Definition at line 2776 of file parameter_dictionary.py.
| def parameter_dictionary.par.targetflux | ( | ) | [static] |
------parameters useful for mem only targetflux -- Target total flux in image mosaic: targetflux -- Target flux for final image default: '1.0Jy'; example: targetflux='200Jy'
Definition at line 2783 of file parameter_dictionary.py.
| def parameter_dictionary.par.tau | ( | ) | [static] |
tau -- atmospheric optical depth default: 0.0 (no correction)
Definition at line 2795 of file parameter_dictionary.py.
Referenced by task_sdcal.sdcal_worker.execute().
| def parameter_dictionary.par.tau0 | ( | ) | [static] |
tau0 -- zenith opacity at observing frequency default: 0.1
Definition at line 2802 of file parameter_dictionary.py.
| def parameter_dictionary.par.telescopeparm | ( | ) | [static] |
telescopeparm -- the telescope name or characteristics
options: (str) name or (list) list of gain info
default: '' (none set)
example: if telescopeparm='', it tries to get the telescope
name from the data.
Full antenna parameters (diameter,ap.eff.) known
to ASAP are
'ATPKSMB', 'ATPKSHOH', 'ATMOPRA', 'DSS-43',
'CEDUNA','HOBART'. For GBT, it fixes default fluxunit
to 'K' first then convert to a new fluxunit.
telescopeparm=[104.9,0.43] diameter(m), ap.eff.
telescopeparm=[0.743] gain in Jy/K
telescopeparm='FIX' to change default fluxunit
Definition at line 2809 of file parameter_dictionary.py.
Referenced by task_sdmath.sdmath_worker.execute().
| def parameter_dictionary.par.thresh | ( | ) | [static] |
thresh -- S/N threshold for linefinder
default: 5
example: a single channel S/N ratio above which the channel is
considered to be a detection
Definition at line 2827 of file parameter_dictionary.py.
Referenced by task_sdfit.sdfit_worker._set_linelist_auto().
| def parameter_dictionary.par.threshold | ( | ) | [static] |
threshold -- flux level at which to stop CLEANing (units=mJy)
Definition at line 2836 of file parameter_dictionary.py.
| def parameter_dictionary.par.timeaverage | ( | ) | [static] |
timeaverage -- average times for multiple scan cycles options: (bool) True,False default: False
Definition at line 2842 of file parameter_dictionary.py.
Referenced by task_sdcal.sdcal_worker.execute(), and task_sdplot.sdplot_worker.execute().
| def parameter_dictionary.par.timebin | ( | ) | [static] |
Interval width for time averaging.
default: '0s' or '-1s' (no averaging)
example: timebin='30s'
'10' means '10s'
Definition at line 2850 of file parameter_dictionary.py.
| def parameter_dictionary.par.timerange | ( | ) | [static] |
Select time range for subset of data.
default = '' (all); examples,
timerange = 'YYYY/MM/DD/hh:mm:ss~YYYY/MM/DD/hh:mm:ss'
Note: if YYYY/MM/DD is missing dat defaults to first day in data set
timerange='09:14:0~09:54:0' picks 40 min on first day
timerange= '25:00:00~27:30:00' picks 1 hr to 3 hr 30min on next day
timerange='09:44:00' data within one integration of time
timerange='>10:24:00' data after this time
Note: currently for flagdata task, this must be in the format:
dd-mmm-yyyy/hh:mm:ss.s
help par.selectdata will provide extra syntax.Definition at line 2859 of file parameter_dictionary.py.
| def parameter_dictionary.par.title | ( | ) | [static] |
title -- Plot title (above plot) default: ''; example: title='This is my title'
Definition at line 2879 of file parameter_dictionary.py.
| def parameter_dictionary.par.tmax | ( | ) | [static] |
tmax -- maximum value used for process default: 0.0 (no threshold in maximum) example: 10.0 (mask data larger value than 10.0)
Definition at line 2886 of file parameter_dictionary.py.
| def parameter_dictionary.par.tmin | ( | ) | [static] |
tmin -- minimum value used for process default: 0.0 (no threshold in minimum) example: -10.0 (mask data smaller value than -10.0)
Definition at line 2894 of file parameter_dictionary.py.
| def parameter_dictionary.par.transfer | ( | ) | [static] |
transfer -- Transfer field name(s)
The names of the fields with a unknown flux densities. These should
be point-like calibrator sources.
The syntax is similar to field. Hence source index or
names can be used.
default: none: all calibrators must be listed.
example: transfer='1445+099, 3C84'; transfer = '0,4'
Note: to concatenate two strings
str1 = '1445+099'; str2 = '3C84'
example: transfer = str1 + ', ' + str2
NOTE: All sources in reference and transfer must have gains in the
caltable fit.
Definition at line 2902 of file parameter_dictionary.py.
References alma-ngc3256-analysis-regression.name.
| def parameter_dictionary.par.truncate | ( | ) | [static] |
truncate -- truncattion radius of convolution kernel.
effective only for 'GAUSS' and 'GJINC'.
default: '-1' (use default for each gridfunction)
example: 3, '20arcsec', '3pixel'
Definition at line 2920 of file parameter_dictionary.py.
Referenced by task_sdgrid.sdgrid_worker.execute(), and task_sdimaging.sdimaging_worker.execute().
| def parameter_dictionary.par.tweight | ( | ) | [static] |
tweight -- weighting for time average
options:
'var' = 1/var(spec) weighted
'tsys' = 1/Tsys**2 weighted
'tint' = integration time weighted
'tintsys' = Tint/Tsys**2
'median' = median averaging
default: 'tintsys'
Definition at line 2929 of file parameter_dictionary.py.
Referenced by task_sdcal.sdcal_worker.execute(), and task_sdplot.sdplot_worker.execute().
| def parameter_dictionary.par.unflag | ( | ) | [static] |
Option to unflag data rather than flag it (flagdata task):
Definition at line 2942 of file parameter_dictionary.py.
Referenced by TablePlotTkAgg.PlotFlag.configure_buttons().
| def parameter_dictionary.par.uvrange | ( | ) | [static] |
uvrange -- Select data within uvrange
default: '' (all); example:
uvrange='0~1000klambda'; uvrange from 0-1000 kilolambda
uvrange='>4klambda';uvranges greater than 4 kilolambda
See help par.selectdata for additional syntax.
Definition at line 2960 of file parameter_dictionary.py.
| def parameter_dictionary.par.uvtaper | ( | ) | [static] |
uvtaper -- Apply additional filtering/uv tapering of the visibilities. defalt=False; example: uvtaper=True --- uvtaper parameters outertaper -- taper the outer edge of the uv-coverage the values can be in terms of uv units or psf units default []; example outertaper=['4klambda', '4klambda', '0deg'] example outertaper=['20arcsec', '10arcsec', '10deg']
Definition at line 2946 of file parameter_dictionary.py.
| def parameter_dictionary.par.varlist | ( | ) | [static] |
varlist -- Dictionary of variables used in expr (mathematical
expression) and their values. Keys must be coincide with
variables used in expr. Values are substituted in each
value in expr.
default: {} (empty dictionary)
task: sdmath
Definition at line 2970 of file parameter_dictionary.py.
Referenced by task_sdmath.sdmath_worker.execute().
| def parameter_dictionary.par.velocity | ( | ) | [static] |
velocity -- Prefer velocity (rather than frequency) as spectral axis default: False
Definition at line 2981 of file parameter_dictionary.py.
| def parameter_dictionary.par.verbose | ( | ) | [static] |
(for sdbaseline) verbose -- output fitting results to logger and a file as well default: True example: If False, the fitting results including coefficients, residual rms, etc., are not output to either the CASA logger or a text file (<outfile>_blparam.txt), while the processing speed gets faster by a factor of about 20 percent --------------------------------------------------------------- (for others) verbose -- List each observation in addition to the summary (True or False):
Definition at line 2989 of file parameter_dictionary.py.
| def parameter_dictionary.par.verify | ( | ) | [static] |
verify -- verify the results. options: (bool) True,False default: False
Definition at line 3006 of file parameter_dictionary.py.
| def parameter_dictionary.par.verifybl | ( | ) | [static] |
verifybl -- verify the results of baseline fitting options: (bool) True,False default: False
Definition at line 3014 of file parameter_dictionary.py.
| def parameter_dictionary.par.verifycal | ( | ) | [static] |
verifycal -- verify the results of calibration
options: (bool) True,False
default: False
WARNING: Currently verifying parameters just asks whether you
accept the displayed calibraion/fit and if not,
continues without doing any calibraion/baseline fit.
Definition at line 3022 of file parameter_dictionary.py.
| def parameter_dictionary.par.verifysm | ( | ) | [static] |
verifysm -- verify the results of smoothing options: (bool) True,False default: False
Definition at line 3033 of file parameter_dictionary.py.
| def parameter_dictionary.par.versionname | ( | ) | [static] |
versionname -- Flag version name default: none; example: versionname='original_data' No imbedded blanks in the versionname
Definition at line 3041 of file parameter_dictionary.py.
Referenced by task_sdflagmanager.sdflagmanager_worker.execute().
| def parameter_dictionary.par.vis | ( | ) | [static] |
Input visibility file; CASA MeasurementSet on disk:
Definition at line 3049 of file parameter_dictionary.py.
| def parameter_dictionary.par.visnorm | ( | ) | [static] |
Normalize the assembled spectral data, in a per baseline manner. If visnorm=True is used, this will have the effect of removing any non-frequency dependent closure errors (e.g., as caused by source structure, or introduced by the instrument) from the data, and should be used with caution. When visnorm=False is used, closure errors in the data (as supplied to the solver) may be visible in the form of offsets between the data and solutions. For bandpass calibration, this is usually okay, as the shape of the bandpass is the most important aspect of the solution.
Definition at line 3053 of file parameter_dictionary.py.
| def parameter_dictionary.par.weight | ( | ) | [static] |
weight -- weight type (both lower-case and upper-case are
acceptable)
options: 'UNIFORM',
'TSYS' (1/Tsys**2 weighted)
'TINT' (integration time weighted)
'TINTSYS' (Tint/Tsys**2)
default: 'UNIFORM'
Definition at line 3073 of file parameter_dictionary.py.
Referenced by task_sdgrid.sdgrid_worker.execute().
| def parameter_dictionary.par.weighting | ( | ) | [static] |
Weighting to apply to visibilities: Options: 'natural','uniform','briggs','radial','superuniform'
Definition at line 3065 of file parameter_dictionary.py.
| def parameter_dictionary.par.whichhdu | ( | ) | [static] |
whichhdu -- If fits file contains multiple images, choose this one default=0 mean first; example: whichhdu=1
Definition at line 3085 of file parameter_dictionary.py.
| def parameter_dictionary.par.whichrep | ( | ) | [static] |
whichrep -- If fits image has multiple coordinate reps, choose one. default: 0 means first; example: whichrep=1
Definition at line 3093 of file parameter_dictionary.py.
| def parameter_dictionary.par.width | ( | ) | [static] |
Channel width (value>1 indicates channel averaging:
Definition at line 3101 of file parameter_dictionary.py.
| def parameter_dictionary.par.windowsize | ( | ) | [static] |
windowsize -- Window size default: 1.0; example: windowsize=0.5
Definition at line 3107 of file parameter_dictionary.py.
| def parameter_dictionary.par.writestation | ( | ) | [static] |
writestation -- Write station name instead of antenna name default: True;
Definition at line 3114 of file parameter_dictionary.py.
| def parameter_dictionary.par.writesyscal | ( | ) | [static] |
writesyscal -- Write GC and TY tables default: False; system temparature and gain tables.
Definition at line 3121 of file parameter_dictionary.py.
| def parameter_dictionary.par.xaxis | ( | ) | [static] |
xaxis -- Visibility file (MS) data to plot along the x-axis default: 'time' Options: 'azimuth, 'elevation','baseline','hourangle','parallacticangle', 'uvdist','time','u','v','w','x' If plotting versus a data quantity (yaxis='amp'), add options: 'channel','real','imag','amp','phase' Note: xaxis='x' is equivalent to running taskname='plotants' yaxis -- Visibility data to plot along the y-axis default: 'amp' Data quantity options: 'amp','phase','real','imag' Other options: 'azimuth','elevation','baseline','hourangle','parallacticangle', 'u','v','w','uvdist'
Definition at line 3128 of file parameter_dictionary.py.
| def parameter_dictionary.par.xlabels | ( | ) | [static] |
xlabels -- Label for x axis default: ''; example: xlabels='X Axis'
Definition at line 3146 of file parameter_dictionary.py.
| def parameter_dictionary.par.yaxis | ( | ) | [static] |
xaxis -- Visibility file (MS) data to plot along the x-axis default: 'time' Options: 'azimuth, 'elevation','baseline','hourangle','parallacticangle', 'uvdist','time','u','v','w','x' If plotting versus a data quantity (yaxis='amp'), add options: 'channel','real','imag','amp','phase' Note: xaxis='x' is equivalent to running taskname='plotants' yaxis -- Visibility data to plot along the y-axis default: 'amp' Data quantity options: 'amp','phase','real','imag' Other options: 'azimuth','elevation','baseline','hourangle','parallacticangle', 'u','v','w','uvdist'
Definition at line 3153 of file parameter_dictionary.py.
| def parameter_dictionary.par.ylabels | ( | ) | [static] |
ylabels -- Label for y axis default: ''; example: ylabels='Y Axis'
Definition at line 3171 of file parameter_dictionary.py.
| def parameter_dictionary.par.zeroblanks | ( | ) | [static] |
zeroblanks -- Set blanked pixels to zero (not NaN) default=True; example: zeroblanks=True
Definition at line 3178 of file parameter_dictionary.py.
1.8.0