casa
$Rev:20696$
|
00001 class par(str): 00002 00003 @staticmethod 00004 def acaconfig(): 00005 """ 00006 Antenna configuration of ACA 7-m array [''|'cycle1'|'i'|'ns'] 00007 Available configurations are: 00008 * '' (default) : automatically defines based on antennalist. 00009 If antennalist is Cycle-1 configuration, acaconfig='cycle1'. 00010 Otherwise, acaconfig='i' 00011 * 'cycle1' : Cycle-1 ACA-7m configuration. Uses 'aca_cycle1.cfg'. 00012 * 'i' : Normal ACA configuration in full operation. Uses 'aca.i.cfg'. 00013 * 'ns': North-South extended configuration in full operation. Uses 'aca.ns.cfg'. 00014 """ 00015 00016 @staticmethod 00017 def acaratio(): 00018 """ 00019 Ratio of the total observation time of ACA relative to that of 12m array. 00020 Set 0 for no ACA observation. 00021 For Cycle-1 with ACA, set acaratio = 3. 00022 """ 00023 00024 @staticmethod 00025 def accumtime(): 00026 """ Cumulative table timescale when creating from scratch. This is the sampling 00027 interval upon which to accumulate *if* an input calibration table (tablein) 00028 has not been specified. [units=seconds] """ 00029 00030 @staticmethod 00031 def addwn(): 00032 """ 00033 addwn -- additional wave number(s) of sinusoids to be used 00034 for fitting. 00035 (list) and (int) are accepted to specify every 00036 wave numbers. also (str) can be used in case 00037 you need to specify wave numbers in a certain range, 00038 example: 'a-b' (= a, a+1, a+2, ..., b-1, b), 00039 '<a' (= 0,1,...,a-2,a-1), 00040 '>=a' (= a, a+1, ... up to the maximum wave 00041 number corresponding to the Nyquist 00042 frequency for the case of FFT). 00043 default: [] 00044 """ 00045 00046 @staticmethod 00047 def alg(): 00048 """ 00049 alg -- Algorithm to use: 00050 default: 'csclean'; example: alg='clark'; 00051 Options: 'clark','hogbom','csclean' 00052 csclean is Cotton-Schwab and cleans entire image 00053 hogbom and clark clean inner quarter of image 00054 00055 """ 00056 00057 @staticmethod 00058 def algorithm(): 00059 """ 00060 algorithm -- autoflag algorithm name 00061 default: 'timemed' 00062 options: 'timemed','freqmed','uvbin','sprej' 00063 00064 column -- the column on which to operate (DATA, CORRECTED, MODEL) 00065 expr -- expression to use 00066 default: 'ABS I'; example: expr='RE XX' 00067 Options: 'ABS','ARG','RE','IM','NORM' + ' ' + 'I','XX','YY','RR','LL' 00068 00069 thr -- flagging threshold as a multiple of standard-deviation ( n sigma ) 00070 window -- half width for sliding window median filters 00071 """ 00072 00073 @staticmethod 00074 def antenna(): 00075 """ 00076 antenna -- Select data by antenna/baseline 00077 default: 0 for sdimaging, '' (means all) for the other tasks 00078 Non-negative integers are assumed to be antenna indices, and 00079 anything else is taken as an antenna name. 00080 00081 Examples: 00082 antenna='5&6': baseline between antenna index 5 and index 6. 00083 antenna='VA05&VA06': baseline between VLA antenna 5 and 6. 00084 antenna='5&6:7&8': baselines 5-6 and 7-8 00085 antenna='5': all baselines with antenna 5 00086 antenna='5,6,10': all baselines including antennas 5, 6, or 10 00087 antenna='5,6,10&': all baselines with *only* antennas 5, 6, or 10 00088 (cross-correlations only. Use && to include 00089 autocorrelations, and &&& to get only 00090 autocorrelations.) 00091 antenna='!ea03,ea12,ea17': all baselines except those that include 00092 EVLA antennas ea03, ea12, or ea17 00093 00094 --- 00095 (for single dish tasks except for sdimaging and sdtpimaging) 00096 antenna -- antenna name or id (only effective for MS input) 00097 antenna selection syntax doesn't work since current 00098 single dish tasks is not able to handle multiple 00099 antenna simultaneously 00100 """ 00101 00102 @staticmethod 00103 def antennalist(): 00104 """ 00105 antennalist -- antenna position ascii file (each row has x y z diam) 00106 """ 00107 00108 @staticmethod 00109 def antnamescheme(): 00110 """ 00111 antnamescheme -- 'old' or 'new' antenna names. 00112 default = 'new' gives antnenna names 00113 'VA04' for VLA telescope 4 or 00114 'EA13' for EVLA telescope 13. 00115 'old' gives names '4' and '13' 00116 """ 00117 00118 @staticmethod 00119 def append(): 00120 """ Append calibration solutions to an existing calibration table. 00121 00122 Options: True, False 00123 00124 Fluxscale: 00125 append -- Append solutions to the table. 00126 default: False; (will overwrite if already existing) 00127 example: append=True 00128 00129 """ 00130 00131 @staticmethod 00132 def applyfft(): 00133 """ 00134 Automatically set wave numbers of sinusoids. 00135 options: True, False 00136 default: True 00137 """ 00138 00139 @staticmethod 00140 def asdm(): 00141 """ Input ALMA Science Data Model observation. """ 00142 00143 @staticmethod 00144 def async(): 00145 """ Run task in a separate process (return CASA prompt) 00146 default: False; example: async=True """ 00147 00148 @staticmethod 00149 def autocorr(): 00150 """ 00151 autocorr -- Flag autocorrelations ? 00152 default: False 00153 options: True,False 00154 00155 importvla: 00156 autocorr -- import autocorrelations to ms 00157 default = False (no autocorrelations) 00158 00159 """ 00160 00161 @staticmethod 00162 def average(): 00163 """ 00164 average -- averaging on spectral data 00165 default: False 00166 options: True, False 00167 00168 """ 00169 00170 @staticmethod 00171 def averageall(): 00172 """ 00173 averageall -- average multi-resolution spectra 00174 spectra are averaged by referring 00175 their frequency coverage 00176 default: False 00177 options: True, False 00178 """ 00179 00180 @staticmethod 00181 def avg_limit(): 00182 """ 00183 avg_limit -- channel averaging for broad lines 00184 default: 4 00185 example: a number of consecutive channels not greater than 00186 this parameter can be averaged to search for broad lines 00187 """ 00188 00189 @staticmethod 00190 def axis(): 00191 """ 00192 axis -- The moment axis (0-based) 00193 default: 3 (spectral axis); example: axis=3 00194 """ 00195 @staticmethod 00196 def backup(): 00197 """ 00198 backup -- set True to create backup for input data 00199 default: True 00200 """ 00201 00202 @staticmethod 00203 def bandname(): 00204 """ VLA frequency band. 00205 00206 Options: '4' = 48 -96 MHz 00207 'P' = 298 - 345 MHz 00208 'L' = 1.15 - 1.75 GHz 00209 'C' = 4.2 - 5.1 GHz 00210 'X' = 6.8 - 9.6 GHz 00211 'U' = 13.5 - 16.3 GHz 00212 'K' = 20.8 - 25.8 GHz 00213 'Q' = 38 -51 GHz 00214 00215 """ 00216 00217 @staticmethod 00218 def bandtype(): 00219 """ Type of bandpass solution ('B', 'BPOLY'). """ 00220 00221 @staticmethod 00222 def baseline(): 00223 """ 00224 baseline -- Baseline index identifiers 00225 default: [-1] (all); example: baseline=[0,6,11] 00226 """ 00227 00228 @staticmethod 00229 def beamsize(): 00230 """ 00231 beamsize -- beam size 00232 default: 0.0 00233 example: 10.0 (interpreted as '10 arcsec'), '1arcmin' 00234 """ 00235 00236 @staticmethod 00237 def bitpix(): 00238 """ 00239 bitpix -- Bits per pixel 00240 default: -32 (floating point) 00241 <Options: -32 (floating point), 16 (integer)> 00242 """ 00243 00244 @staticmethod 00245 def blfunc(): 00246 """ 00247 blfunc -- baseline model function 00248 options: (str) 'poly','cspline','sinusoid' 00249 default: 'poly' 00250 example: blfunc='poly' uses a single polynomial line of 00251 any order which should be given as an expandable 00252 parameter 'order' to fit baseline. 00253 blfunc='cspline' uses a cubic spline function, a piecewise 00254 cubic polynomial having C2-continuity (i.e., the second 00255 derivative is continuous at the joining points). 00256 blfunc='sinusoid' uses a combination of sinusoidal curves. 00257 """ 00258 00259 @staticmethod 00260 def box(): 00261 """ 00262 box -- A box region in the directional portion of an image. 00263 The directional portion of an image are the axes for right 00264 ascension and declination, for example. Boxes are specified 00265 by there bottom-left corner (blc) and top-right corner (trc) 00266 as follows: blcx, blcy, trcx, trcy; 00267 ONLY pixel values acceptable at this time. 00268 Default: none (all); 00269 Example: box='0,0,50,50' 00270 Example: box='10,20,30,40,100,100,150,150' 00271 """ 00272 00273 @staticmethod 00274 def box_size(): 00275 """ 00276 box_size -- running mean box size 00277 default: 0.2 00278 example: a running mean box size specified as a fraction 00279 of the total spectrum length 00280 """ 00281 00282 @staticmethod 00283 def bptable(): 00284 """ Bandpass calibration solutions table: """ 00285 00286 @staticmethod 00287 def caldescid(): 00288 """ Calibrator data description index identifier. A unique data description 00289 identifier describes a single combination of spectral window and polarization: """ 00290 00291 @staticmethod 00292 def calfield(): 00293 """ List of field names in the incremental calibration table to use. 00294 00295 calfield specifies the names to select from 'incrtable' when applying to 00296 'tablein'. 00297 00298 See syntax in 'help par.selectdata' - same as for field parameter. 00299 00300 """ 00301 00302 @staticmethod 00303 def calmode(): 00304 """ 00305 (for sdcal, sdreduce, sdtpimaging) 00306 calmode -- SD calibration mode 00307 options: 'ps', 'nod', 'fs', 'fsotf', 'quotient', 'none' (for sdcal/sdreduce) 00308 'baseline', 'none' (for sdtpimaging) 00309 default: 'none' 00310 example: choose 'none' if you have already calibrated 00311 WARNING: 'fsotf' is not implemented yet 00312 00313 ----------------------------------------------------------- 00314 00315 (for the other tasks) 00316 calmode -- Solutions to solve for when using the gaincal task. 00317 options: 'p', 'a', and 'ap'. 00318 """ 00319 00320 00321 @staticmethod 00322 def calselect(): 00323 """ Optional subset of calibration data to select (e.g., field name): """ 00324 00325 @staticmethod 00326 def caltable(): 00327 """ Output calibration table: """ 00328 00329 @staticmethod 00330 def calwt(): 00331 """ Apply calibration to data weights in addition to the visibilities (boolean): """ 00332 00333 00334 @staticmethod 00335 def cell(): 00336 """ 00337 (for sdimaging, sdtpimaging) 00338 cell -- x and y cell size. default unit arcmin. 00339 default: ['1.0arcmin', '1.0arcmin'] 00340 example: cell=['0.2arcmin', '0.2arcmin'] 00341 cell='0.2arcmin' (equivalent to example above) 00342 00343 ----------------------------------------------------- 00344 00345 (for simanalyze) 00346 cell -- output cell/pixel size 00347 default: '' # uses incell value for the output cell size 00348 example: '0.1arcsec' 00349 00350 ----------------------------------------------------- 00351 00352 (for sdgrid) 00353 cell -- x and y cell size. default unit arcsec 00354 default: '' (automatically calculated from npix if it is 00355 set, otherwise '1.0arcmin') 00356 example: cell=['0.2arcmin, 0.2arcmin'] 00357 cell='0.2arcmin' (equivalent to example above) 00358 cell=12.0 (interpreted as '12.0arcsec'='0.2arcmin') 00359 """ 00360 00361 @staticmethod 00362 def center(): 00363 """ 00364 center -- grid center 00365 default: '' (automatically calculated from the data) 00366 example: 'J2000 13h44m00 -17d02m00' 00367 ['05:34:48.2', '-05.22.17.7'] (in J2000 frame) 00368 [1.46, -0.09] (interpreted as radian in J2000 frame) 00369 """ 00370 00371 @staticmethod 00372 def channelrange(): 00373 """ 00374 channelrange -- channel range selection 00375 default: [] #use all channel 00376 example: [0, 5000] 00377 Note that specified values are recognized as 00378 'channel' regardless of the value of specunit 00379 """ 00380 00381 @staticmethod 00382 def chans(): 00383 """ Range of channels: 00384 uvcontsub - It takes a simple list of channels or anything that will 00385 produce such a list of integer channel values: 00386 examples chans=[0,1,2,3,55,56,57,58,59,60,61] 00387 chans=range(0,4)+range(55,62) 00388 00389 immath, imstat, and imcontsub - It takes a string listing of channel 00390 numbers, much like the spw paramter such as: 00391 examples chans="0,3,4,8" 00392 chans="3~20;50,51" #channels 3to20 and 50 and 51 00393 chans="<10;>=55" #chanls 0to9 and 55 and greater (inclusively) 00394 00395 """ 00396 00397 @staticmethod 00398 def chanwidth(): 00399 """ 00400 chanwidth -- channel width 00401 default: '5' (for sdsmooth) or '10MHz' (for the other tasks) 00402 """ 00403 00404 @staticmethod 00405 def circ(): 00406 """ 00407 circ -- A circle region in the directional portion of an image. 00408 The directional portion of an image are the axes for right 00409 ascension and declination, for example. Circles are specified 00410 by there center and radius as follows: cx, xy, r 00411 ONLY pixel values acceptable at this time. 00412 Default: none (all); 00413 Example: circ='[10,10,5];[105,110,10]' # defines 2 cirlces 00414 """ 00415 00416 @staticmethod 00417 def cleanbox(): 00418 """ 00419 cleanbox -- Cleaning region: 00420 default: [] defaults to inner quarter of image 00421 Two specification types: 00422 Explicit pixel ranges 00423 example: cleanbox=[110,110,150,145] 00424 cleans one regiong defined by the pixel ranges 00425 Filename with pixel values with ascii format: 00426 <fieldindex blc-x blc-y trc-x trc-y> on each line 00427 """ 00428 @staticmethod 00429 def clearpanel(): 00430 """ 00431 clearpanel -- Don't clear any of the plots, clear any areas 00432 affected by current plot, clear the current plotting area 00433 only, or clear the whole plot panel. 00434 options: None, Auto, Current, All 00435 default: Auto 00436 example: clearpanel='Current' 00437 """ 00438 00439 @staticmethod 00440 def clip(): 00441 """ 00442 clip -- flag data that are outside a specified range 00443 options: (bool)True,False 00444 default: False 00445 """ 00446 00447 @staticmethod 00448 def clipcolumn(): 00449 """ 00450 clipcolumn -- Column to use for clipping. 00451 default: 'DATA' 00452 options: 'DATA','CORRECTED','MODEL' 00453 """ 00454 00455 @staticmethod 00456 def clipcorr(): 00457 """ Defines the correlation to clip. 00458 Options are: 'I','RR','LL','XX','LL' 00459 00460 """ 00461 00462 @staticmethod 00463 def clipexpr(): 00464 """ 00465 clipexpr -- Clip using the following: 00466 default: 'ABS I'; example: clipexpr='RE XX' 00467 Options: 'ABS','ARG','RE','IM','NORM' + ' ' + 'I','XX','YY','RR','LL' 00468 """ 00469 00470 @staticmethod 00471 def clipfunction(): 00472 """ Defines the function used in evaluating data for clipping. 00473 Options are: 'ABS','ARG','RE','IM','NORM' 00474 00475 """ 00476 00477 @staticmethod 00478 def clipminmax(): 00479 """ 00480 (for flagdata) 00481 clipminmax -- Range of data (Jy) that will NOT be flagged 00482 default: [] means do not use clip option 00483 example: [0.0,1.5] 00484 00485 ----------------------------------------------------- 00486 00487 (for sdgrid) 00488 clipminmax -- do min/max cliping if True 00489 default: False 00490 """ 00491 00492 @staticmethod 00493 def clipniter(): 00494 """ 00495 clipniter -- maximum number of iteration in spline fitting 00496 default: 1 00497 """ 00498 00499 @staticmethod 00500 def clipoutside(): 00501 """ 00502 clipoutside -- Clip OUTSIDE the range ? 00503 default: True 00504 example: False -> flag data WITHIN the range. 00505 """ 00506 00507 @staticmethod 00508 def clipthresh(): 00509 """ 00510 clipthresh -- clipping threshold for iterative spline fitting 00511 default: 3 00512 """ 00513 00514 @staticmethod 00515 def colormap(): 00516 """ 00517 colormap -- the colours to be used for plot lines 00518 default: None 00519 example: colormap='green red black cyan magenta' (HTML standard) 00520 colormap='g r k c m' (abbreviation) 00521 colormap='#008000 #00FFFF #FF0090' (RGB tuple) 00522 The plotter will cycle through these colours 00523 when lines are overlaid (stacking mode) 00524 """ 00525 00526 @staticmethod 00527 def combinespw(): 00528 """ 00529 combinespw -- Combine all spectral windows at one time 00530 default: True; 00531 all spectral windows must have same shape. 00532 successful aips transferral must have default=true 00533 """ 00534 00535 @staticmethod 00536 def comment(): 00537 """ 00538 comment -- Short description of a versionname (used for mode='save') 00539 default: ''; example: comment='Clip above 1.85' 00540 comment = versionname 00541 """ 00542 00543 @staticmethod 00544 def complist(): 00545 """ 00546 complist -- Name of component list 00547 default: None; ; example: complist='test.cl' 00548 components tool not yet available 00549 00550 """ 00551 00552 @staticmethod 00553 def comptype(): 00554 """ 00555 comptype -- component model type 00556 default: 'P'; example: comptype='G' 00557 <Options: 'P' (point source), 'G' (gaussian), 'D' (elliptical disk)> 00558 """ 00559 00560 @staticmethod 00561 def concatvis(): 00562 """ 00563 concatvis -- Name of visibility file to append to the input' 00564 default: none; example: concatvis='src2.ms' 00565 """ 00566 00567 @staticmethod 00568 def connect(): 00569 """ 00570 connect -- Specifies what points to join with lines, when the 00571 plotsymbol specifies line drawing. Valid values 00572 include: 'none'(no connections), 'row' (along time and baseline), 00573 and 'chan' (joined along channels). 00574 default: 'none'; example: connect='chan' 00575 """ 00576 00577 @staticmethod 00578 def constpb(): 00579 """ Used in Sault weighting, the flux scale is constant above this value: """ 00580 00581 @staticmethod 00582 def constrainflux(): 00583 """ 00584 constrainflux -- Constrain image to match target flux; 00585 otherwise, targetflux is used to initialize model only. 00586 default: False; example: constrainflux=True 00587 """ 00588 00589 @staticmethod 00590 def contfile(): 00591 """ 00592 contfile -- Name of output continuum image 00593 Default: none; Example: contfile='ngc5921_cont.im' 00594 """ 00595 00596 @staticmethod 00597 def convsupport(): 00598 """ 00599 convsupport -- convolution support for 'SF' 00600 default: -1 (use default for each gridfunction) 00601 example: 3 00602 """ 00603 00604 @staticmethod 00605 def createimage(): 00606 """ 00607 createimage -- do imaging? 00608 default: False 00609 """ 00610 00611 @staticmethod 00612 def correlations(): 00613 """ 00614 correlation -- Select correlators: 00615 default: 'RR LL' both parallel hands. Other options are 00616 '' (all stokes),'RR','LL','RR LL','XX','YY','XX YY','LR','RL','LR RL','RL LR' 00617 """ 00618 00619 00620 @staticmethod 00621 def cyclefactor(): 00622 """ 00623 cyclefactor -- Change the threshold at which the deconvolution cycle will 00624 stop and degrid and subtract from the visibilities. For bad PSFs, 00625 reconcile often (cyclefactor=4 or 5); For good PSFs, use 00626 cyclefactor 1.5 to 2.0. 00627 default: 1.5; example: cyclefactor=4 00628 <cycle threshold = cyclefactor * max sidelobe * max residual> 00629 """ 00630 00631 @staticmethod 00632 def cyclespeedup(): 00633 """ 00634 cyclespeedup -- Cycle threshold doubles in this number of iterations 00635 default: -1; example: cyclespeedup=500 00636 """ 00637 00638 @staticmethod 00639 def datacolumn(): 00640 """ Which data column to use (for plotting, splitting, etc): 00641 00642 plotxy: Visibility file (MS) data column 00643 default: 'data'; example: datacolumn='model' 00644 Options: 'data' (raw),'corrected','model','residual'(corrected-model),'weight' 00645 00646 split: Visibility file (MS) data column 00647 default: 'corrected'; example: datacolumn='data' 00648 Options: 'data' (raw), 'corrected', 'model', 'all', 00649 'float_data' (single dish), 'lag_data', 00650 'float_data,data', and 'lag_data,data'. 00651 note: 'all' = whichever of the above that are present. 00652 """ 00653 00654 @staticmethod 00655 def degamp(): 00656 """ Polynomial degree for amplitude bandpass solutions. """ 00657 00658 @staticmethod 00659 def deglast(): 00660 """ 00661 deglast -- Put degenerate axes last in header? 00662 default: False; example: deglast=True 00663 """ 00664 00665 @staticmethod 00666 def degphase(): 00667 """ Polynomial degree for phase bandpass solutions. """ 00668 00669 @staticmethod 00670 def direction(): 00671 """ 00672 (for sdimprocess) 00673 direction -- scan direction in unit of degree 00674 default: [] 00675 example: [0.0, 90.0] 00676 00677 --------------------------------------------- 00678 00679 (for simobserve) 00680 direction -- center of map or "" to center on the model 00681 * can optionally be a list of pointings, which will override 00682 pointingspacing. When direction is a list, the centroid of 00683 direction will be used as the center. 00684 * otherwise simobserve will fill mapsize according to maptype 00685 default: "" 00686 example: 'J2000 19h00m00 -40d00m00' 00687 """ 00688 00689 @staticmethod 00690 def dirtol(): 00691 """ 00692 dirtol -- Direction shift tolerance for considering data as the same field 00693 default: ;; means always combine 00694 example: dirtol='1.arcsec' will not combine data for a field unless 00695 their phase center is less than 1 arcsec. 00696 """ 00697 00698 @staticmethod 00699 def dochannelmap(): 00700 """ 00701 dochannelmap -- channel map image or total power image 00702 options: True (channel map), False (total power) 00703 default: False (total power) 00704 """ 00705 00706 @staticmethod 00707 def doppler(): 00708 """ 00709 doppler -- doppler mode 00710 options: 'RADIO', 'OPTICAL', 'Z', 'BETA', 'GAMMA' 00711 default: currently set doppler in scantable 00712 """ 00713 00714 @staticmethod 00715 def dropdeg(): 00716 """ 00717 dropdeg -- Drop degenerate axes? 00718 default: False; example: dropdeg=True 00719 """ 00720 00721 @staticmethod 00722 def edge(): 00723 """ 00724 edge -- channels to drop at beginning and end of spectrum 00725 default: 0 00726 example: [1000] drops 1000 channels at beginning AND end 00727 [1000,500] drops 1000 from beginning and 500 from end 00728 """ 00729 00730 @staticmethod 00731 def ephemsrcname(): 00732 """ 00733 ephemsrcname -- ephemeris source name for moving source 00734 default: '' 00735 if the source name in the data matches one of the known 00736 solar objects by the system, the tasks sdimaging and sdtpimaging 00737 automatically set the source name 00738 """ 00739 00740 @staticmethod 00741 def estfile(): 00742 """ 00743 estfile -- Name of the file containing an image profile fit 00744 estimate. 00745 default:; example: estfile='myimage.estimate' 00746 """ 00747 00748 @staticmethod 00749 def estimate(): 00750 """ 00751 estimate -- Create an estimate of the profile (yes/no)? 00752 default: False; example: estimate=True 00753 """ 00754 00755 @staticmethod 00756 def excludepix(): 00757 """ 00758 excludepix -- Range of pixel values to exclude 00759 default: [-1] (don't exclude pixels); example=[100.,200.] 00760 """ 00761 00762 @staticmethod 00763 def excludemask(): 00764 """ 00765 excludemask -- Range of masks to exclude 00766 default: [-1] (don't exclude channels); example=[100,200] 00767 """ 00768 00769 @staticmethod 00770 def expr(): 00771 """ 00772 expr -- mathematical expression using scantables 00773 default: '' 00774 example: expr='("orion_on.asap"-"orion_off.asap")/"orion_off.asap"' 00775 00776 In the expression, input file names should be put inside 00777 of single or double quotes 00778 """ 00779 00780 @staticmethod 00781 def factor(): 00782 """ 00783 factor -- scaling factor 00784 default: 1.0 (no scaling) 00785 """ 00786 00787 @staticmethod 00788 def fftmethod(): 00789 """ 00790 fftmethod -- ethod to be used when applyfft=True. 00791 options: 'fft' 00792 default: 'fft' 00793 """ 00794 00795 @staticmethod 00796 def fftthresh(): 00797 """ 00798 fftthresh -- threshold to select wave numbers to be used for 00799 sinusoidal fitting. both (float) and (str) accepted. 00800 given a float value, the unit is set to sigma. 00801 for string values, allowed formats include: 00802 example: '3sigma' (= 3-sigma level) 00803 '3' (= 3-sigma level) 00804 'top5' (= the 5 strongest ones) 00805 default: 3.0 (unit: sigma). 00806 """ 00807 00808 @staticmethod 00809 def field(): 00810 """ 00811 field -- Select field using field id(s) or field name(s). 00812 [run listobs to obtain the list ids or names] 00813 default: 0 (for sdimaging) 00814 '' = all fields (for the other ASAP tasks) 00815 00816 If field string is a non-negative integer, it is assumed a field index 00817 otherwise, it is assumed a field name 00818 field='0~2'; field ids 0,1,2 00819 field='0,4,5~7'; field ids 0,4,5,6,7 00820 field='3C286,3C295'; field named 3C286 adn 3C295 00821 field = '3,4C*'; field id 3, all names starting with 4C 00822 This selection is in addition to scanlist, iflist, and pollist. 00823 00824 See help par.selectdata for additional syntax. 00825 See specific task for any additional details. 00826 """ 00827 00828 @staticmethod 00829 def fieldid(): 00830 """ Field index identifier; 0-based. """ 00831 00832 @staticmethod 00833 def figfile(): 00834 """ File name to store the plotte figure in. File format 00835 is determined by the file extension '.png' is 00836 recommended. 00837 """ 00838 00839 @staticmethod 00840 def fitfunc(): 00841 """ 00842 fitfunc -- function for fitting 00843 options: 'gauss', 'lorentz' 00844 default: 'gauss' 00845 """ 00846 00847 @staticmethod 00848 def fitmode(): 00849 """ 00850 (for sdfit) 00851 fitmode -- mode for fitting 00852 options: 'list', 'auto', 'interact' 00853 default: 'auto' 00854 example: 'list' will use maskline to define regions to 00855 fit for lines with nfit in each 00856 'auto' will use the linefinder to fir for lines 00857 using the following parameters 00858 'interact' allows adding and deleting mask 00859 regions by drawing rectangles on the plot 00860 with mouse. Draw a rectangle with LEFT-mouse 00861 to ADD the region to the mask and with RIGHT-mouse 00862 to DELETE the region 00863 00864 ------------------------------------------------------------------- 00865 00866 (for uvcontsub) 00867 fitmode -- use of the continuum fit model 00868 options: 'subtract' -- store continuum model and subtract from data 00869 'replace' -- replace vis with continuum model 00870 'model' -- only store continuum model 00871 default: 'subtract' 00872 """ 00873 00874 @staticmethod 00875 def fitorder(): 00876 """ Polynomial order for fit: """ 00877 00878 @staticmethod 00879 def fitsfile(): 00880 """ Name of input UV FITS file: """ 00881 00882 @staticmethod 00883 def fitsimage(): 00884 """ 00885 fitsimage -- Name of input image FITS file 00886 default: none; example='3C273XC1.fits' 00887 """ 00888 00889 @staticmethod 00890 def fixpar(): 00891 """ 00892 fixpar -- Control which parameters to let vary in the fit 00893 default: [] (all vary); example: vary=[False,True,True] 00894 (this would fix the flux to that set in sourcepar but allow the 00895 x and y offset positions to be fit). 00896 """ 00897 00898 @staticmethod 00899 def flaglist(): 00900 """ 00901 flaglist -- list of scan numbers to flag (ranges can be accepted) 00902 default: [] (use all scans) 00903 example: [[0,3],80] 00904 flag the scan range [0,3] = [0,1,2,3] and scan 80 00905 """ 00906 00907 @staticmethod 00908 def flagmode(): 00909 """ 00910 flagmode -- flag mode 00911 options: 'flag', 'unflag', 'restore' 00912 in 'restore' mode, a history of flagging is 00913 displayed and current flag state is returned 00914 default: 'flag' 00915 """ 00916 00917 @staticmethod 00918 def flagrow(): 00919 """ 00920 flagrow -- list of row numbers to apply flag/unflag (row based) 00921 default: [] (no row selection) 00922 example: [0,2,3] 00923 00924 This parameter is effective only when one or more row numbers 00925 are given explicitly and also clip=False 00926 """ 00927 00928 @staticmethod 00929 def flrange(): 00930 """ 00931 flrange -- range for flux axis of plot for spectral plotting 00932 options: (list) [min,max] 00933 default: [] (full range) 00934 example: flrange=[-0.1,2.0] if 'K' assumes current fluxunit 00935 """ 00936 00937 @staticmethod 00938 def fluxdensity(): 00939 """ 00940 fluxdensity -- Specified flux density [I,Q,U,V] in Jy 00941 default=-1, which causes setjy to look up standard I flux densities 00942 Otherwise, use the specified flux density. 00943 If a model image is also specified, only stokes I will be used. 00944 example: fluxdensity=[2.63,0.21,-0.33,0.02] 00945 """ 00946 00947 @staticmethod 00948 def fluxtable(): 00949 """ 00950 fluxtable -- Name of output, flux-scaled calibration table 00951 default: none; example: fluxtable='ngc5921.gcal2' 00952 This gains in this table have been corrected after the 00953 flux density determination of each source. The MODEL_DATA 00954 column has NOT been updated for the flux density of the 00955 calibrator. Use setjy to do this. see task correct for more 00956 information. 00957 """ 00958 00959 @staticmethod 00960 def fluxunit(): 00961 """ 00962 fluxunit -- units for line flux 00963 options: 'K', 'Jy', '' 00964 default: '' (keep current fluxunit) 00965 00966 For GBT data, see description for par.telescopeparm 00967 """ 00968 00969 @staticmethod 00970 def fontsize(): 00971 """ 00972 fontsize -- Font size for labels 00973 default: 10; example: fontsize=2 00974 """ 00975 00976 @staticmethod 00977 def format(): 00978 """ 00979 format -- format string to print statistic values 00980 default: '3.3f' 00981 """ 00982 00983 @staticmethod 00984 def frame(): 00985 """ 00986 frame -- frequency frame for spectral axis 00987 options: 'LSRK', 'REST', 'TOPO', 'LSRD', 'BARY', 00988 'GEO', 'GALACTO', 'LGROUP', 'CMB' 00989 default: currently set frame in scantable 00990 WARNING: frame='REST' not yet implemented 00991 """ 00992 00993 @staticmethod 00994 def freqdep(): 00995 """ Solve for frequency dependent solutions 00996 Default: False (gain; True=bandpass); example: freqdep=True 00997 """ 00998 00999 @staticmethod 01000 def freqtol(): 01001 """ 01002 freqtol -- Frequency shift tolerance for considering data as the same spwid 01003 default: '' means always combine 01004 example: freqtol='10MHz' will not combine spwid unless they are 01005 within 10 MHz 01006 """ 01007 01008 @staticmethod 01009 def frequencytol(): 01010 """ 01011 frequencytol -- Tolerance in frequency shift in making spectral windows 01012 default: 150000 (Hz). For Doppler shifted data, <10000 Hz may 01013 may produce too many unnecessary spectral windows. 01014 example: frequencytol = 1500000.0 (units = Hz) 01015 """ 01016 01017 @staticmethod 01018 def ftmachine(): 01019 """ 01020 ftmachine -- Gridding method for the image; 01021 ft (standard interferometric gridding), sd (standard single dish) 01022 both (ft and sd as appropriate), mosaic (gridding use PB as conv fn) 01023 default: 'mosaic'; example: ftmachine='ft' 01024 """ 01025 01026 @staticmethod 01027 def gain(): 01028 """ Loop gain for CLEANing: """ 01029 01030 @staticmethod 01031 def gaincurve(): 01032 """ Apply VLA antenna gain curve correction: """ 01033 01034 @staticmethod 01035 def gaintype(): 01036 """ Type of gain calibration solution to solve for. 01037 This can be either 'G' or 'GSPLINE'. 01038 """ 01039 01040 @staticmethod 01041 def gainfield(): 01042 """ Select a calibration table by field: """ 01043 01044 @staticmethod 01045 def gaintable(): 01046 """ Gain calibration solutions table: """ 01047 01048 @staticmethod 01049 def getpt(): 01050 """ 01051 getpt -- fill DIRECTION column properly, or reuse POINTING table in original MS 01052 (only effective for MS input) 01053 default: True 01054 options: True (fill DIRECTION column properly) 01055 False (reuse POINTING table in original MS) 01056 """ 01057 01058 @staticmethod 01059 def gridfunction(): 01060 """ 01061 gridfunction -- gridding function 01062 options: 'BOX' (Box-car), 'SF' (Spheroidal), 01063 'GAUSS' (Gaussian), 'PB' (Primary-beam), 01064 'GJINC' (Gaussian*Jinc) 01065 default: 'BOX' 01066 'PB' is not implemented yet. 01067 """ 01068 01069 @staticmethod 01070 def gwidth(): 01071 """ 01072 gwidth -- HWHM for gaussian. Effective only for 01073 'GAUSS' and 'GJINC'. 01074 default: '-1' (use default for each gridfunction) 01075 example: 3, '20arcsec', '3pixel' 01076 """ 01077 @staticmethod 01078 def hditem(): 01079 """ 01080 hditem -- Header item to change 01081 default: ''; example: hditem='telescope' 01082 Options: 'object','telescope','observer' 01083 """ 01084 01085 @staticmethod 01086 def hdvalue(): 01087 """ 01088 hdvalue -- Value to set Header item to 01089 default: ''; example: hdvalue='VLA' 01090 Examples: 01091 hditem='epoch',hdvalue='2007/06/20/00:00:00' 01092 hditem='beam',hdvalue=['55arcsec','55arcsec','0deg'] 01093 hditem='restfrequency',hdvalue='1.421GHz' 01094 hditem='restfrequency',hdvalue='1.421GHz 115.272GHz' 01095 hditem='projection',hdvalue='TAN' 01096 hditem='cdelt4',hdvalue=24415.05 01097 hditem='cdelt1',hdvalue=7.75e-5 01098 """ 01099 01100 @staticmethod 01101 def header(): 01102 """ 01103 header -- print header information on plot 01104 options: (bool) True, False 01105 default: True 01106 """ 01107 01108 @staticmethod 01109 def headsize(): 01110 """ 01111 headsize -- header font size 01112 options: (int) 01113 default: 9 01114 """ 01115 01116 @staticmethod 01117 def highres(): 01118 """ Name of high resolution (interferometer) image: """ 01119 01120 @staticmethod 01121 def histogram(): 01122 """ 01123 histogram -- plot histogram 01124 options: (bool) True, False 01125 default: False 01126 """ 01127 01128 @staticmethod 01129 def iflist(): 01130 """ 01131 iflist -- list of IF id numbers to select 01132 default: [] (use all IFs) 01133 example: [15] 01134 01135 This selection is in addition to scanlist, field, and pollist 01136 """ 01137 01138 @staticmethod 01139 def ifno(): 01140 """ 01141 ifno -- IFNO to be gridded 01142 default: -1 (only process IFNO in the first row) 01143 example: 1 01144 """ 01145 01146 @staticmethod 01147 def ignoreables(): 01148 """ 01149 Let time bins ignore boundaries in array, scan, and/or state. 01150 default = '' (separate time bins by all of the above) 01151 examples: 01152 ignorables = 'scan': Can be useful when the scan number 01153 goes up with each integration, 01154 as in many WSRT MSes. 01155 ignorables = ['array', 'state']: disregard array and state 01156 IDs when time averaging. 01157 ignorables = 'state,subarr': Same as above. ignorables 01158 matches on 'arr', 'scan', and 01159 'state'. 01160 """ 01161 01162 @staticmethod 01163 def imagename(): 01164 """ 01165 (for boxit, deconvolve, exportfits, imcontsub, imfit, imhead, 01166 immath, immoments, imregrid, imsmooth, imstat, imval, 01167 and specfit) 01168 imagename -- input image name(s) 01169 01170 ------------------------------------------------------------ 01171 01172 (for feather, importfits, and makemask) 01173 imagename -- output image name 01174 01175 ------------------------------------------------------------ 01176 (for autoclean, clean, mosaic, and widefield) 01177 imagename -- pre-name of output image(s) 01178 01179 For output image files, imagename is followed by 01180 '.residual', '.model', '.image', etc. 01181 01182 ------------------------------------------------------------ 01183 """ 01184 01185 @staticmethod 01186 def imagermode(): 01187 """ 01188 imagermode -- Determines advanced imaging/gridding scheme. 01189 options: '', 'mosaic', 'csclean' 01190 default: '' means single field clean 01191 example: imagermode='mosaic' (image fields as a mosaic) 01192 imagermode='csclean' (use Cotton-schwab cleaning) 01193 """ 01194 01195 @staticmethod 01196 def imsize(): 01197 """ 01198 imsize -- image pixel size [x,y] 01199 default: [256,256] 01200 example: imsize=[500,500] 01201 imsize=500 (equivalent to [500,500]) 01202 Need not be a power of 2, but not a prime number 01203 """ 01204 01205 @staticmethod 01206 def inbright(): 01207 """ 01208 (for simobserve) 01209 inbright -- peak surface brightness to scale input image 01210 in Jy/pixel. 01211 default: 'unchanged' 01212 01213 [alert] If you specify 'unchanged' it will take the 01214 numerical values in your image and assume they are in Jy/pixel, 01215 even if it says some other unit in the header. This will be made 01216 more flexible in the future. 01217 """ 01218 01219 @staticmethod 01220 def incell(): 01221 """ 01222 incell -- pixel size of the model image. 01223 options: 'header' or pixel size, e.g. '0.1arcsec' 01224 default: 'header' 01225 """ 01226 01227 @staticmethod 01228 def includepix(): 01229 """ 01230 includepix -- Range of pixel values to include 01231 default: [-1] (all pixels); example=[0.02,100.0] 01232 """ 01233 01234 @staticmethod 01235 def includemask(): 01236 """ 01237 (for msmoments) 01238 includemask -- Range of masks to include 01239 default: [-1] (include all channels); example=[2,100] 01240 """ 01241 01242 @staticmethod 01243 def incremental(): 01244 """ 01245 incremental -- Add to the existing MODEL_DATA column? 01246 default: False; example: incremental=True 01247 """ 01248 01249 @staticmethod 01250 def incrtable(): 01251 """ Input (incremental) calibration table (any type): """ 01252 01253 @staticmethod 01254 def infile(): 01255 """ 01256 infile -- Input file name 01257 """ 01258 01259 @staticmethod 01260 def infiles(): 01261 """ 01262 infiles -- Input file names 01263 """ 01264 01265 @staticmethod 01266 def integration(): 01267 """ 01268 integration -- integration (sampling) time 01269 default: '10s' 01270 """ 01271 01272 @staticmethod 01273 def intent(): 01274 """ 01275 Observing intent (a.k.a "scan intent") to be processed 01276 default: '' (all) 01277 examples: intent='*BANDPASS*' selects data labelled with BANDPASS intent 01278 intent='*POINTING*,*BAND*' selects data labelled either with POINTING 01279 or BAND 01280 """ 01281 01282 @staticmethod 01283 def interactive(): 01284 """ 01285 (for sdflag) 01286 interactive -- determines interactive flagging 01287 options: True, False 01288 default: False 01289 01290 ---------------------------------------------------------- 01291 01292 (for sdstat) 01293 interactive -- determines interactive masking 01294 options: True, False 01295 default: False 01296 example: interactive=True allows adding and deleting mask 01297 regions by drawing rectangles on the plot with mouse. 01298 Draw a rectangle with LEFT-mouse to ADD the region to 01299 the mask and with RIGHT-mouse to DELETE the region. 01300 01301 ---------------------------------------------------------- 01302 01303 (for widefield) 01304 interactive -- use interactive clean (with GUI viewer) 01305 options: True, False 01306 default: False 01307 """ 01308 01309 @staticmethod 01310 def interp(): 01311 """ 01312 Setting of the time-dependent interpolation scheme when applying calibration solutions. 01313 01314 The options are: 01315 'nearest' - calibrate each datum with the calibration value nearest in time. 01316 'linear' - calibrate each datum with calibration phases and amplitudes linearly interpolated 01317 from neighboring (in time) values. In the case of phase, this mode will assume that phase 01318 jumps greater than 180 degrees between neighboring points indicate a cycle slip, and the 01319 interpolated value will follow this change in cycle accordingly. 01320 'aipslin' - emulate the interpolation mode used in classic AIPS, i.e., linearly interpolated 01321 amplitudes, with phases derived from interpolation of the complex calibration values. While 01322 this method avoids having to track cycle slips (which is unstable for solutions with very 01323 low SNR), it will yield a phase interpolation which becomes increasingly non-linear as the 01324 spanned phase difference increases. The non-linearity mimics the behavior of 01325 interp='nearest' as the spanned phase difference approaches 180 degrees (the phase of the 01326 interpolated complex calibration value initially changes very slowly, then rapidly jumps 01327 to the second value at the midpoint of the interval). 01328 01329 If the uncalibrated phase is changing rapidly, a 'nearest' interpolation is not desirable. 01330 Usually, interp='linear' is the best choice. 01331 """ 01332 01333 @staticmethod 01334 def invertmask(): 01335 """ 01336 invertmask -- invert mask (EXCLUDE masklist instead) 01337 options: True, False 01338 default: False 01339 """ 01340 01341 @staticmethod 01342 def iteration(): 01343 """ 01344 iteration -- Iterate plots: 01345 default: ''; no interation 01346 Options: 'field', 'antenna', 'baseline'. 01347 Use the 'NEXT' button on gui to iterate through values. 01348 To abort an iteration, close the gui window. 01349 """ 01350 01351 @staticmethod 01352 def jwidth(): 01353 """ 01354 jwidth -- Width of jinc function. Effective only for 01355 'GJINC'. 01356 default: '-1' (use default for each gridfunction) 01357 example: 3, '20arcsec', '3pixel' 01358 """ 01359 01360 @staticmethod 01361 def kernel(): 01362 """ 01363 (for imsmooth) 01364 kernel -- type of kernel to use when smoothing. 01365 Currently, only gaussian is supported. 01366 options: 'gaussian', 'boxcar' 01367 default: 'gaussian' 01368 01369 ----------------------------------------------------------- 01370 01371 (for sdreduce, sdplot, and sdsmooth) 01372 kernel -- type of spectral smoothing 01373 options: 'none', 'hanning', 'gaussian', 'boxcar' 01374 default: 'hanning' for sdsmooth, 'none' for the other tasks 01375 """ 01376 01377 @staticmethod 01378 def kwidth(): 01379 """ 01380 kwidth -- width of spectral smoothing kernel 01381 options: (int) in channels 01382 default: 5 01383 example: 5 or 10 seem to be popular for boxcar 01384 ignored for hanning (fixed at 5 chans) 01385 (0 will turn off gaussian or boxcar) 01386 """ 01387 01388 @staticmethod 01389 def legendloc(): 01390 """ 01391 legendloc -- legend location on the axes (0-10) 01392 options: (integer) 0 -10 01393 Note that 0 ('best') is very slow. 01394 The list of legend positions: 01395 0: best 01396 1: upper right 01397 2: upper left 01398 3: lower left 01399 4: lower right 01400 5: right 01401 6: center left 01402 7: center right 01403 8: lower center 01404 9: upper center 01405 10: center 01406 default: 1 ('upper right') 01407 """ 01408 01409 @staticmethod 01410 def linecat(): 01411 """ 01412 linecat -- control for line catalog plotting for spectral plotting 01413 options: (str) 'all', 'none', or by molecule 01414 default: 'none' (no lines plotted) 01415 example: linecat='SiO' for SiO lines 01416 linescat='*OH' for alcohols 01417 uses sprange to limit catalog 01418 """ 01419 01420 @staticmethod 01421 def linedop(): 01422 """ 01423 linedop -- doppler offset for line catalog plotting (spectral plotting) 01424 options: (float) doppler velocity (km/s) 01425 default: 0.0 01426 example: linedop=-30.0 01427 """ 01428 01429 @staticmethod 01430 def linefile(): 01431 """ 01432 linefile -- Name of output line image 01433 Default: none; Example: outline='ngc5921_line.im' 01434 """ 01435 01436 @staticmethod 01437 def linestyles(): 01438 """ 01439 linestyles -- the linestyles to be used for plotting lines 01440 default: None 01441 example: linestyles='line dashed dotted dashdot dashdotdot dashdashdot' 01442 The plotter will cycle through these linestyles 01443 when lines are overlaid (stacking mode). 01444 01445 warning: linestyles can be specified only one color has been set. 01446 """ 01447 01448 @staticmethod 01449 def linewidth(): 01450 """ 01451 linewidth -- Width of plotted lines. 01452 default: 1 01453 example: linewidth=0.75 01454 """ 01455 01456 @staticmethod 01457 def listfile(): 01458 """ 01459 listfile -- output file name (will not overwrite) 01460 default: '' (no output file) 01461 """ 01462 01463 @staticmethod 01464 def lowres(): 01465 """ Name of low resolution (single dish) image: """ 01466 01467 @staticmethod 01468 def margin(): 01469 """ 01470 margin -- a list of subplot margins in figure coordinate (0-1), 01471 i.e., fraction of the figure width or height. 01472 The order of elements should be: 01473 [left, bottom, right, top, horizontal space btw panels, 01474 vertical space btw panels] 01475 """ 01476 01477 @staticmethod 01478 def markersize(): 01479 """ 01480 markersize -- Size of the plotted marks 01481 default: 1.0 01482 """ 01483 01484 @staticmethod 01485 def mask(): 01486 """ In clean, name(s) of mask image(s) used for CLEANing. 01487 In the image analysis tasks tool methods and tasks, a 01488 mask can be specified two ways: 1. as a Lattice 01489 Expression, which may be mask filename. The full 01490 description of the syntax can be found at 01491 http://www.astron.nl/aips++/docs/notes/223/node11.html, 01492 eg 01493 mask='mask(myimage.mask)' 01494 mask='mask(otherimage:othermask)' 01495 mask='myimage>0.5' 01496 or 2. an image containing numerical valued pixels, 01497 in which case pixels values >= 0.5 are masked True 01498 (good) and < 0.5 are masked False (bad). This 01499 functionality is primarily meant to support clean mask 01500 images, but will work for any image with numerical 01501 valued pixels. eg, 01502 mask='mycleanmask.im' 01503 """ 01504 01505 @staticmethod 01506 def maskcenter(): 01507 """ Controls how many channels at the center of each input spectral window are ignored 01508 on-the-fly. It is usually best to flag these channels directly. """ 01509 01510 @staticmethod 01511 def maskedge(): 01512 """ Controls how many channels at the edge of each input spectral window are ignored 01513 on-the-fly. It is usually better to flag these channels directly. """ 01514 01515 @staticmethod 01516 def maskflag(): 01517 """ 01518 maskflag -- list of mask regions to apply flag/unflag 01519 default: [] (entire spectrum) 01520 example: [[1000,3000],[5000,7000]] 01521 warning: if one or more rows are given in flagrow, or 01522 clip=True, this parameter is ignored 01523 """ 01524 01525 @staticmethod 01526 def maskline(): 01527 """ 01528 maskline -- list of mask regions to INCLUDE in LINE fitting 01529 default: all 01530 example: maskline=[[3900,4300]] for a single region, or 01531 maskline=[[3900,4300],[5000,5400]] for two, etc. 01532 """ 01533 01534 @staticmethod 01535 def masklist(): 01536 """ 01537 (for sdbaseline and sdreduce) 01538 masklist -- list or string of mask regions to INCLUDE in BASELINE fitting 01539 a string masklist allows per IF selection of channels as the 01540 parameter 'spw'. See the parameter help of 'spw' for more details. 01541 default: [] (entire spectrum) 01542 example: [[1000,3000],[5000,7000]] 01543 '0:1000~3000;5000~7000, 1:200~350;450~600' 01544 if blmode='auto' then this mask will be applied 01545 before fitting 01546 01547 --------------------------------------------------------------- 01548 01549 (for sdstat) 01550 masklist -- list of mask regions to INCLUDE in stats 01551 default: [] (entire spectrum) 01552 example: [4000,4500] for one region 01553 [[1000,3000],[5000,7000]] for two regions, etc. 01554 01555 --------------------------------------------------------------- 01556 01557 (for sdtpimaging) 01558 masklist -- mask in numbers of rows from each edge of each scan 01559 for baseline fitting 01560 default: none 01561 example: [30,30] or [30] 01562 uses first 30 rows and last 30 rows of each scan 01563 for baseline 01564 01565 --------------------------------------------------------------- 01566 01567 (for sdimprocess) 01568 masklist -- mask width for Basket-Weaving on percentage 01569 default: 1.0 (1.0% of map size) 01570 """ 01571 01572 @staticmethod 01573 def maskmode(): 01574 """ 01575 maskmode -- mode for baseline fitting 01576 default: 'auto' for sdbaseline, 'none' for sdreduce 01577 options: 'auto', 'list', 'interact', 'none'(for sdreduce) 01578 example: maskmode='auto' runs linefinder to detect line regions 01579 to be excluded from fitting. this mode requires three 01580 expandable parameters: thresh, avg_limit, and edge. 01581 USE WITH CARE! May need to tweak the expandable parameters. 01582 maskmode='list' uses the given masklist only: no additional 01583 masks applied. 01584 maskmode='interact' allows users to manually modify the 01585 mask regions by dragging mouse on the spectrum plotter GUI. 01586 use LEFT or RIGHT button to add or delete regions, 01587 respectively. 01588 """ 01589 01590 @staticmethod 01591 def maxpix(): 01592 """ 01593 maxpix -- Maximum pixel value 01594 default: 0 = autoscale 01595 """ 01596 01597 @staticmethod 01598 def merge(): 01599 """ 01600 merge -- Merge operation 01601 default: 'replace'; will write (or overwrite) a flag file with 01602 mode = 'save' 01603 Options: 'or','and' not recommended for now. 01604 """ 01605 01606 @staticmethod 01607 def minnrow(): 01608 """ 01609 minnrow -- minimum number of input spectra to show progress status 01610 default: 1000 01611 """ 01612 01613 @staticmethod 01614 def minpix(): 01615 """ 01616 minpix -- Minimum pixel value 01617 default: 0 = autoscale 01618 """ 01619 01620 @staticmethod 01621 def minpb(): 01622 """ 01623 minpb -- Minimum PB level to use 01624 default=0.01; example: minpb=0.1 01625 """ 01626 01627 @staticmethod 01628 def minpix(): 01629 """ 01630 minpix -- Minimum pixel value 01631 default: 0 = autoscale 01632 """ 01633 01634 @staticmethod 01635 def min_nchan(): 01636 """ 01637 min_nchan -- minimum number of consecutive channels for linefinder 01638 default: 3 01639 example: minimum number of consecutive channels required to pass threshold 01640 """ 01641 01642 @staticmethod 01643 def mode(): 01644 """ 01645 (for flagdata) 01646 mode -- mode of operation 01647 options: 'manualflag', 'autoflag', 'summary', 'quack', 'shadow', 'rfi' 01648 'manualflag' = flagging based on specific selection parameter 01649 plus clipping and flagging autocorrelations 01650 'autoflag' = experimental auto-flagging outliers 01651 'summary' = report the amount of flagged data 01652 'quack' = remove/keep specific time range at scan 01653 beginning/end 01654 'shadow' = remove antenna-shadowed data 01655 'rfi' = Redio Frequency Interference auto-flagging 01656 default: 'manualflag' 01657 01658 -------------------------------------------------------------------------- 01659 01660 (for imhead) 01661 mode -- Mode, either 'get' or 'put' 01662 options: 'list', 'get', 'put', 'history', 'summary', 'add', 'del' 01663 'list' = lists the image header keywords and values 01664 'get' = get the specified keyword value(s) from the image 01665 'put' = put the specified keyword value(s) into the image 01666 'history' = display the history information in the CASA logger 01667 'summary' = information summarizing the CASA image file 01668 'add' = adds a new header key. use with caution 01669 'del' = deletes a header key, hdkey. use with caution 01670 default: 'summary' 01671 01672 -------------------------------------------------------------------------- 01673 01674 (for immath) 01675 mode -- mode for mathematical operation 01676 options: 'evalexpr' = evaluate a mathematical expression defined in 'expr' 01677 'spix' = spectralindex image 01678 'pola' = polarization position angle image 01679 'poli' = polarization intensity image 01680 default: 'evalexpr' 01681 01682 -------------------------------------------------------------------------- 01683 01684 (for makemask) 01685 mode -- type of data selection 01686 options: 'mfs', 'channel' 01687 default: 'mfs' 01688 01689 -------------------------------------------------------------------------- 01690 01691 (for mosaic, widefield) 01692 mode -- frequency specification; type of selection 01693 options: 'mfs' = produce one image from all specified data 01694 'channel' = use with nchan, start, width to specify 01695 output image cube. 01696 'velocity' = channels are specified in velocity 01697 'frequency' = channels are specified in frequency 01698 default: 'mfs' 01699 01700 -------------------------------------------------------------------------- 01701 01702 (for sdimprocess) 01703 mode -- processing mode 01704 options: 'basket', 'press' 01705 default: 'basket' 01706 01707 -------------------------------------------------------------------------- 01708 01709 (for specfit) 01710 mode -- operation mode 01711 options: 'single' = fits a 1-D model to a single profile 01712 'all' = fits a 1-D model to all profiles 01713 'poly' = fits 1-D polynomials to profiles 01714 default: 'single' 01715 01716 -------------------------------------------------------------------------- 01717 01718 (for vishead) 01719 mode -- operation mode 01720 options: 'list' = list all keywords that are recognized, and list the 01721 value(s) for each. Only these keywords can be 01722 obtained (get) or changed (put). 01723 'summary' = equivalent to running taskname='listobs'; verbose=False 01724 'get' = get the specified keyword value(s) from the ms 01725 'put' = put the specified keyword value(s) into the ms 01726 default: 'list' 01727 """ 01728 01729 @staticmethod 01730 def model(): 01731 """ Name of input model for pointcal (component list or image). 01732 ft: 01733 model -- Name of input model image 01734 default: None; 01735 example: model='/usr/lib/casapy/data/nrao/VLA/CalModels/3C286_X.im' 01736 """ 01737 01738 @staticmethod 01739 def modimage(): 01740 """ 01741 modimage -- Optional model image (I only, please) from which to predict visibilities 01742 if specified, setjy will insist that only one field be selected. 01743 this model image will be scaled to match the flux implied by 01744 the fluxdensity and standard parameters 01745 """ 01746 @staticmethod 01747 def modelimage(): 01748 """ 01749 (for mosaic) 01750 modelimage -- name of output(/input) model image 01751 default: '' (none=imagename.model) 01752 note: this specifies the output model if a single dish image is 01753 input or the output model name from the imaging 01754 01755 Optional model image from which to predict visibilities 01756 This can be either a model image from a previous deconvolution 01757 or an image from a single dish image if single dish uv coverage 01758 is being introduced in the imaging 01759 """ 01760 01761 @staticmethod 01762 def modifymodel(): 01763 """ 01764 modifymodel -- modify model image WCS or flux scale 01765 options: True, False 01766 default: False 01767 """ 01768 01769 @staticmethod 01770 def moments(): 01771 """ 01772 moments -- List of moments you would like to compute 01773 default: 0 (integrated spectrum);example: moments=[0,1] 01774 01775 moments=-1 - mean value of the spectrum 01776 moments=0 - integrated value of the spectrum 01777 moments=1 - intensity weighted coordinate;traditionally used to get 01778 'velocity fields' 01779 moments=2 - intensity weighted dispersion of the coordinate; traditionally 01780 used to get 'velocity dispersion' 01781 moments=3 - median of I 01782 moments=4 - median coordinate 01783 moments=5 - standard deviation about the mean of the spectrum 01784 moments=6 - root mean square of the spectrum 01785 moments=7 - absolute mean deviation of the spectrum 01786 moments=8 - maximum value of the spectrum 01787 moments=9 - coordinate of the maximum value of the spectrum 01788 moments=10 - minimum value of the spectrum 01789 moments=11 - coordinate of the minimum value of the spectrum 01790 """ 01791 01792 @staticmethod 01793 def msselect(): 01794 """ Optional subset of data to select: 01795 01796 See: http://aips2.nrao.edu/docs/notes/199/199.htlm 01797 01798 """ 01799 01800 @staticmethod 01801 def multicolor(): 01802 """ 01803 multicolor -- Multi-color plotting of channels and polarizations 01804 options: 'none','both','chan','corr' 01805 default: 'none'; example: multicolor='chan' 01806 """ 01807 01808 @staticmethod 01809 def multiplot(): 01810 """ 01811 multiplot -- Automatically Plot calibration for different antennas 01812 in separate frames as indicated by subplot (see above) 01813 default: False; only one frame is made (with subplots maybe) 01814 If true; will cycle antennas through frames 01815 """ 01816 01817 @staticmethod 01818 def multisource(): 01819 """ 01820 multisource -- Write in multi-source format 01821 default: True; 01822 false if one source is selected 01823 """ 01824 01825 @staticmethod 01826 def nchan(): 01827 """ 01828 (for exportuvfits, makemask) 01829 nchan -- number of channels to select 01830 default: -1 (all) 01831 01832 ---------------------------------------------------- 01833 01834 (for mosaic, sdimaging, widefield) 01835 nchan -- number of channels (planes) in output image 01836 default: 1 01837 """ 01838 01839 @staticmethod 01840 def negcomponent(): 01841 """ 01842 --- Multi-scale parameters 01843 negcomponent -- Stop component search when the largest scale has found this 01844 number of negative components; -1 means continue component search 01845 even if the largest component is negative. 01846 default: 2; example: negcomponent=-1 01847 """ 01848 01849 @staticmethod 01850 def nfit(): 01851 """ 01852 nfit -- list of number of Gaussian lines to fit in maskline region 01853 default: 0 (no fitting) 01854 example: nfit=[1] for single line in single region 01855 nfit=[2] for two lines in single region 01856 nfit=[1,1] for single lines in each of two regions, etc. 01857 """ 01858 01859 @staticmethod 01860 def ngauss(): 01861 """ 01862 ngauss -- Number of Gaussian elements to use when fitting profiles default: 1; 01863 """ 01864 01865 @staticmethod 01866 def niter(): 01867 """ Number of iterations; set niter=0 for no CLEANing: """ 01868 01869 @staticmethod 01870 def noise(): 01871 """ 01872 --- superuniform/briggs weighting parameter 01873 noise -- noise parameter to use for rmode='abs' in briggs weighting 01874 example noise='1.0mJy' 01875 """ 01876 01877 @staticmethod 01878 def noise_thermal(): 01879 """ 01880 noise_thermal -- add thermal noise 01881 options: True, False 01882 default: False 01883 01884 * [alpha] currently only knows about ALMA (and (E)VLA) receivers 01885 """ 01886 01887 @staticmethod 01888 def npercycle(): 01889 """ 01890 -- interactive masking 01891 npercycle -- when cleanbox is set to 'interactive', this is the number of iterations 01892 between each clean to update mask interactively. Set to about niter/5. 01893 """ 01894 01895 @staticmethod 01896 def npiece(): 01897 """ 01898 npiece -- number of the element polynomials of cubic spline curve 01899 options: (int) (<0 turns off baseline fitting) 01900 default: 2 01901 """ 01902 01903 @staticmethod 01904 def npixels(): 01905 """ 01906 --- superuniform/briggs weighting parameter 01907 npixels -- number of pixels to determine uv-cell size for weight calculation 01908 """ 01909 01910 @staticmethod 01911 def npix(): 01912 """ 01913 npix -- x and y image size in pixels, symmetric for single value 01914 default: -1 (automatically calculated from cell size and the data) 01915 example: npix=200 (equivalent to [200,200]) 01916 """ 01917 01918 @staticmethod 01919 def npointaver(): 01920 """ Number of points to average together for tuning the 01921 GSPLINE phase wrapping algorithm. """ 01922 01923 @staticmethod 01924 def numpoly(): 01925 """ 01926 numpoly -- order of polynomial fit in Pressed-out 01927 default: 2 01928 """ 01929 01930 @staticmethod 01931 def nxpanel(): 01932 """ Panel number in the x-direction: """ 01933 01934 @staticmethod 01935 def nypanel(): 01936 """ Panel number in the y-direction: """ 01937 01938 @staticmethod 01939 def opacity(): 01940 """ Opacity correction to apply (nepers): """ 01941 01942 @staticmethod 01943 def optical(): 01944 """ 01945 optical -- Use the optical (rather than radio) velocity convention 01946 default: True; 01947 """ 01948 01949 @staticmethod 01950 def order(): 01951 """ 01952 order -- order of baseline polynomial 01953 options: (int) (<0 turns off baseline fitting) 01954 default: 5 for sdbaseline/sdreduce, 1 for sdtpimaging 01955 example: typically in range 2-9 (higher values 01956 seem to be needed for GBT) 01957 """ 01958 01959 @staticmethod 01960 def outfile(): 01961 """ 01962 (for immath) 01963 outfile -- output image file name. 01964 default: 'immath_results.im' 01965 01966 Overwriting an existing outfile is not permitted. 01967 01968 ---------------------------------------------------------------- 01969 01970 (for immoments) 01971 outfile -- output image file name (or root for multiple moments) 01972 default: '' (input+auto-determined suffix) 01973 example: outfile='source_moment' 01974 01975 ---------------------------------------------------------------- 01976 01977 (for msmoments) 01978 outfile -- output MS file name (or root for multiple moments) 01979 default: '' (input+auto-determined suffix) 01980 example: outfile='source_moment' 01981 01982 ---------------------------------------------------------------- 01983 01984 (for imsmooth) 01985 outfile -- output image file name. 01986 default: 'imsmooth_results.im' 01987 01988 ---------------------------------------------------------------- 01989 01990 (for sd*) 01991 outfile -- output file name 01992 default: '' 01993 01994 Given default value ('') for outfile, some ASAP tasks set output 01995 file name as infile (=input file name) with suffix as follows: 01996 <infile>_cal for sdcal and sdreduce, 01997 <infile>_bs for sdbaseline, 01998 <infile>_f for sdflag, 01999 <infile>.grid for sdgrid, 02000 <infile>_scaleed<factor> for sdscale, and 02001 <infile>_sm for sdsmooth. 02002 02003 ---------------------------------------------------------------- 02004 02005 (for uvmodelfit) 02006 outfile -- optional output component list table 02007 default: '' 02008 example: outfile='componentlist.cl' 02009 """ 02010 02011 @staticmethod 02012 def outform(): 02013 """ 02014 outform -- output file format 02015 options: 'ASAP','ASCII','MS2','SDFITS' 02016 default: 'ASAP' 02017 02018 the ASAP format is easiest for further sd processing; 02019 use MS2 for CASA imaging. If ASCII, then will append some 02020 stuff to the output file. 02021 """ 02022 02023 @staticmethod 02024 def outputvis(): 02025 """ Name of output visibility file (MS) """ 02026 02027 @staticmethod 02028 def overplot(): 02029 """ 02030 overplot -- Overplot these values on current plot (if possible) 02031 default: False; example: overplot= True 02032 """ 02033 02034 @staticmethod 02035 def overwrite(): 02036 """ 02037 overwrite -- overwrite pre-existing imagename or output file 02038 options: True, False 02039 default: False 02040 """ 02041 02042 @staticmethod 02043 def panel(): 02044 """ 02045 panel -- code for splitting into multiple panels for spectral plotting 02046 options: 'p','b','i','t','s' or 02047 'pol','beam','if','time','scan' 02048 default: 'i' 02049 example: maximum of 25 panels 02050 panel by pol, beam, if, time, scan 02051 """ 02052 02053 @staticmethod 02054 def pbcor(): 02055 """ Correct final image for primary beam or not. 02056 02057 default: False; example pbcor=True 02058 02059 """ 02060 02061 02062 @staticmethod 02063 def phasecenter(): 02064 """ 02065 phasecenter -- image phase center (for ASAP tasks) or mosaic center: 02066 direction measure or fieldid 02067 default: '' (imply field=0 as center) 02068 example: phasecenter=6 02069 phasecenter='J2000 19h30m00 -40d00m00' 02070 """ 02071 02072 @staticmethod 02073 def phasewrap(): 02074 """ Difference in phase (degrees) between points for 02075 tuning the GSPLINE phase wrapping algorithm. 02076 """ 02077 02078 @staticmethod 02079 def planes(): 02080 """ 02081 planes -- Range of planes to include in the moment 02082 default: '' (all); 02083 example: axis=3; planes='3~9' 02084 This will select channels 3-9 from axis 3 (spectral axis) 02085 """ 02086 02087 @staticmethod 02088 def plot(): 02089 """ 02090 plot -- Plot result or not 02091 default: False (not plot) 02092 example: if True, result will be plotted 02093 """ 02094 02095 @staticmethod 02096 def plotcolor(): 02097 """ 02098 plotcolor -- pylab color. Overrides plotsymbol color settings. 02099 See cookbook for details 02100 default: 'darkcyan' 02101 example: plotcolor='g' (green) 02102 plotcolor='slateblue' 02103 plotcolor='#7FFF34' (RGB tuple) 02104 """ 02105 02106 @staticmethod 02107 def plotfile(): 02108 """ 02109 plotfile -- file name for hardcopy output 02110 options: (str) filename.eps, .ps, .png 02111 default: '' (no hardcopy) 02112 """ 02113 02114 @staticmethod 02115 def plotlevel(): 02116 """ 02117 plotlevel -- control for plotting of results 02118 options: (int) 0(none), 1(some), 2(more), <0(hardcopy) 02119 default: 0 (no plotting) 02120 02121 Given a negative value, hardcopy plot will be named <infile>_scans.eps. 02122 """ 02123 02124 @staticmethod 02125 def plotrange(): 02126 """ 02127 plotrange -- Specifies the size of the plot [xmin, xmax, ymin, ymax] 02128 default: [0,0,0,0]; example: [-20,100,15,30] 02129 Note that if xmin=xmax the values will be ignored and a best 02130 guess will be made, simlarly if ymin=ymax. 02131 time axes coordinate is in Julian Days, unfortunately. 02132 """ 02133 02134 @staticmethod 02135 def plotstyle(): 02136 """ 02137 plotstyle -- customise plot settings 02138 options: (bool) True, False 02139 default: True 02140 """ 02141 02142 @staticmethod 02143 def plotsymbol(): 02144 """ 02145 plotsymbol -- pylab plot symbol. See cookbook for details 02146 default: '.': large points 02147 ',' = small points 02148 '-' = connect points by line 02149 02150 """ 02151 02152 @staticmethod 02153 def plottype(): 02154 """ 02155 plottype -- type of plot 02156 options: 'spectra','totalpower','pointing','azel' 02157 default: 'spectra' 02158 """ 02159 02160 @staticmethod 02161 def pointingcolumn(): 02162 """ 02163 pointingcolumn -- pointing data column to use 02164 options: 'direction','target','pointing_offset','source_offset','encoder' 02165 default: 'direction' 02166 """ 02167 02168 @staticmethod 02169 def pointingspacing(): 02170 """ 02171 pointingspacing -- spacing in between beams 02172 default: '1arcmin' 02173 """ 02174 02175 @staticmethod 02176 def pointtable(): 02177 """ Name of pointing calibration table: """ 02178 02179 @staticmethod 02180 def polaverage(): 02181 """ 02182 polaverage -- average polarizations 02183 options: True,False 02184 default: False 02185 """ 02186 02187 @staticmethod 02188 def pollist(): 02189 """ 02190 pollist -- list of polarization id numbers to select 02191 default: [] (all) 02192 example: [1] 02193 02194 this selection is in addition to scanlist, field, and iflist. 02195 """ 02196 02197 @staticmethod 02198 def poly(): 02199 """ 02200 poly -- A polygonial region in the directional portion of 02201 an image. The directional portion of an image are the axes 02202 for right ascension and declination, for example. Polygons 02203 are specified as a list of points, the end points of each 02204 line segment in the polygon as follows: x1, y1, x2, y2, x3, y3,... 02205 ONLY pixel values acceptable at this time. 02206 Default: none (all); 02207 Example: poly='0,10,25,25,25,0' 02208 Example: poly='20,20,0,25,25,0;100,110,133,110,112,125,100,110' 02209 """ 02210 02211 02212 @staticmethod 02213 def prior(): 02214 """ 02215 ------parameters useful for mem only 02216 prior -- Prior image to guide mem 02217 02218 mosaic: 02219 prior -- Name of MEM prior images 02220 default: ['']; example: prior='source_mem.image' 02221 02222 """ 02223 02224 @staticmethod 02225 def project(): 02226 """ 02227 project -- root for output file names 02228 default: 'sim' 02229 """ 02230 02231 @staticmethod 02232 def psf(): 02233 """ 02234 psf -- Name of psf image to use e.g psf='mypsf.image' . 02235 But if the psf has 3 parameter, then 02236 a gaussian psf is assumed with the values representing 02237 the major , minor and position angle values 02238 e.g psf=['3arcsec', '2.5arcsec', '10deg'] 02239 """ 02240 @staticmethod 02241 def psfmode(): 02242 """ 02243 psfmode -- Distinguish between Clark and Hogbom style of clean 02244 default='clark' 02245 example: psfmode='hogbom' 02246 """ 02247 02248 @staticmethod 02249 def pweight(): 02250 """ 02251 pweight -- weighting for polarization average 02252 options: 'var' = 1/var(spec) weighted 02253 'tsys' = 1/Tsys**2 weighted 02254 default: 'tsys' 02255 """ 02256 02257 @staticmethod 02258 def pwv(): 02259 """ 02260 precipitable water vapor if constructing an atmospheric model. 02261 Set 0 for noise-free simulation. 02262 """ 02263 02264 @staticmethod 02265 def quackinterval(): 02266 """ 02267 quackinterval -- Time interval (n timestamps) at scan boundary for VLA quack-flagging 02268 """ 02269 02270 @staticmethod 02271 def quackmode(): 02272 """ 02273 quackmode -- 'beg','end','both' 02274 """ 02275 02276 @staticmethod 02277 def refant(): 02278 """ Reference antenna: """ 02279 02280 @staticmethod 02281 def refdate(): 02282 """ 02283 refdate -- central time of simulated observation 02284 default: '2012/05/21/22:05:00' 02285 02286 * [alpha] observations are centered at the nearest transit. 02287 """ 02288 02289 @staticmethod 02290 def refdirection(): 02291 """ 02292 refdirection -- reference direction of the model image. 02293 options: (str) 'direction', 'header', or reference 02294 direction, e.g., 'J2000 19h00m00 -40d00m00' 02295 default: 'direction' 02296 """ 02297 02298 @staticmethod 02299 def reference(): 02300 """ 02301 reference -- Reference field name(s) 02302 The names of the fields with a known flux densities or structures. 02303 The syntax is similar to field. Hence source index or 02304 names can be used. 02305 default: none; example: reference='1328+307' 02306 The model visibility is determined by using task setjy or task ft 02307 with a given source structure. 02308 """ 02309 02310 @staticmethod 02311 def refpixel(): 02312 """ 02313 refpixel -- reference pixel (CRPIX) 02314 options: '[x,y]' or 'center' or 'header' 02315 default: 'center' 02316 example: '[100,100]' 02317 """ 02318 02319 @staticmethod 02320 def refspwmap(): 02321 """ 02322 refspwmap -- Vector of spectral windows enablings scaling across spectral windows 02323 default: [-1]==> none. 02324 Example with 4 spectral windows: if the reference fields were observed only in spw=1 & 3, 02325 and the transfer fields were observed in all 4 spws (0,1,2,3), specify refspwmap=[1,1,3,3]. 02326 This will ensure that transfer fields observed in spws 0,1,2,3 will be referenced to 02327 reference field data only in spw 1 or 3. Pray you don't have to do this. 02328 """ 02329 02330 @staticmethod 02331 def region(): 02332 """ 02333 Region over which to carry out the operation. For ia tool methods, this is usually specified 02334 as a python dictionary returned from an rg tool method (rg.box(), rg.fromtextfile() etc). 02335 In image analysis tasks, the region can be specified in one of several ways: 02336 (a) Using the CASA region format 02337 (http://casaguides.nrao.edu/index.php?title=CASA_Region_Format) 02338 Example : region='box [ [ 100pix , 130pix] , [120pix, 150pix ] ]' 02339 region='circle [ [ 120pix , 40pix] ,6pix ]' 02340 region='circle[[19h58m52.7s,+40d42m06.04s ], 30.0arcsec]' 02341 Multiple regions may be specified as a list of pixel ranges. 02342 (b) Filename with cleanbox shapes defined using the CASA region format. 02343 Example: region='myregion.txt' 02344 The file 'myregion.txt' contains : 02345 box [ [ 100pix , 130pix ] , [ 120pix, 150pix ] ] 02346 circle [ [ 150pix , 150pix] ,10pix ] 02347 rotbox [ [ 60pix , 50pix ] , [ 30pix , 30pix ] , 30deg ] 02348 (c) Filename for region in binary format (e.g. from viewer or rg.tofile()). 02349 Example: region='myregion.rgn' 02350 """ 02351 02352 @staticmethod 02353 def rejwn(): 02354 """ 02355 redwn -- wave number(s) of sinusoids NOT to be used for fitting. 02356 can be set just as addwn but has higher priority: 02357 wave numbers which are specified both in addwn and 02358 rejwn will NOT be used. 02359 (list) and (int) are accepted to specify every 02360 wave numbers. also (str) can be used in case 02361 you need to specify wave numbers in a certain range, 02362 example: 'a-b' (= a, a+1, a+2, ..., b-1, b), 02363 '<a' (= 0,1,...,a-2,a-1), 02364 '>=a' (= a, a+1, ... up to the maximum wave 02365 number corresponding to the Nyquist 02366 frequency for the case of FFT). 02367 default: [] 02368 """ 02369 02370 @staticmethod 02371 def relmargin(): 02372 """ 02373 relmargin -- how close pointing centers may approach the edge of the 02374 output image, as a fraction of pointingspacing. 02375 * ignored if direction is a list. 02376 options: (float) 02377 default: 1.0 02378 """ 02379 02380 @staticmethod 02381 def removeoldpanels(): 02382 """ 02383 removeoldpanels -- Turn on/off automatic clearing of plot panels 02384 that lie under the current panel plotting. 02385 default: True (removed underlying panels). 02386 """ 02387 02388 @staticmethod 02389 def replacetopplot(): 02390 """ 02391 replacetopplot -- When overplotting, replace the last plot only 02392 default: False 02393 """ 02394 02395 @staticmethod 02396 def residualfile(): 02397 """ Residual image file. Contains the residual of the 02398 original image and its fitted image. 02399 default: 02400 example: residualfile="myimage.fit.residual" 02401 """ 02402 02403 @staticmethod 02404 def restfreq(): 02405 """ 02406 restfreq -- Specify rest frequency to use for image 02407 options: (float) or (string with unit) : see example 02408 default: '' (try to use the one specified in input data) 02409 example: 4.6e10, '46GHz' 02410 Allowed units are 'THz','GHz','MHz','kHz', and 'Hz' 02411 """ 02412 02413 @staticmethod 02414 def rmode(): 02415 """ Robustness mode; used for weighting='briggs': """ 02416 02417 @staticmethod 02418 def robust(): 02419 """ Brigg's robustness parameter. 02420 02421 Options: -2.0 (close to uniform) to 2.0 (close to natural) 02422 02423 """ 02424 02425 @staticmethod 02426 def rowlist(): 02427 """ 02428 rowlist -- list of row numbers to process 02429 default: [] (use all rows) 02430 example: [0,2,4,6] 02431 For expert users only! 02432 this selection is applied first, and then followed by 02433 the selection with scans, fields, ifs, and polarizations. 02434 """ 02435 02436 @staticmethod 02437 def scales(): 02438 """ 02439 --- Multiscale parameter 02440 scales -- in pixel numbers; the size of component to deconvolve 02441 default = [0,3,10] 02442 """ 02443 02444 @staticmethod 02445 def scaletsys(): 02446 """ 02447 scaletsys -- scaling of associated Tsys 02448 options: True,False 02449 default: True 02450 """ 02451 02452 @staticmethod 02453 def scaletype(): 02454 """ Image plane flux scale type. 02455 02456 Options: 'SAULT', 'PBCOR' 02457 02458 """ 02459 02460 @staticmethod 02461 def scan(): 02462 """ Scan number range 02463 default: ''=all""" 02464 02465 @staticmethod 02466 def scanaverage(): 02467 """ 02468 scanaverage -- average integrations within scans 02469 options: (bool) True,False 02470 default: False 02471 """ 02472 02473 @staticmethod 02474 def scanlist(): 02475 """ 02476 scanlist -- list of scan numbers to process 02477 default: [] (use all scans) 02478 example: [21,22,23,24] 02479 this selection is in addition to field, iflist, and pollist 02480 """ 02481 02482 @staticmethod 02483 def showflags(): 02484 """ 02485 showflags -- Show the flagged and unflagged data. 02486 default: False; example: showflags=True 02487 """ 02488 02489 @staticmethod 02490 def showgui(): 02491 """ 02492 showgui -- Turn on/off the displaying of the plotting GUI 02493 default: True; example: showgui=False 02494 """ 02495 02496 @staticmethod 02497 def showprogress(): 02498 """ 02499 showprogress -- show progress status for large data 02500 default: True 02501 """ 02502 02503 @staticmethod 02504 def sigma(): 02505 """ 02506 ------parameters useful for mem only 02507 sigma -- Estimated noise for image 02508 02509 mosaic: 02510 sigma -- Target image sigma 02511 default: '0.001Jy'; example: sigma='0.1Jy' 02512 02513 """ 02514 02515 @staticmethod 02516 def sigmafile(): 02517 """ 02518 sigmafile -- File contain weights to be applied to an 02519 image file when doing profile fitting. 02520 default: 02521 example: sigmafile='myimage.weights' 02522 """ 02523 02524 @staticmethod 02525 def singledish(): 02526 """ 02527 singledish -- Set True to write data as single-dish format (Scantable) 02528 default: False 02529 task: importasdm 02530 """ 02531 02532 @staticmethod 02533 def smallscalebias(): 02534 """ 02535 smallscalebias -- A bias toward smaller scales in multiscale 02536 clean. The peak flux found at each scale is weighted by 02537 a factor = 1 - smallscalebias*scale/max_scale, so that weighted 02538 peak flux = peak flux*factor. 02539 Typically the values range from 0.2 to 1.0. 02540 default: 0.6 02541 """ 02542 02543 @staticmethod 02544 def smoothsize(): 02545 """ 02546 smoothsize -- smoothing beam in Pressed-out 02547 default: 2.0 (interpreted as 2.0 * beamsize) 02548 example: '1arcmin' (set smoothsize directly) 02549 """ 02550 02551 @staticmethod 02552 def smoothtime(): 02553 """ The smoothing filter time (sec). """ 02554 02555 @staticmethod 02556 def smoothtype(): 02557 """ The smoothing filter to be used for calibration solutions. 02558 02559 Options: 'mean','median','smean'(sliding mean),'smedian'(sliding median), 02560 'none'(copy table) 02561 02562 """ 02563 02564 @staticmethod 02565 def solint(): 02566 """ Solution interval (in seconds): """ 02567 02568 @staticmethod 02569 def solnorm(): 02570 """ Normalize the resulting solutions after the solve (True/False): """ 02571 02572 02573 @staticmethod 02574 def sourcepar(): 02575 """ 02576 sourcepar -- Starting guess for component parameters (flux,xoffset,yoffset) 02577 default: [1,0,0]; example: sourcepar=[2.5,0.3,0.1] 02578 Note: Flux is in Jy, xoffset is in arcsec, yoffset is in arcsec. 02579 """ 02580 02581 @staticmethod 02582 def specunit(): 02583 """ 02584 specunit -- units for spectral axis 02585 options: (str) 'channel','km/s','GHz','MHz','kHz','Hz' 02586 default: '' (=current) 02587 example: this will be the units for masklist 02588 """ 02589 02590 @staticmethod 02591 def splinetime(): 02592 """ Spline timescale (sec); used for gaintype='GSPLINE' """ 02593 02594 @staticmethod 02595 def splitdata(): 02596 """ 02597 splitdata -- Split out continuum and continuum subtracted line data 02598 default: 'False'; example: splitdata=True 02599 The continuum data will be in: vis.cont 02600 The continuum subtracted data will be in: vis.contsub 02601 """ 02602 02603 @staticmethod 02604 def sprange(): 02605 """ 02606 sprange -- range for spectral axis of plot 02607 options: (list) [min,max] 02608 default: [] (full range) 02609 example: sprange=[42.1,42.5] if 'GHz' assumes current specunit 02610 """ 02611 02612 @staticmethod 02613 def spw(): 02614 """ 02615 (for sdimaging) 02616 spw -- spectral window id 02617 default: 0 02618 example: 1 02619 02620 this selection is in addition to scanlist and field 02621 02622 ----------------------------------------------------------------- 02623 02624 (for other tasks) 02625 spw -- Select spectral window/channels 02626 default: '' (all spectral windows and channels) 02627 example: spw='0~2,4' = spectral windows 0,1,2,4 (all channels)) 02628 spw='<2' = spectral windows less than 2 (i.e. 0,1)) 02629 spw='0:5~61' = spw 0, channels 5 to 61) 02630 spw='0,10,3:3~45' = spw 0,10 all channels, spw 3, channels 3 to 45. 02631 spw='0~2:2~6' = spw 0,1,2 with channels 2 through 6 in each. 02632 spw='0:0~10;15~60' = spectral window 0 with channels 0-10,15-60 02633 spw='0:0~10,1:20~30,2:1;2;3' = spw 0, channels 0-10, 02634 spw 1, channels 20-30, and 02635 spw 2, channels, 1,2 and 3 02636 """ 02637 02638 @staticmethod 02639 def spwmap(): 02640 """ This parameter is used to indicate how solutions derived from different 02641 spectral windows should be applied to other spectral windows. Nominally data 02642 in each spectral window will be corrected by solutions derived from the same 02643 spectral window. This is the default behavior of spwmap, i.e., if spwmap is 02644 not specified, data will be corrected by solutions from the same spectral window. 02645 Otherwise, spwmap[j]=i causes soutions derived from the i-th spectral window 02646 to be used to correct the j-th spectral window. For example, if bandpass solutions 02647 are available for spectral windows 1 and 3, and it is desired that these be 02648 applied to spws 2 and 4 (as well as 1 and 3), use spwmap=[1,1,3,3]. """ 02649 02650 @staticmethod 02651 def stack(): 02652 """ 02653 stack -- code for stacking on single plot for spectral plotting 02654 options: 'p','b','i','t','s' or 02655 'pol', 'beam', 'if', 'time', 'scan' 02656 default: 'p' 02657 example: maximum of 25 stacked spectra 02658 stack by pol, beam, if, time, scan 02659 """ 02660 02661 @staticmethod 02662 def standard(): 02663 """ Flux density standard: 02664 02665 Options: 'Baars', 'Perley 90', 'Perley-Taylor 95', 02666 'Perley-Taylor 99', 'Perley-Butler 2010', 'Butler-JPL-Horizons 2010' 02667 02668 """ 02669 02670 @staticmethod 02671 def start(): 02672 """ 02673 start -- start channel 02674 default: 0 02675 """ 02676 02677 @staticmethod 02678 def startfreq(): 02679 """ 02680 startfreq -- frequency of first channel 02681 default: '89GHz' 02682 """ 02683 02684 @staticmethod 02685 def starttime(): 02686 """ 02687 starttime -- Time after which data will be considered for importing 02688 default: '1970/1/31/00:00:00' 02689 starttime = '' gives error message 02690 """ 02691 02692 @staticmethod 02693 def step(): 02694 """ 02695 step -- increment between channels 02696 default: 1 02697 """ 02698 02699 @staticmethod 02700 def stokes(): 02701 """ 02702 stokes -- stokes parameters to select/image 02703 options: 'I','IV','QU','IQUV',... 02704 'RR', 'LL', can only be done by flagging one polarization 02705 """ 02706 02707 @staticmethod 02708 def stoptime(): 02709 """ 02710 stoptime -- Time before which data will be considered for importing 02711 default: '2199/1/31/23:59:59' 02712 stoptime = '' gives error message 02713 """ 02714 02715 @staticmethod 02716 def stretch(): 02717 """ 02718 If mask is specified, stretch is true and if the number of mask 02719 dimensions is less than or equal to the number of image dimensions 02720 and some axes in the mask are degenerate while the corresponding 02721 axes in the image are not, the mask will be stetched in the 02722 degenerate dimensions. For example, if the input image has shape 02723 [100, 200, 10] and the input mask has shape [100, 200, 1] and stretch 02724 is true, the mask will be stretched along the third dimension to shape 02725 [100, 200, 10]. However if the mask is shape [100, 200, 2], stretching 02726 is not possible and an error will result. 02727 """ 02728 02729 @staticmethod 02730 def subplot(): 02731 """ 02732 (for sdplot) 02733 subplot -- number of subplots (row and column) on a page. 02734 NOTICE plotter will slow down when a large number is 02735 specified 02736 default: -1 (auto) 02737 example: 23 (2 rows by 3 columns) 02738 --------------------------------------------------------------- 02739 (for the others) 02740 subplot -- Panel number on the display screen 02741 default: 111 (full screen display); example: 02742 if iteration is non-blank, then 02743 subplot=yx1 window will produce y by x plots in the window. 02744 if iteration = '', then 02745 subplot=yxn; means the window will have y rows, and x columns 02746 with the present execution placing the plot in location n 02747 n = 1,..., xy, in order upper left to right, then down. An 02748 example is the plotting of four fields on one frame 02749 field='0'; subplot=221; plotxy() 02750 field='1'; subplot=222; plotxy() 02751 field='2'; subplot=223; plotxy() 02752 field='3'; subplot=224; plotxy() 02753 02754 """ 02755 02756 @staticmethod 02757 def t_atm(): 02758 """ 02759 t_atm -- atmospheric temperature in K 02760 default: 260.0 02761 """ 02762 02763 @staticmethod 02764 def t_ground(): 02765 """ 02766 t_ground -- ambient temperature in K 02767 default: 269.0 02768 """ 02769 02770 @staticmethod 02771 def tablein(): 02772 """ Input calibration table: 02773 """ 02774 02775 @staticmethod 02776 def tablename(): 02777 """ 02778 tablename -- Name of table file on disk (MS, calibration table, image) 02779 default: none; example: tablename='ngc5921.ms' 02780 """ 02781 02782 @staticmethod 02783 def targetflux(): 02784 """ 02785 ------parameters useful for mem only 02786 targetflux -- Target total flux in image 02787 02788 mosaic: 02789 targetflux -- Target flux for final image 02790 default: '1.0Jy'; example: targetflux='200Jy' 02791 02792 """ 02793 02794 @staticmethod 02795 def tau(): 02796 """ 02797 tau -- atmospheric optical depth 02798 default: 0.0 (no correction) 02799 """ 02800 02801 @staticmethod 02802 def tau0(): 02803 """ 02804 tau0 -- zenith opacity at observing frequency 02805 default: 0.1 02806 """ 02807 02808 @staticmethod 02809 def telescopeparm(): 02810 """ 02811 telescopeparm -- the telescope name or characteristics 02812 options: (str) name or (list) list of gain info 02813 default: '' (none set) 02814 example: if telescopeparm='', it tries to get the telescope 02815 name from the data. 02816 Full antenna parameters (diameter,ap.eff.) known 02817 to ASAP are 02818 'ATPKSMB', 'ATPKSHOH', 'ATMOPRA', 'DSS-43', 02819 'CEDUNA','HOBART'. For GBT, it fixes default fluxunit 02820 to 'K' first then convert to a new fluxunit. 02821 telescopeparm=[104.9,0.43] diameter(m), ap.eff. 02822 telescopeparm=[0.743] gain in Jy/K 02823 telescopeparm='FIX' to change default fluxunit 02824 """ 02825 02826 @staticmethod 02827 def thresh(): 02828 """ 02829 thresh -- S/N threshold for linefinder 02830 default: 5 02831 example: a single channel S/N ratio above which the channel is 02832 considered to be a detection 02833 """ 02834 02835 @staticmethod 02836 def threshold(): 02837 """ 02838 threshold -- flux level at which to stop CLEANing (units=mJy) 02839 """ 02840 02841 @staticmethod 02842 def timeaverage(): 02843 """ 02844 timeaverage -- average times for multiple scan cycles 02845 options: (bool) True,False 02846 default: False 02847 """ 02848 02849 @staticmethod 02850 def timebin(): 02851 """ 02852 Interval width for time averaging. 02853 default: '0s' or '-1s' (no averaging) 02854 example: timebin='30s' 02855 '10' means '10s' 02856 """ 02857 02858 @staticmethod 02859 def timerange(): 02860 """ Select time range for subset of data. 02861 02862 default = '' (all); examples, 02863 timerange = 'YYYY/MM/DD/hh:mm:ss~YYYY/MM/DD/hh:mm:ss' 02864 Note: if YYYY/MM/DD is missing dat defaults to first day in data set 02865 timerange='09:14:0~09:54:0' picks 40 min on first day 02866 timerange= '25:00:00~27:30:00' picks 1 hr to 3 hr 30min on next day 02867 timerange='09:44:00' data within one integration of time 02868 timerange='>10:24:00' data after this time 02869 02870 02871 Note: currently for flagdata task, this must be in the format: 02872 dd-mmm-yyyy/hh:mm:ss.s 02873 02874 help par.selectdata will provide extra syntax. 02875 02876 """ 02877 02878 @staticmethod 02879 def title(): 02880 """ 02881 title -- Plot title (above plot) 02882 default: ''; example: title='This is my title' 02883 """ 02884 02885 @staticmethod 02886 def tmax(): 02887 """ 02888 tmax -- maximum value used for process 02889 default: 0.0 (no threshold in maximum) 02890 example: 10.0 (mask data larger value than 10.0) 02891 """ 02892 02893 @staticmethod 02894 def tmin(): 02895 """ 02896 tmin -- minimum value used for process 02897 default: 0.0 (no threshold in minimum) 02898 example: -10.0 (mask data smaller value than -10.0) 02899 """ 02900 02901 @staticmethod 02902 def transfer(): 02903 """ 02904 transfer -- Transfer field name(s) 02905 The names of the fields with a unknown flux densities. These should 02906 be point-like calibrator sources. 02907 The syntax is similar to field. Hence source index or 02908 names can be used. 02909 default: none: all calibrators must be listed. 02910 example: transfer='1445+099, 3C84'; transfer = '0,4' 02911 Note: to concatenate two strings 02912 str1 = '1445+099'; str2 = '3C84' 02913 example: transfer = str1 + ', ' + str2 02914 02915 NOTE: All sources in reference and transfer must have gains in the 02916 caltable fit. 02917 """ 02918 02919 @staticmethod 02920 def truncate(): 02921 """ 02922 truncate -- truncattion radius of convolution kernel. 02923 effective only for 'GAUSS' and 'GJINC'. 02924 default: '-1' (use default for each gridfunction) 02925 example: 3, '20arcsec', '3pixel' 02926 """ 02927 02928 @staticmethod 02929 def tweight(): 02930 """ 02931 tweight -- weighting for time average 02932 options: 02933 'var' = 1/var(spec) weighted 02934 'tsys' = 1/Tsys**2 weighted 02935 'tint' = integration time weighted 02936 'tintsys' = Tint/Tsys**2 02937 'median' = median averaging 02938 default: 'tintsys' 02939 """ 02940 02941 @staticmethod 02942 def unflag(): 02943 """ Option to unflag data rather than flag it (flagdata task): """ 02944 02945 @staticmethod 02946 def uvtaper(): 02947 """ 02948 uvtaper -- Apply additional filtering/uv tapering of the visibilities. 02949 defalt=False; example: uvtaper=True 02950 02951 --- uvtaper parameters 02952 outertaper -- taper the outer edge of the uv-coverage 02953 the values can be in terms of uv units or psf units 02954 default []; example outertaper=['4klambda', '4klambda', '0deg'] 02955 example outertaper=['20arcsec', '10arcsec', '10deg'] 02956 """ 02957 02958 02959 @staticmethod 02960 def uvrange(): 02961 """ 02962 uvrange -- Select data within uvrange 02963 default: '' (all); example: 02964 uvrange='0~1000klambda'; uvrange from 0-1000 kilolambda 02965 uvrange='>4klambda';uvranges greater than 4 kilolambda 02966 See help par.selectdata for additional syntax. 02967 """ 02968 02969 @staticmethod 02970 def varlist(): 02971 """ 02972 varlist -- Dictionary of variables used in expr (mathematical 02973 expression) and their values. Keys must be coincide with 02974 variables used in expr. Values are substituted in each 02975 value in expr. 02976 default: {} (empty dictionary) 02977 task: sdmath 02978 """ 02979 02980 @staticmethod 02981 def velocity(): 02982 """ 02983 velocity -- Prefer velocity (rather than frequency) as spectral axis 02984 default: False 02985 02986 """ 02987 02988 @staticmethod 02989 def verbose(): 02990 """ 02991 (for sdbaseline) 02992 verbose -- output fitting results to logger and a file as well 02993 default: True 02994 example: If False, the fitting results including coefficients, 02995 residual rms, etc., are not output to either the CASA 02996 logger or a text file (<outfile>_blparam.txt), while 02997 the processing speed gets faster by a factor of about 20 percent 02998 02999 --------------------------------------------------------------- 03000 03001 (for others) 03002 verbose -- List each observation in addition to the summary (True or False): 03003 """ 03004 03005 @staticmethod 03006 def verify(): 03007 """ 03008 verify -- verify the results. 03009 options: (bool) True,False 03010 default: False 03011 """ 03012 03013 @staticmethod 03014 def verifybl(): 03015 """ 03016 verifybl -- verify the results of baseline fitting 03017 options: (bool) True,False 03018 default: False 03019 """ 03020 03021 @staticmethod 03022 def verifycal(): 03023 """ 03024 verifycal -- verify the results of calibration 03025 options: (bool) True,False 03026 default: False 03027 WARNING: Currently verifying parameters just asks whether you 03028 accept the displayed calibraion/fit and if not, 03029 continues without doing any calibraion/baseline fit. 03030 """ 03031 03032 @staticmethod 03033 def verifysm(): 03034 """ 03035 verifysm -- verify the results of smoothing 03036 options: (bool) True,False 03037 default: False 03038 """ 03039 03040 @staticmethod 03041 def versionname(): 03042 """ 03043 versionname -- Flag version name 03044 default: none; example: versionname='original_data' 03045 No imbedded blanks in the versionname 03046 """ 03047 03048 @staticmethod 03049 def vis(): 03050 """ Input visibility file; CASA MeasurementSet on disk: """ 03051 03052 @staticmethod 03053 def visnorm(): 03054 """ Normalize the assembled spectral data, in a per baseline manner. If visnorm=True is 03055 used, this will have the effect of removing any non-frequency dependent closure errors 03056 (e.g., as caused by source structure, or introduced by the instrument) from the data, 03057 and should be used with caution. When visnorm=False is used, closure errors in the data 03058 (as supplied to the solver) may be visible in the form of offsets between the data and 03059 solutions. For bandpass calibration, this is usually okay, as the shape of the bandpass 03060 is the most important aspect of the solution. 03061 03062 """ 03063 03064 @staticmethod 03065 def weighting(): 03066 """ Weighting to apply to visibilities: 03067 03068 Options: 'natural','uniform','briggs','radial','superuniform' 03069 03070 """ 03071 03072 @staticmethod 03073 def weight(): 03074 """ 03075 weight -- weight type (both lower-case and upper-case are 03076 acceptable) 03077 options: 'UNIFORM', 03078 'TSYS' (1/Tsys**2 weighted) 03079 'TINT' (integration time weighted) 03080 'TINTSYS' (Tint/Tsys**2) 03081 default: 'UNIFORM' 03082 """ 03083 03084 @staticmethod 03085 def whichhdu(): 03086 """ 03087 whichhdu -- If fits file contains multiple images, 03088 choose this one 03089 default=0 mean first; example: whichhdu=1 03090 """ 03091 03092 @staticmethod 03093 def whichrep(): 03094 """ 03095 whichrep -- If fits image has multiple coordinate reps, 03096 choose one. 03097 default: 0 means first; example: whichrep=1 03098 """ 03099 03100 @staticmethod 03101 def width(): 03102 """ 03103 Channel width (value>1 indicates channel averaging: 03104 """ 03105 03106 @staticmethod 03107 def windowsize(): 03108 """ 03109 windowsize -- Window size 03110 default: 1.0; example: windowsize=0.5 03111 """ 03112 03113 @staticmethod 03114 def writestation(): 03115 """ 03116 writestation -- Write station name instead of antenna name 03117 default: True; 03118 """ 03119 03120 @staticmethod 03121 def writesyscal(): 03122 """ 03123 writesyscal -- Write GC and TY tables 03124 default: False; system temparature and gain tables. 03125 """ 03126 03127 @staticmethod 03128 def xaxis(): 03129 """ 03130 xaxis -- Visibility file (MS) data to plot along the x-axis 03131 default: 'time' 03132 Options: 03133 'azimuth, 'elevation','baseline','hourangle','parallacticangle', 03134 'uvdist','time','u','v','w','x' 03135 If plotting versus a data quantity (yaxis='amp'), add options: 03136 'channel','real','imag','amp','phase' 03137 Note: xaxis='x' is equivalent to running taskname='plotants' 03138 yaxis -- Visibility data to plot along the y-axis 03139 default: 'amp' 03140 Data quantity options: 'amp','phase','real','imag' 03141 Other options: 'azimuth','elevation','baseline','hourangle','parallacticangle', 03142 'u','v','w','uvdist' 03143 """ 03144 03145 @staticmethod 03146 def xlabels(): 03147 """ 03148 xlabels -- Label for x axis 03149 default: ''; example: xlabels='X Axis' 03150 """ 03151 03152 @staticmethod 03153 def yaxis(): 03154 """ 03155 xaxis -- Visibility file (MS) data to plot along the x-axis 03156 default: 'time' 03157 Options: 03158 'azimuth, 'elevation','baseline','hourangle','parallacticangle', 03159 'uvdist','time','u','v','w','x' 03160 If plotting versus a data quantity (yaxis='amp'), add options: 03161 'channel','real','imag','amp','phase' 03162 Note: xaxis='x' is equivalent to running taskname='plotants' 03163 yaxis -- Visibility data to plot along the y-axis 03164 default: 'amp' 03165 Data quantity options: 'amp','phase','real','imag' 03166 Other options: 'azimuth','elevation','baseline','hourangle','parallacticangle', 03167 'u','v','w','uvdist' 03168 """ 03169 03170 @staticmethod 03171 def ylabels(): 03172 """ 03173 ylabels -- Label for y axis 03174 default: ''; example: ylabels='Y Axis' 03175 """ 03176 03177 @staticmethod 03178 def zeroblanks(): 03179 """ 03180 zeroblanks -- Set blanked pixels to zero (not NaN) 03181 default=True; example: zeroblanks=True 03182 """ 03183 03184 @staticmethod 03185 def selectdata(): 03186 """ 03187 selectdata() 03188 CASA selectdata syntax (March 13, 2008): 03189 03190 In CASA, there is a common data selection syntax that is used for the all 03191 tasks that need a specific subset of the data from visibility data (measurement 03192 set). These are: 03193 03194 field: the selection of names associated with a source or mosaic group. 03195 spw: the selection of spectral windows and channels associated with 03196 all sources specified by field 03197 selectdata: The subset of other parameters which may be needed for the 03198 appropriate selection of data. 03199 03200 The field and spw parameters are always visible when displaying the input parameters, 03201 but the additional parameters are only visible when <selectdata = true>. 03202 03203 The input and help file documentation for each of the tasks should provide an adequate 03204 description of the data selection syntax needed to process the appopriate data for 03205 most applications. However, the data selection capabilities are powerful and still 03206 evolving, hence a full description of the syntax is needed, and given below. 03207 03208 All of the parameter values must be placed within quotes since they are formally 03209 strings, even though they often represent integers. The string property allows a 03210 richer set of parameter usage. The field and antenna parameters can be either the 03211 field_id or antenna_id (the array index used in CASA for this parameter) or the actual 03212 names of the field or antenna. For these two parameters, if the string is a 03213 non-negative integer, it is interpreted as an array index. Otherwise, it is interpreted 03214 as the name. REMEMBER, CASA INDICES START WITH 0. Illegal strings are ',',';','"','/'. 03215 03216 Execute <inp='plotxy'>, for example, to determine the parameters of the visibility data. 03217 03218 field -- The field names (sources) processed by the task or tool: 03219 03220 field = '' data for all field_ids 03221 field = '1' data for field_id = 1 03222 field = 'P1151+3435' data for field P1151+3435 03223 field = '2~4' data for field_ids 2,3,4 03224 field = '2,3,4' data for field_ids 2,3,4 03225 field = 'P11*,3,4~6' data for field_ids 3,4,5,6 and any source name 03226 beginning with P11 03227 field = '*11,8' data for field_id 8 and any source ending with 11 03228 03229 spw -- The spectral window/channel selection for all fields to be processed: 03230 03231 spw = '0' spectral window_id=0, all channels 03232 spw = '0:0~63' sp id=0, channels 0 to 63, INCLUSIVE. 03233 spw = '0,1,4~7' sp ids=0,1,4,5,6,7, all channels 03234 spw = '*:3~64' channels 3 through 64 for all sp ids 03235 spw = ' :3~64' will NOT work. 03236 spw = '*:0;60~63' channel 0 and channels 60,61,62,63 for all IFs 03237 ';' needed to separate different channel ranges in one spw 03238 spw = '0:34, 2:10~12,3~4:0~33' 03239 sp id=0, channel 34; sp id=2, channels 10,11,12; 03240 sp ids 3 and 4, channels 0 through 33, inclusive. 03241 03242 There is also a skipping parameter, denoted by '^' 03243 03244 spw = '0:0~14^3' sp id=0, every third channel in 0 to 14 03245 i.e. channels 0,3,6,9,12 03246 spw = '0:0~6^2 ,0:6~38^4' 03247 sp id=1. channels, 0,2,4,6,10,14,18,22,26,30,34,38 03248 spw = '*:^2' all spw, every second channel 03249 03250 NOTE: Channel ranges in velocity or frequency have limited functionality. 03251 03252 03253 selectdata = true will open some or all of the following parameters: 03254 03255 antenna -- The antennas and/or baselines for all fields/spw to be processed: 03256 03257 NOTE: Some tasks require specific antennas, some tasks require specific 03258 baselines. See help for each task. 03259 NOTE: Antennas can be designated by index or by antenna name depending on 03260 how the data were written into CASA. 03261 03262 antenna-oriented syntax: 03263 antenna = '' all antennas and (of course) baselines 03264 antenna = '0,2~18' baselines that contain antenna indices 0, or 2 thru 18. 03265 antenna = '0,VA05' baselines that contain antenna index 0 and VLA antenna 5 03266 antenna = 'VA*,EA13,EA14' baselines that contain all VLA antennas and 03267 EVLA antennas 13,14 03268 antenna = 'MK,SC,PT,LA' baselines that contain VLBA antennas at MK, SC 03269 PT, LA 03270 03271 baseline-oriented syntax: 03272 antenna = '0 & 1' baseline with antenna index 0 and 1 03273 antenna = 'VA05 & VA06' baseline with VLA antenna 5 and 6 03274 antenna = 'VA* & EV*' baselines between VLA and EVLA antennas 03275 antenna = '0~5 & 23~25,27' all baselines betweeen antennas 0 through 5 03276 versus 23 through 25, and all baselines 03277 associated with 27. 03278 03279 timerange -- The time range to be processed: 03280 03281 The time syntax is T = 'YYYY/MM/DD/HH:MM:SS.FF' 03282 Most applications will use a time range such as: 03283 03284 timerange = 'T0~T1' timer range between T0 and T1 03285 timerange = '2007/5/3/5:44:13.33 ~ 2007/5/3/6:44:13.33' 03286 timerange = '5:44:13.33 ~ 6:44:13.33' same as above if the earliest visibility 03287 data point is on day 2007/5/3 03288 03289 timerange = '5:44:13.33 + 0:2:0' Time from 5:44:13.33 to 2 min later 03290 timerange = '>6:12:20.0' Time after 6:12:20 03291 timerange = '<8:12:20.0' Time before 8:12:20 (on data of first data point) 03292 timerange = '2007/5/3/5:44:13.33' Time stamp within one data sampling time interval 03293 03294 Other short-cuts 03295 '2007/06/03/6' 2007June03 at 6h 03296 '2007/06/03/5:44' 2007June03 at 5h44m 03297 03298 if part of the year, month and day are missing, the date (egs. 2000/06/03) of the 03299 earliest visibility data point is assumed: 03300 03301 03/5:44 2007/06 assumed 03302 23:24:23 2007/06/03 assumed 03303 25:18:44 2007/06/03 assumed, i.e 03304 2007/06/04/01:18:44 03305 03306 03307 correlation -- the correlators to be processed: 03308 03309 Antenna-based correlations are: 'R', 'L', 'X', 'Y' 03310 Baseline-base correlations are: 'RR', 'LL', 'RL', 'LR', 03311 'XX', 'YY', 'XY', 'YX' 03312 Various combinations are allowed, and these are task specific 03313 egs. correlation = 'RR LL' in plotxy 03314 03315 uvrange -- The uvrange to be processed: 03316 03317 uvrange = 'UVMIN ~ UVMAXklambda' uvrange from UVMIN to UVMAX in klambda 03318 uvrange = 'UVMIN ~ UVMAXkm' uvrange from UVMIN to UMMAX in km 03319 klambda, km, m, ml, l available 03320 uvrange = '<100km' uvrange less than 100 km 03321 uvrange = '<100km,>1000km' uvrange less than 100 km, but more than 1000 km 03322 03323 The default units for uvrange are METERS! 03324 03325 scan -- The scan range to be processed: 03326 03327 Syntax associated with non-negative integers 03328 03329 scan = '0~20' scan range 0 through 20 03330 scan = '2,5,8' scans 2, 5 and 8 03331 03332 feed -- The multi-feed number to be processed 03333 03334 Not yet implemented. Syntax associated with non-negative integers 03335 03336 feed = '0~20' feed range 0 through 20 03337 feed = '2,5,8' feeds 2, 5 and 8 03338 03339 array -- The array number associated with the data 03340 03341 Not yet implemented. 03342 """