|
casa
$Rev:20696$
|
|
casa
$Rev:20696$
|
Functions | |
| def | plotms |
| def plotms.plotms | ( | vis = '', |
|
xaxis = '', |
|||
xdatacolumn = '', |
|||
yaxis = '', |
|||
ydatacolumn = '', |
|||
selectdata = True, |
|||
field = '', |
|||
spw = '', |
|||
timerange = '', |
|||
uvrange = '', |
|||
antenna = '', |
|||
scan = '', |
|||
correlation = '', |
|||
array = '', |
|||
observation = '', |
|||
msselect = '', |
|||
averagedata = True, |
|||
avgchannel = '', |
|||
avgtime = '', |
|||
avgscan = False, |
|||
avgfield = False, |
|||
avgbaseline = False, |
|||
avgantenna = False, |
|||
avgspw = False, |
|||
scalar = False, |
|||
transform = False, |
|||
freqframe = '', |
|||
restfreq = '', |
|||
veldef = 'RADIO', |
|||
shift = [0.0, |
|||
extendflag = False, |
|||
extcorr = False, |
|||
extchannel = False, |
|||
iteraxis = '', |
|||
xselfscale = False, |
|||
yselfscale = False, |
|||
customsymbol = True, |
|||
symbolshape = 'autoscaling', |
|||
symbolsize = 2, |
|||
symbolcolor = '0000ff', |
|||
symbolfill = 'fill', |
|||
symboloutline = False, |
|||
coloraxis = '', |
|||
customflaggedsymbol = False, |
|||
flaggedsymbolshape = 'nosymbol', |
|||
flaggedsymbolsize = 2, |
|||
flaggedsymbolcolor = 'ff0000', |
|||
flaggedsymbolfill = 'fill', |
|||
flaggedsymboloutline = False, |
|||
plotrange = [
], |
|||
title = '', |
|||
xlabel = '', |
|||
ylabel = '', |
|||
showmajorgrid = False, |
|||
majorwidth = 1, |
|||
majorstyle = '', |
|||
majorcolor = 'B0B0B0', |
|||
showminorgrid = False, |
|||
minorwidth = 1, |
|||
minorstyle = '', |
|||
minorcolor = 'D0D0D0', |
|||
plotfile = '', |
|||
expformat = '', |
|||
highres = False, |
|||
interactive = False, |
|||
overwrite = False |
|||
| ) |
A plotter/interactive flagger for visibility data.
Task for plotting and interacting with visibility data. A variety
of axes choices (including data column) along with MS selection and
averaging options are provided for data selection. Flag extension
parameters are also available for flagging operations in the plotter.
All of the provided parameters can also be set using the GUI once
the application has been launched. Additional and more specific
operations are available through the GUI and/or through the plotms
tool (pm).
Keyword arguments:
vis -- input visibility dataset
default: ''
xaxis, yaxis -- what to plot on the two axes
default: '' (defaults are xaxis='time',
yaxis='amp' on first execution;
thereafter the most recent
settings are used)
valid options (=indicates valid synonyms):
MS Ids and other meta info:
'scan' (number)
'field' (index)
'time',
'interval'='timeint'='timeinterval'='time_interval'
'spw' (index)
'chan'='channel' (index)
'freq'='frequency' (GHz)
'vel'='velocity' (km/s)
'corr'='correlation' (index)
'ant1'='antenna1' (index)
'ant2'='antenna2' (index)
'baseline' (a baseline index)
'row' (absoute row Id from the MS)
Visibility values, flags:
'amp'='amplitude'
'phase' (deg)
'real'
'imag'='imaginary'
'wt'='weight'
'flag'
'flagrow'
Observational geometry:
'uvdist' (meters)
'uvwave'='uvdistl'='uvdist_l' (wavelengths, per channel)
'u' (meters)
'v' (meters)
'w' (meters)
'uwave' ('u' in wavelengths, per channel)
'vwave' ('v' in wavelengths, per channel)
'wwave' ('w' in wavelengths, per channel)
'azimuth' (at array reference; degrees)
'elevation' (at array reference; degrees)
'hourang'='hourangle' (at array reference; hours)
'parang'='parangle'='parallacticangle' (at array reference; degrees)
Antenna-based (only works vs. data Ids):
'ant'='antenna'
'ant-azimuth'
'ant-elevation'
'ant-parang'='ant-parangle'
>>> xaxis, yaxis expandable parameters
xdatacolumn,
ydatacolumn -- which data column to use for Visibility values:
default: '' ('data' on first execuation;
thereafter the most recent
setting is used)
valid options: 'data' (observed)
'corrected'='corr'
'model'
'residual' (corrected - model)
selectdata -- data selection parameters flag
default: True (reveals data selection parameters
described below)
Consult listobs output for data selection values,
and see help par.selectdata for more detailed
information on syntax; also, visit
http://casa.nrao.edu/other_doc.shtml and click
on "Measurement Set selection syntax" for more
tips on using data selection parameters in CASA)
>>> selectdata expandable parameters:
field -- Select field using field id(s) or field name(s).
default: ''=all fields
If field string is a non-negative integer, it is assumed a
field index, otherwise, it is assumed a field name
field='0~2'; field ids 0,1,2
field='0,4,5~7'; field ids 0,4,5,6,7
field='3C286,3C295'; field named 3C286 and 3C295
field = '3,4C*'; field id 3, all names starting with 4C
spw -- Select spectral window/channels
type 'help par.selection' for more examples.
spw='0~2,4'; spectral windows 0,1,2,4 (all channels)
spw='<2'; spectral windows less than 2 (i.e. 0,1)
spw='0:5~61'; spw 0, channels 5 to 61, INCLUSIVE
spw='*:5~61'; all spw with channels 5 to 61
spw='0,10,3:3~45'; spw 0,10 all channels, spw 3, channels 3 to 45.
spw='0~2:2~6'; spw 0,1,2 with channels 2 through 6 in each.
spw='0:0~10;15~60'; spectral window 0 with channels 0-10,15-60
NOTE ';' to separate channel selections
timerange -- Select data based on time range:
default = '' (all); examples,
timerange = 'YYYY/MM/DD/hh:mm:ss~YYYY/MM/DD/hh:mm:ss'
Note: if YYYY/MM/DD is missing date defaults to first day in data set
timerange='09:14:0~09:54:0' picks 40 min on first day
timerange= '25:00:00~27:30:00' picks 1 hr to 3 hr 30min on NEXT day
timerange='09:44:00' pick data within one integration of time
timerange='>10:24:00' data after this time
uvrange -- Select data within uvrange (default units meters)
default: '' (all); example:
uvrange='0~1000klambda'; uvrange from 0-1000 kilo-lambda
uvrange='>4klambda';uvranges greater than 4 kilo lambda
antenna -- Select data based on antenna/baseline
default: '' (all, including auto-correlations, if present)
If antenna string is a non-negative integer, it is assumed an
antenna index, otherwise, it is assumed as an antenna name
antenna='5&6'; baseline between antenna index 5 and index 6.
antenna='!ea02'; exclude EVLA antenna 2.
antenna='ea13;!ea22'; EVLA antenna 13, excluding antenna 22.
antenna='VA05&VA06'; baseline between VLA antenna 5 and 6.
antenna='5&6;7&8'; baselines with indices 5-6 and 7-8
antenna='5'; all baselines with antenna index 5
antenna='05'; all baselines with antenna number 05 (VLA old name)
antenna='5,6,10'; all baselines with antennas 5,6,10 index numbers
NB: For explicit selections, use a single ampersand (&) to
select only cross-correlations among the specified antennas,
double ampersands (&&) to select cross- and
auto-correlations among the specified antennas, and
triple ampersands (&&&) to select only
auto-correlations. E.g.:
antenna='*&'; selects all cross-correlation baseline
(excludes all auto-correlations)
antenna='*&&&'; selects all auto-correlation baselines
(excludes all cross-correlations)
antenna='1&&1,2,3'; selects baselines 1-1 (auto), 1-2,1-3 (cross)
antenna='VA05&&&'; selects the VA05 autocorrelation
See the link noted above for more information.
scan -- Scan numbers or ranges.
default: '' (all scans)
scan='1,2,6,43'; scans 1, 2, 6, and 43
scan='3~14'; scans 3 through 14, inclusive
correlation -- Select by correlation
default: '' (all correlations)
options: 'RR','RL','LR','LL','XX','XY','YX','YY',
or any comma-separated combination; use
basis (R/L or X/Y) appropriate to the MS)
array -- Select the array id
default: '' (all array ids)
observation Select by observation ID(s).
default: ''-->all;
example: observation='0' (select obsID 0)
msselect -- Optional TaQL data selection
averagedata -- data averaing parameters flag
default: True (reveals expandable parameters
described below)
>>> averagedata expandable parameters
avgchannel -- average over channel? either blank for none, or a value
in channels.
default: '' (no channel averaging).
avgtime -- average over time? either blank for none, or a value in
seconds.
default: '' (no time averaging).
avgscan -- average over scans? only valid if time averaging is turned
on.
default: False.
avgfield -- average over fields? only valid if time averaging is
turned on.
default: False.
avgbaseline -- average over selected baselines; mutually
exclusive with avgantenna.
default: False. (no averaging over baseline)
avgantenna -- form per-antenna averages; mutually exclusive with
avgbaseline.
default: False. (no per-antenna averaging)
avgspw -- average over selected spectral windows?
default: False. (no average of spectral windows)
scalar -- scalar averaging?
default: False (i.e., do vector averaging)
transform -- apply various transformations on data for plotting
default: False.
>>> transform expandable parameters
freqframe -- the coordinate frame in which to render frequency and velocity axes
default: '' (unspecified: will use frame in which data were taken)
options: TOPO, GEO, BARY, LSRK, LSRD
restfreq -- the rest frequency to use in velocity conversions (MHz)
default: '' (use spw central frequency and show relative velocity)
example: '22235.08MHz'
veldef -- the velocity definition to use
default: 'RADIO'
options: 'RADIO','OPT','TRUE'
shift -- adjust phase according to a phase center shift [dx,dy] (arcsec)
default: [0,0] (no shift)
extendflag -- have flagging extend to other data points?
default: False.
>>> extendflag expandable parameters
extcorr -- extend flags based on correlation?
default: False.
extchannel -- extend flags based on channel?
iteraxis -- axis upon which iterate plots (one plot per page, for now)
default: '' (no iteration)
options: 'scan','field','spw','baseline','antenna',''
>>> iteraxis expandable parameters
xselfscale -- If true, self-scale each iterated plot on the x axis
yselfscale -- If true, self-scale each iterated plot on the y axis
default: false, which will scale all plots globally
customsymbol -- If true, use a custom symbol for drawing unflagged points
default: True
>>> customsymbol expandable parameters
symbolshape -- If true, use a custom shape to draw unflagged symbols
default: 'autoscaling' (ignores symbolsize)
options: 'autoscaling', 'circle', 'square', 'diamond', 'pixel', 'nosymbol'
symbolsize -- size of the unflagged symbols in pixels
default: 2
symbolcolor -- color to use for unflagged symbols; can be a RGB hex code or a color name
default: '0000ff'
example: 'purple'
symbolfill -- type of fill to use for unflagged symbols
default: 'fill'
options: 'fill', 'mesh1', 'mesh2', 'mesh3', 'nofill'
symboloutline -- If true, outline unflagged symbols in black
coloraxis -- axis upon which to colorize the plotted points
options (= indicates synonyms):
'scan', 'field', 'spw', 'antenna1'='ant1', 'antenna2'='ant2',
'baseline', 'channel'='chan', 'corr'='correlation'
default: '' (use a single color for all points)
customflaggedsymbol -- If true, use a custom symbol for drawing flagged points
default: False
>>> customflaggedsymbol expandable parameters
symbolshape -- If true, use a custom shape to draw flagged symbols
default: 'nosymbol'
options: 'autoscaling', 'circle', 'square', 'diamond', 'pixel', 'nosymbol'
symbolsize -- size of the flagged symbols in pixels
default: 2
symbolcolor -- color to use for flagged symbols; can be a RGB hex code or a color name
default: '0000ff'
example: 'purple'
symbolfill -- type of fill to use for flagged symbols
default: 'fill'
options: 'fill', 'mesh1', 'mesh2', 'mesh3', 'nofill'
symboloutline -- If true, outline flagged symbols in black
plotrange -- manual plot axis ranges: [xmin,xmax,ymin,ymax]
Does not affect data selection.
default: []; both axes will be autoscaled according
to the ranges found in the selected data
If xmin=xmax (or ymin=ymax) then that axis will
be autoscaled, e.g.:
[0,0,-2.0,14.0]; autoscale the xaxis, and use
ymin=-2.0, ymax=14.0
title -- title along top of plot (called "canvas" in some places)
xlabel -- text to label horizontal axis, with formatting using '%%'
ylabel -- text to label horizontal axis, with formatting using '%%'
showmajorgrid -- show major grid lines (horiz and vert.)
default: False.
>>> major grid expandable parameters
majorwidth -- line width in pixels of major grid lines
majorstyle -- major grid line style: solid dash dot none
majorcolor -- color in hex code of major grid lines
showminorgrid -- show minor grid lines (horiz and vert.)
default: False.
>>> minor grid expandable parameters
minorwidth -- line width in pixels of minor grid lines
minorstyle -- minor grid line style: solid dash dot none
minorcolor -- color in hex code of minor grid lines
plotfile -- name of plot file to save automatically
default: '' (i.e., draw an interactive plot in the gui)
>>> plotfile expandable parameters
expformat -- export format type; if 'txt' is used an ASCII dump of the plotted points is generated (also available in the export tab)
default: '' (plotfile extension will be used)
options: 'jpg', 'png', 'ps', 'pdf', 'txt'
highres -- use high resolution? Always true for jpg and png.
default: false
interactive -- interactive mode? (pop up confirmation window)
default: false (e.g., for automated scripts to prevent blocking).
overwrite -- Overwrite plot file if it already exists?
default: falseDefinition at line 14 of file plotms.py.
References alma-ngc3256-analysis-regression.name.
1.8.0