plotms – A plotter/interactive flagger for visibility data. – visualization, information,editing, manipulation, utility task

Description

Task for plotting and interacting with visibility data. Limited support for caltable plotting is also included as of CASA v4.1.

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).

Most basic functions (plotting, iteration, locate, flagging) will work for most CalTables. Parameterized CalTables (delays, antpos, gaincurve, opacity), will, at best, currently just plot the simple parameters contained in the table, not the effective amplitudes or phases sampled at observing times, frequencies etc. BPOLY and GSPLINE tables are not yet supported. Features currently unsupported for CalTables include Averaging, Transformations (velocity conversions, etc.), and some details of selection (channel and polarization selection are not yet enabled) and axes choices (geometry options are not yet enabled). In the plotms gui, many options irrelevant for CalTables are not yet hidden when interacting with a CalTable, and such settings will be ignored (when benign) or cause an error message.

Parameters

Title
Parameter	Default	Description
vis	`''`
gridrows	`int(1)`
gridcols	`int(1)`
rowindex	`int(0)`
colindex	`int(0)`
plotindex	`int(0)`
xaxis	`''`
xdatacolumn	`''`
yaxis	`''`
ydatacolumn	`''`
yaxislocation	`''`
selectdata	`True`
field	`''`
spw	`''`
timerange	`''`
uvrange	`''`
antenna	`''`
scan	`''`
correlation	`''`
array	`''`
observation	`''`
intent	`''`
feed	`''`
msselect	`''`
averagedata	`True`
avgchannel	`''`
avgtime	`''`
avgscan	`False`
avgfield	`False`
avgbaseline	`False`
avgantenna	`False`
avgspw	`False`
scalar	`False`
transform	`True`
freqframe	`''`
restfreq	`''`
veldef	`'RADIO'`
shift	`numpy.array( [ float(0.0),float(0.0) ] )`
extendflag	`False`
extcorr	`False`
extchannel	`False`
iteraxis	`''`
xselfscale	`False`
yselfscale	`False`
xsharedaxis	`False`
ysharedaxis	`False`
customsymbol	`[ ]`
symbolshape	`'autoscaling'`
symbolsize	`int(2)`
symbolcolor	`'0000ff'`
symbolfill	`'fill'`
symboloutline	`False`
coloraxis	`''`
customflaggedsymbol	`False`
flaggedsymbolshape	`'circle'`
flaggedsymbolsize	`int(2)`
flaggedsymbolcolor	`'ff0000'`
flaggedsymbolfill	`'fill'`
flaggedsymboloutline	`False`
plotrange	`numpy.array( [ ] )`
title	`''`
titlefont	`int(0)`
xlabel	`''`
xaxisfont	`int(0)`
ylabel	`''`
yaxisfont	`int(0)`
showmajorgrid	`False`
majorwidth	`int(1)`
majorstyle	`''`
majorcolor	`'B0B0B0'`
showminorgrid	`False`
minorwidth	`int(1)`
minorstyle	`''`
minorcolor	`'D0D0D0'`
showlegend	`False`
legendposition	`''`
plotfile	`''`
expformat	`''`
exprange	`''`
highres	`False`
dpi	`int(-1)`
width	`int(-1)`
height	`int(-1)`
overwrite	`False`
showgui	`True`
clearplots	`True`
callib	`numpy.array( [ ] )`

Parameter Explanations

vis

''

input MS (or CalTable) (blank for none)

gridrows

int(1)

Number of subplot rows (default 1).

gridcols

int(1)

Number of subplot columns (default 1).

rowindex

int(0)

Row location of the plot (0-based, default 0)

colindex

int(0)

Column location of the plot (0-based, default 0)

plotindex

int(0)

Index to address a subplot (0-based, default 0)

xaxis

''

plot x-axis (blank for default/current)

xdatacolumn

''

data column to use for x-axis (blank for default/current)

yaxis

''

plot y-axis (blank for default/current)

ydatacolumn

''

data column to use for y-axis (blank for default/current)

yaxislocation

''

whether to use a left or right y-axis for the data (blank for default)

selectdata

True

data selection parameters

field

''

field names or field index numbers (blank for all)

spw

''

spectral windows:channels (blank for all)

timerange

''

time range (blank for all)

uvrange

''

uv range (blank for all)

