List of all members.
Detailed Description
Proxy of C++ casac::plotms class
Definition at line 70 of file plotms.py.
Constructor & Destructor Documentation
Member Function Documentation
enableIter(self, enable) -> bool
Summary
A _temporary_ method to enable toggling the interation infrastructure
Input Parameters:
enable If true, enable iteration, else disable.
--------------------------------------------------------------------------------
Definition at line 1028 of file plotms.py.
getCachedImageHeight(self) -> int
Summary
Gets the height of the cached images.
--------------------------------------------------------------------------------
Definition at line 200 of file plotms.py.
getCachedImageWidth(self) -> int
Summary
Gets the width of the cached images.
--------------------------------------------------------------------------------
Definition at line 189 of file plotms.py.
getClearSelectionOnAxesChange(self) -> bool
Summary
Gets whether any selections are cleared on an axes change or not.
--------------------------------------------------------------------------------
Definition at line 151 of file plotms.py.
getColorAxis(self, plotIndex=0) -> string
Summary
What data controls the colorizing?
Input Parameters:
plotIndex the index of the plot to get the value for 0
--------------------------------------------------------------------------------
Definition at line 793 of file plotms.py.
getColorizeFlag(self, plotIndex=0) -> bool
Summary
Get colorization flag
Input Parameters:
plotIndex the index of the plot to get colorization for 0
--------------------------------------------------------------------------------
Definition at line 717 of file plotms.py.
getFlagExtension(self) -> record *
Summary
Gets the flag extension parameters.
--------------------------------------------------------------------------------
Definition at line 847 of file plotms.py.
getGridMajorShown(self, plotIndex=0) -> bool
Summary
Gets state of visibililty of major grid lines
Input Parameters:
plotIndex the index of the plot to get the value for 0
--------------------------------------------------------------------------------
Definition at line 869 of file plotms.py.
getGridMajorWidth(self, plotIndex=1) -> int
Summary
Gets width of major grid lines
Input Parameters:
plotIndex the index of the plot to get the value for 1
--------------------------------------------------------------------------------
Definition at line 899 of file plotms.py.
getGridMinorShown(self, plotIndex=0) -> bool
Summary
Gets state of visibililty of minor grid lines
Input Parameters:
plotIndex the index of the plot to get the value for 0
--------------------------------------------------------------------------------
Definition at line 884 of file plotms.py.
getGridMinorWidth(self, plotIndex=1) -> int
Summary
Gets width of minor grid lines
Input Parameters:
plotIndex the index of the plot to get the value for 1
--------------------------------------------------------------------------------
Definition at line 914 of file plotms.py.
getLogFilename(self) -> string
Summary
Gets the log filename used by plotms.
--------------------------------------------------------------------------------
Definition at line 99 of file plotms.py.
getLogFilter(self) -> string
Summary
Gets the log's priority filter.
--------------------------------------------------------------------------------
Definition at line 125 of file plotms.py.
getPlotMSAveraging(self, plotIndex=0) -> record *
Summary
Gets the MS averaging parameters.
Input Parameters:
plotIndex the index of the plot to get the value for 0
--------------------------------------------------------------------------------
Definition at line 345 of file plotms.py.
getPlotMSFilename(self, plotIndex=0) -> string
Summary
Gets the MS filename.
Input Parameters:
plotIndex the index of the plot to get the value for 0
--------------------------------------------------------------------------------
Definition at line 228 of file plotms.py.
getPlotMSSelection(self, plotIndex=0) -> record *
Summary
Gets the MS selection parameters.
Input Parameters:
plotIndex the index of the plot to get the value for 0
--------------------------------------------------------------------------------
Definition at line 288 of file plotms.py.
getPlotMSTransformations(self, plotIndex=0) -> record *
Summary
Gets the MS transformations parameters.
Input Parameters:
plotIndex the index of the plot to get the value for 0
--------------------------------------------------------------------------------
Definition at line 419 of file plotms.py.
getPlotParams(self, plotIndex=0) -> record *
Summary
Returns the plot params.
Input Parameters:
plotIndex the index of the plot to get the params for 0
--------------------------------------------------------------------------------
Definition at line 647 of file plotms.py.
getPlotXAxis(self, plotIndex=0) -> string
Summary
Gets the x plot axis.
Input Parameters:
plotIndex the index of the plot to get the value for 0
--------------------------------------------------------------------------------
Definition at line 587 of file plotms.py.
getPlotXDataColumn(self, plotIndex=0) -> string
Summary
Gets the data column for the x plot axis.
Input Parameters:
plotIndex the index of the plot to get the value for 0
--------------------------------------------------------------------------------
Definition at line 602 of file plotms.py.
getPlotYAxis(self, plotIndex=0) -> string
Summary
Gets the y plot axis.
Input Parameters:
plotIndex the index of the plot to get the value for 0
--------------------------------------------------------------------------------
Definition at line 617 of file plotms.py.
getPlotYDataColumn(self, plotIndex=0) -> string
Summary
Gets the data column for the y plot axis.
Input Parameters:
plotIndex the index of the plot to get the value for 0
--------------------------------------------------------------------------------
Definition at line 632 of file plotms.py.
getTitle(self, plotIndex=0) -> string
Summary
Gets the title for the plot
Input Parameters:
plotIndex the index of the plot to get the value for 0
--------------------------------------------------------------------------------
Definition at line 485 of file plotms.py.
getXAxisLabel(self, plotIndex=0) -> string
Summary
Gets the text for the horizontal axis
Input Parameters:
plotIndex the index of the plot to get the value for 0
--------------------------------------------------------------------------------
Definition at line 500 of file plotms.py.
getYAxisLabel(self, plotIndex=0) -> string
Summary
Gets the text for the vertical axis
Input Parameters:
plotIndex the index of the plot to get the value for 0
--------------------------------------------------------------------------------
Definition at line 515 of file plotms.py.
hide(self)
Summary
Hides the plotms window.
--------------------------------------------------------------------------------
Definition at line 977 of file plotms.py.
isClosed(self) -> bool
Summary
Has the plot received a closeEvent?
--------------------------------------------------------------------------------
Definition at line 1017 of file plotms.py.
isDrawing(self) -> bool
Summary
Is the plot being drawn?
--------------------------------------------------------------------------------
Definition at line 1006 of file plotms.py.
locateInfo(self) -> record *
Summary
Locates points in a specified region.
--------------------------------------------------------------------------------
Definition at line 858 of file plotms.py.
save(self, plotfile, format, highres=False, interactive=False) -> bool
Summary
save plot to file
Input Parameters:
plotfile name of plot file
format Format type, if not provided, attempt will be made to guess from plotfile extension
highres Use high resolution? Always true for jpg and png. false
interactive Interactive mode (will pop up confirmation window if true, set false for automated scripts to prevent blocking). false
--------------------------------------------------------------------------------
Definition at line 988 of file plotms.py.
setCachedImageSize(self, width, height)
Summary
Sets the size for the cached images.
Input Parameters:
width width of the cached images
height height of the cached images
--------------------------------------------------------------------------------
Definition at line 162 of file plotms.py.
setCachedImageSizeToScreenResolution(self)
Summary
Sets the size for the cached images to the current screen resolution.
--------------------------------------------------------------------------------
Definition at line 178 of file plotms.py.
setClearSelectionOnAxesChange(self, clearSelection)
Summary
Sets whether any selections are cleared on an axes change or not.
Input Parameters:
clearSelection clear selection flag
--------------------------------------------------------------------------------
Definition at line 136 of file plotms.py.
setColorAxis(self, coloraxis, updateImmediately=True, plotIndex=0)
Summary
Sets the plot x axis to the given.
Input Parameters:
coloraxis name of the axis choice for x (blank to keep current)
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------
Definition at line 732 of file plotms.py.
setColorizeFlag(self, colorize, updateImmediately=True, plotIndex=0)
Summary
Sets the plot x axis to the given.
Input Parameters:
colorize name of the axis choice for x (blank to keep current)
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------
Definition at line 700 of file plotms.py.
setFlagExtension(self, extend=False, correlation=string(""), channel=False, spw=False, antenna=string(""),
time=False, scans=False, field=False, alternateSelection=initialize_record(""))
Summary
Sets the flag extension parameters.
Input Parameters:
extend whether to extend flags or not false
correlation extend on correlation; one of: '', 'all', 'poln-dep'
channel extend on channel false
spw extend on spw false
antenna extend on antenna; one of: '', 'all', antenna-based value
time extend on time false
scans extend on scans (only valid if time is true) false
field extend on field (only valid if time is true) false
alternateSelection alternate MS selection, in record form, or empty record for none
--------------------------------------------------------------------------------Definition at line 808 of file plotms.py.
setFlagExtensionRec(self, flagExtension)
Summary
Sets the flag extension parameters.
Input Parameters:
flagExtension flag extension parameters, in record form
--------------------------------------------------------------------------------
Definition at line 832 of file plotms.py.
setFlaggedSymbol(self, shape=string("nosymbol"), size=2, color=string("ff0000"), fill=string("fill"), outline=False,
updateImmediately=True, plotIndex=0)
Summary
Sets the flagged plot symbol
Input Parameters:
shape flagged symbol shape (autoscaling, circle, square, diamond, pixel, nosymbol) nosymbol
size size of the flaggedsymbol in pts 2
color color of the flagged symbol, in hex (ex. 'ff0000') ff0000
fill flagged point fill type (fill, mesh1, mesh2, mesh3, no fill) fill
outline sets outline on plotted flagged points False
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------Definition at line 771 of file plotms.py.
setGridParams(self, showmajorgrid=False, majorwidth=1, majorstyle=string("solid"), majorcolor=string("B0B0B0"),
showminorgrid=False, minorwidth=1, minorstyle=string("solid"), minorcolor=string("C0CCE0"),
updateImmediately=True, plotIndex=0)
Summary
Set color, style for major and minor grid lines
Input Parameters:
showmajorgrid Show major grid lines (horiz. and vert.)? false
majorwidth Line width for major grid lines, pixels 1
majorstyle Line style for major grid lines solid
majorcolor Color of major grid lines B0B0B0
showminorgrid Show minor grid lines (horiz. and vert.)? false
minorwidth Line width for minor grid lines, pixels 1
minorstyle Line style for minor grid lines solid
minorcolor Color of minor grid lines C0CCE0
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------Definition at line 929 of file plotms.py.
setLogFilename(self, logFilename=string("casapy.log"))
Summary
Sets the log filename to be used by plotms.
Input Parameters:
logFilename log filename for plotms to use casapy.log
--------------------------------------------------------------------------------Definition at line 84 of file plotms.py.
setLogFilter(self, priority)
Summary
Sets the log's priority filter.
Input Parameters:
priority string representation of minimum priority
--------------------------------------------------------------------------------
Definition at line 110 of file plotms.py.
setPlotAxes(self, xAxis=string(""), yAxis=string(""), xDataColumn=string(""), yDataColumn=string(""),
updateImmediately=True, plotIndex=0)
Summary
Sets the plot axes to the given.
Input Parameters:
xAxis name of the axis choice for x (blank to keep current)
yAxis name of the axis choice for y (blank to keep current)
xDataColumn name of the data column to use for the x axis, if applicable (blank to keep current)
yDataColumn name of the data column to use for the y axis, if applicable (blank to keep current)
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------Definition at line 566 of file plotms.py.
setPlotMSAveraging(self, channel=string(""), time=string(""), scan=False, field=False, baseline=False, antenna=False,
spw=False, scalar=False, updateImmediately=True, plotIndex=0)
Summary
Sets the MS averaging parameters.
Input Parameters:
channel channel averaging; either blank or a channel value
time time averaging; either blank or a value in seconds
scan scan averaging (only valid if time averaging is on) false
field field averaging (only valid if time averaging is on) false
baseline baseline averaging, mutually exclusive with antenna false
antenna antenna averaging, mutually exclusive with baseline false
spw spw averaging false
scalar Do scalar averaging instead of vector averaging false
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------Definition at line 303 of file plotms.py.
setPlotMSAveragingRec(self, averaging, updateImmediately=True, plotIndex=0)
Summary
Sets the MS averaging parameters.
Input Parameters:
averaging MS averaging parameters, in record form
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------
Definition at line 328 of file plotms.py.
setPlotMSFilename(self, msFilename, updateImmediately=True, plotIndex=0)
Summary
Sets the MS filename to the given.
Input Parameters:
msFilename MS filename to be plotted
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------
Definition at line 211 of file plotms.py.
setPlotMSIterate(self, iteraxis=string(""), xselfscale=False, yselfscale=False, updateImmediately=True,
plotIndex=0)
Summary
Sets the iteration parameters.
Input Parameters:
iteraxis Axis over which to iterate (or none)
xselfscale Selfscale X axis false
yselfscale Selfscale Y axis false
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------Definition at line 382 of file plotms.py.
setPlotMSSelection(self, field=string(""), spw=string(""), timerange=string(""), uvrange=string(""), antenna=string(""),
scan=string(""), corr=string(""), array=string(""), observation=string(""),
msselect=string(""), updateImmediately=True, plotIndex=0)
Summary
Sets the MS selection parameters.
Input Parameters:
field MS selection parameter for field
spw MS selection parameter for spw
timerange MS selection parameter for timerange
uvrange MS selection parameter for uvrange
antenna MS selection parameter for antenna
scan MS selection parameter for scan
corr MS selection parameter for corr
array MS selection parameter for array
observation MS selection parameter for obsID
msselect MS selection parameter for msselect
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------Definition at line 243 of file plotms.py.
setPlotMSSelectionRec(self, selection, updateImmediately=True, plotIndex=0)
Summary
Sets the MS selection parameters.
Input Parameters:
selection MS selection parameters, in record form
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------
Definition at line 271 of file plotms.py.
setPlotMSTransformations(self, freqframe=string(""), veldef=string(""), restfreq=initialize_variant(""), xshift=0.0,
yshift=0.0, updateImmediately=True, plotIndex=0)
Summary
Sets the MS transformation parameters.
Input Parameters:
freqframe Frequency frame in which to render frequencies and velocities
veldef Velocity definition in which to render velocities
restfreq Rest frequency (w/ units) to use when calculating velocities
xshift Phase center shift in horizontal direction (arcsec) 0.0
yshift Phase center shift in vertical direction (arcsec) 0.0
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------Definition at line 360 of file plotms.py.
setPlotMSTransformationsRec(self, transformations, updateImmediately=True, plotIndex=0)
Summary
Sets the MS transformations parameters.
Input Parameters:
transformations MS averaging parameters, in record form
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------
Definition at line 402 of file plotms.py.
setPlotXAxis(self, xAxis, xDataColumn=string(""), updateImmediately=True, plotIndex=0)
Summary
Sets the plot x axis to the given.
Input Parameters:
xAxis name of the axis choice for x (blank to keep current)
xDataColumn name of the data column to use for the x axis, if applicable (blank to keep current)
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------Definition at line 530 of file plotms.py.
setPlotYAxis(self, yAxis, yDataColumn=string(""), updateImmediately=True, plotIndex=0)
Summary
Sets the plot y axis to the given.
Input Parameters:
yAxis name of the axis choice for y (blank to keep current)
yDataColumn name of the data column to use for the y axis, if applicable (blank to keep current)
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------Definition at line 548 of file plotms.py.
setSymbol(self, shape=string("autoscaling"), size=2, color=string("0000ff"), fill=string("fill"),
outline=False, updateImmediately=True, plotIndex=0)
Summary
Sets the unflagged plot symbol
Input Parameters:
shape symbol shape (autoscaling, circle, square, diamond, pixel, nosymbol) autoscaling
size size of the symbol in pts 2
color color of the symbol, in hex (ex. '0000ff') 0000ff
fill point fill type (fill, mesh1, mesh2, mesh3, no fill) fill
outline sets outline on plotted points False
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------Definition at line 749 of file plotms.py.
setTitle(self, text=string(""), updateImmediately=True, plotIndex=0)
Summary
Sets the title for a plot
Input Parameters:
text Title (blank for automatic, resembling [yaxis] vs. [x])
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------Definition at line 434 of file plotms.py.
setXAxisLabel(self, text=string(""), updateImmediately=True, plotIndex=0)
Summary
Sets the text to label the horizontal axis
Input Parameters:
text The title (blank for automatic)
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------Definition at line 451 of file plotms.py.
setXRange(self, xautorange=True, xmin=0, xmax=0, updateImmediately=True, plotIndex=0)
Summary
Set X axis for auto or manual, and the min/max values of x
Input Parameters:
xautorange Automatically determine X axrangeis range? true
xmin Minimum value of X 0
xmax Maximum value of X 0
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------
Definition at line 662 of file plotms.py.
setYAxisLabel(self, text=string(""), updateImmediately=True, plotIndex=0)
Summary
Sets the text to label the vertical axis
Input Parameters:
text The text (blank for automatic)
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------Definition at line 468 of file plotms.py.
setYRange(self, yautorange=True, ymin=0, ymax=0, updateImmediately=True, plotIndex=0)
Summary
Set Y axis for auto or manual, and the min/max values of y
Input Parameters:
yautorange Automatically determine X axis range? true
ymin Minimum value of Y 0
ymax Maximum value of Y 0
updateImmediately whether to apply this change immediately, IF the window is currently shown true
plotIndex the index of the plot to apply this change 0
--------------------------------------------------------------------------------
Definition at line 681 of file plotms.py.
update(self)
Summary
Updates the running plotms with any un-applied changes.
--------------------------------------------------------------------------------
Definition at line 955 of file plotms.py.
Member Data Documentation
The documentation for this class was generated from the following file:
1.8.0