Last modified: Wed August 10 13:24 2016.
PROCEDURE: py_get_data(name)
PURPOSE:
Retrieves the data and/or limit structure associated with a name handles.
This procedure is used by the "TPLOT" routines.
INPUT:
name Scalar string or index of TPLOT variable.
PROCEDURE: py_get_names()
PURPOSE:
Lists current stored data names that can be plotted with the TPLOT routines.
INPUT: None
PROCEDURE: py_get_timespan(name)
PURPOSE:
To get timespan of tplot data.
INPUT:
name Scalar string or index of TPLOT variable.
PROCEDURE: py_get_ylimits(name, trg = None)
PURPOSE:
Calculates appropriate ylimits for either one "TPLOT" variable or a list of "TPLOT" variables to be plotted in the same panel.
INPUT:
name TPLOT variable string or number or a list of TPLOT variable strings or numbers.
trg (Optional) Time range over which to calculate the limits; Double[2].
PROCEDURE: py_options(name, option, value)
PURPOSE:
Add (or change) options for individual plots.
INPUT:
name Scalar string or index of TPLOT variable.
option String with name of plot option to be changed.
value Value to be put into the option being changed.
OPTIONS:
color Color of plot lines to same value color.
value: String of color value.
line_style Changes pattern of plot lines.
value: Enum('solid_line', 'dot', 'dash', 'dash_dot', dash_dot_dot_dot', 'long_dash').
name Name of plot.
value: String.
nodata Does not show the data plotted.
value: True or False.
panel_size Size of panel compared to others.
value: Float (fraction of size of other panes).
thick Thickness of plot lines.
value: Integer.
transparency Transparency of plot lines.
value: Integer in range (0, 100).
ylog Y-axis presented as linear or log.
value: 0 or 1, 0: linear, 1: log.
yrange Range of y-axis.
value: two element list [min, max].
ytitle Title displayed on y-axis.
value: String.
zlog Z-axis presented as linear or log.
value: 0 or 1, 0: linear, 1: log.
ztitle Title displayed on z-axis.
value: String.
PROCEDURE: py_store_data(name, data=None, delete=False)
PURPOSE:
Store time series structures in static memory for later retrieval by the tplot routine.
INPUT:
name String name to be associated with the data structure passed in.
data A data structure that contains the x and y data. (Optional) Include 'v' data in order for a spectrogram to be plotted.
delete (Optional) True: deletes py_tplot variable(s) of name, no data required. In this case, name can be a single variable, or a list of variables. False: py_store_data creates tplot variable
EXAMPLE:
py_store_data('one_line', data={'x':[1,2,3,4], 'y':[1,2,3,4]})
py_store_data('three_lines', data={'x':[1,2,3,4], 'y':[[1,5,9],[2,6,10],[3,7,11],[4,8,12]})
py_store_data(['one_line', three_lines'], delete=True)
PROCEDURE: py_timebar(t, varname = None, databar = False, delete = False, color = 'black', thick = 1)
PURPOSE:
Plot vertical (or horizontal) lines on TPLOTs at specified times (or values).
INPUT:
t Time or list of times at which to draw vertical lines.
varname (Optional) Name of specific plots to apply timebar to, otherwise all plots.
databar (Optional) True: horizontal bar, False: vertical bar.
delete (Optional) True: deletes all bars matching the t, databar, and varname inputs. False: creates bars as normal.
color (Optional) Color of timebar, default black.
thick (Optional) Thickness of timebar.
PROCEDURE: py_timespan(t1, dt, keyword = None)
PURPOSE:
Define a time span for the "tplot" routine.
INPUT:
t1 Starting time (seconds since 1970).
dt Duration of time span (Days is default).
keyword (Optional) Set dt value to different time quantities.
'seconds', 'minutes', 'hours', 'days' (default)
PROCEDURE: py_timestamp(val)
PURPOSE:
Include date and time the plot was created on the plot when the "tplot" routine is called.
INPUT:
val 'on' or 'off'
PROCEDURE: py_tlimit(arg)
PURPOSE:
Defines time range for "tplot".
INPUT:
arg Two element list of minimum and maximum time of time range (seconds since 1970).
'full' Use plot's original (full) limits.
'last' Use plot's previous limits.
PROCEDURE: py_tplot(name, var_label = None)
PURPOSE:
Creates a time series plot of user defined quantities. If 'v' variable was provided when calling py_store_data, a spectrogram will be plotted.
INPUT:
name A single string or list of strings associated with TPLOT variables previously stored with the "py_store_data" routine.
Can alternatively be an integer or list of integers associated with a TPLOT variable.
var_label (Optional)String of TPLOT variable to include as label along the bottom.
PROCEDURE: py_tplot_options(option, value)
PURPOSE:
Sets global options for the "tplot" routine.
INPUT:
option Name of option to be set (string).
value Value to be given to the option.
OPTIONS:
title Title of entire plot.
value: String
title_size Size of title font.
value: Integer
wsize Size of plot window.
value: Two-element list of number of pixels for width and height of window (Integers). [width, height]
PROCEDURE: py_tplot_rename(old_name, new_name)
PURPOSE:
Renames a tplot variable without copy. Tplot number stays the same.
INPUT:
old_name Current name or index of the variable to be changed(string or integer).
new_name Name the variable will have after the procedure call(string).
PROCEDURE: py_tplot_restore(file_name)
PURPOSE:
Restores tplot data, limits, and name handles from '.pytplot' files. Restores tplot data from '.tplot' files.
INPUT:
file_name File name to restore.
PROCEDURE: py_tplot_save(name, filename=None)
PURPOSE:
Store tplot data in a file.
INPUT:
name Tplot handle to save.
filename (Optional) File name in which to save data. If none is provided, a filename will be constructed using the tplot handle.
PROCEDURE: py_xlim(min, max)
PURPOSE:
Sets x-axis limits for plotting routines.
INPUT:
min Minimum value of range.
max Maximum value of range.
PROCEDURE: py_ylim(name, min, max, log_opt = False)
PURPOSE:
Sets y-axis limits for plotting routines.
INPUT:
name Name or tplot number of TPLOT variable to be changed.
min Minimum value of yrange.
max Maximum value of yrange.
log_opt (Optional) False: linear, True: log.
PROCEDURE: py_zlim(name, min, max, log_opt = False)
PURPOSE:
Sets z-axis limits for plotting routines.
INPUT:
name Name or tplot number of TPLOT variable to be changed.
min Minimum value of zrange.
max Maximum value of zrange.
log_opt (Optional) False: linear, True: log.