antenna

''

antenna/baselines (blank for all)

scan

''

scan numbers (blank for all)

correlation

''

correlations (blank for all)

array

''

(sub)array numbers (blank for all)

observation

''

observation ID(s) (blank for all)

intent

''

observing intent (blank for all)

feed

''

Select feed (blank for all)

msselect

''

MS selection (blank for all)

averagedata

True

data averaging parameters

avgchannel

''

average over channel? (blank = False, otherwise value in channels)

avgtime

''

average over time? (blank = False, other value in seconds)

avgscan

False

only valid if time averaging is turned on. average over scans?

avgfield

False

only valid if time averaging is turned on. average over fields?

avgbaseline

False

average over all baselines? (mutually exclusive with avgantenna)

avgantenna

False

average by per-antenna? (mutually exclusive with avgbaseline)

avgspw

False

average over all spectral windows?

scalar

False

Do scalar averaging?

transform

True

transform data in various ways?

freqframe

''

the frame in which to render frequency and velocity axes

restfreq

''

Rest frequency to use for velocity conversions

veldef

'RADIO'

the definition in which to render velocity

shift

numpy.array( [ float(0.0),float(0.0) ] )

Adjust phases by this approximate phase center shift [dx,dy] (arcsec)

extendflag

False

have flagging extend to other data points?

extcorr

False

extend flags based on correlation?

extchannel

False

extend flags based on channel?

iteraxis

''

the axis over which to iterate

xselfscale

False

If true, iterated plots should share a common x-axis label per column.

yselfscale

False

If true, iterated plots should share a common y-axis label per row.

xsharedaxis

False

Plots should share a common x-axis. Must also set xselfscale=True.

ysharedaxis

False

Plots should share a common y-axis. Must also set yselfscale=True.

customsymbol

[ ]

set a custom symbol(s) for unflagged points

symbolshape

'autoscaling'

shape of plotted unflagged symbols

symbolsize

int(2)

size of plotted unflagged symbols

symbolcolor

'0000ff'

color of plotted unflagged symbols

symbolfill

'fill'

fill type of plotted unflagged symbols

symboloutline

False

selects outlining plotted unflagged points

coloraxis

''

selects which data to use for colorizing

customflaggedsymbol

False

set a custom plot symbol for flagged points

flaggedsymbolshape

'circle'

shape of plotted flagged symbols

flaggedsymbolsize

int(2)

size of plotted flagged symbols

flaggedsymbolcolor

'ff0000'

color of plotted flagged symbols

flaggedsymbolfill

'fill'

fill type of plotted flagged symbols

flaggedsymboloutline

False

selects outlining plotted flagged points

plotrange

numpy.array( [ ] )

plot axes ranges: [xmin,xmax,ymin,ymax]

title

''

Title written along top of plot

titlefont

int(0)

Font for plot title

xlabel

''

Text for horizontal axis. Blank for default.

xaxisfont

int(0)

Font for plot x-axis

ylabel

''

Text for vertical axis. Blank for default.

yaxisfont

int(0)

Font for plot y-axis.

showmajorgrid

False

Show major grid lines (horiz and vert.)

majorwidth

int(1)

Line width in pixels of major grid lines

majorstyle

''

Major grid line style: solid dash dot none

majorcolor

'B0B0B0'

Color as name or hex code of major grid lines

showminorgrid

False

Show minor grid lines (horiz and vert.)

minorwidth

int(1)

Line width in pixels of minor grid lines

minorstyle

''

Minor grid line style: solid dash dot none

minorcolor

'D0D0D0'

Color as name or hex code of minor grid lines

showlegend

False

Show a legend on the plot.

legendposition

''

Legend position.

plotfile

''

Name of plot file to save automatically.

expformat

''

Export format type (jpg, png, ps, pdf, txt), if not provided, plotfile extension will be used.

exprange

''

Export all iteration plots or only the current one.

highres

False

Use high resolution

dpi

int(-1)

DPI of exported plot

width

int(-1)

Width of exported plot

height

int(-1)

Height of exported plot

overwrite

False

Overwrite plot file if it already exists?

showgui

True

Show GUI

clearplots

True

Remove any existing plots so new ones can replace them.

callib

numpy.array( [ ] )

Calibration library string or filename for on-the-fly calibration.