1.3.3.0 msplot.checkplotxy

NRAO Home > CASA > CASA Toolkit Reference Manual

msplot.checkplotxy - Function

1.3.3 Routine for checking the sanity of a plotxy plot.

Description

Do a sanity checks of all the inputs that have been given. This includes checking the plot option values (mp.plotoptions()), data selection (mp.setdata()), and spectral selections (mp.setspectral()).

Also included in the sanity checks is a check to see how many points will be plotted. If there are millions of points to be plotted, but do not want to wait for a large plot try setting the skipnrows or averagenrows plot options.

Arguments


Inputs
x	X-axis, a column name in measurement ests’ main table. Valid values are: antenna1, antenna2, aziumth, baseline, channel, corrected, data, elevation, feed1, feed2, field_id, frequency, hourangle, ifr_number, model, parallactic_angle, residual, scan_number, time, u, uvdist, v, velocity, w, and weight.
	allowed:	string
	Default:	uvdist
y	Y-axis, a column name in the measurment sets’ main table. Valid values are the same as the X-axis values.
	allowed:	string
	Default:	data
xcolumn	The column name in the measurement sets’ msin table. Valid values are: data, corrected, model, and residual.
	allowed:	string
	Default:	data
ycolumn	The column name in the measurement sets’ msin table. Valid values are: data, corrected, model, and residual.
	allowed:	string
	Default:	data
xvalue	String, needed if X or Y is data quantity: amp, phase, real, and imag
	allowed:	string
	Default:	amp
yvalue	String, needed if X or Y is data quantity: amp, phase, real, and imag
	allowed:	string
	Default:	amp
iteration	List of strings: Antenna1, Antenna2, Feed1, Feed2, Field_id, Scan_number, and Time. Spectral Window/Polarization_id( not available yet )
	allowed:	stringArray
	Default:

Returns
bool

Example

# create a msplot tool, do some data selections and
# plot option selection and  check the validty of them.
mp.open( msname=’./data/3C273XC1.ms’);
mp.setdata( antennaNames=’VLA:N*’, fieldNames=’1~3’, correlations=’RR, LL’,\
      spwIndex=[3,4,5] );
mp.plotoptions( windowsize=5,aspectratio=0.8, fontsize=14.0, \
       xlabel=’uvdist’, ylabel=’amplitude’, title=’Amplitude vs. UVdist’,
       plotsymbol=’g+’ );
mp.checkplotxy( X=’uvdist’, Y=’’, column=’data’, iteration=[’antenna1, ’antenna2’]);

__________________________________________________________________

[next] [prev] [prev-tail] [front] [up]

More information about CASA may be found at the CASA web page

This code is available under the terms of the GNU General Public Lincense