Last modified: Tue Jan 23 09:35:51 2001.
NAME:
ATAXES
PURPOSE:
This procedure sets up the axes for an ATHETA geometry plot,
with no data actually plotted.
CATEGORY:
ATHETA
CALLING SEQUENCE:
ATAXES, Xr, Yr, Xlab, Ylab, Titl [, FLIP=Flip] [, CLEAN=Clean]
[, THERMOMETER=Thermometer] [, OTO=oto] [, _EXTRA=Extra]
INPUTS:
Xr: range for x axis; 2 element array
Yr: range for y axis; 2 element array
Xlab: x axis label
Ylab: y axis label
Titl: plot title
KEYWORD PARAMETERS:
FLIP: Set this keyword to flip the plot orientation to y-x,
Default is x-y.
CLEAN: Set this keyword to set up plot with no axes, labels
or tick marks. Default is draw axes, labels and ticks.
THERMOMETER:
Set this keyword to leave room for a thermometer of
contour levels on the plot. Default is no thermometer.
OTO: Set this keyword for a one-to-one aspect ratio
_EXTRA: Extra keywords to be passed to PLOT procedure
RESTRICTIONS:
"Extra" keywords must be valid keywords for PLOT procedure.
EXAMPLE:
Set up axes for ATHETA geometry plot with specified ranges
and titles.
ataxes, [0,.2], [0,.2], 'z (cm)', 'r (cm)', 'My plot'
Set up axes for geometry plot. Omit axes and labels and leave
room for thermometer
ataxes, [0,.2], [0,.2], 'z (cm)', 'r (cm)', 'Clean plot' $
/clean, /thermometer
MODIFICATION HISTORY:
Written by: Rebecca Coats, 9/96.
(See ../pfidl/atheta/./ataxes.pro)
NAME:
ATBACKGROUND
PURPOSE:
This procedure sets the background for ATHETA plots to black
(the default) or white. The default drawing color switches
to the opposite color.
CATEGORY:
ATHETA
CALLING SEQUENCE:
ATBACKGROUND [, /BLACK] [, /WHITE]
KEYWORD PARAMETERS:
BLACK: Set background color to black and default drawing
color to white (Default).
WHITE: Set background color to white and default drawing
color to black.
MODIFICATION HISTORY:
Written by: Rebecca Coats, 5/97.
(See ../pfidl/atheta/./atbackground.pro)
NAME:
ATCURV
PURPOSE:
This procedure overplots curves as lines or filled polygons
on existing axes.
CATEGORY:
ATHETA
CALLING SEQUENCE:
ATCURV Ncurvs, X, Y, Locs, Npnts [, CL=cl] [, LS=ls] [, TK=tk] $
[, MK=mk] [, FLIP=Flip] [, FILL=Fill] [, _EXTRA=Extra]
INPUTS:
Ncurvs: Number of curves to be plotted.
X: Array of x values for all curves.
Y: Array of y values for all curves.
Locs: Array of beginning locations for curves in X, Y arrays.
Npnts: Array of number of points for each curve.
KEYWORD PARAMETERS:
CL: Single value or array of color indicies for curves.
Default is default plot color.
LS: Single value or array of linestyles for curves.
Default is solid.
TK: Single value or array of line thickness for curves.
Default is 1.0.
MK: Single value or array of marker styles for curves.
Default is no markers.
FLIP: Set this keyword to flip the plot orientation to y-x,
Default is x-y.
FILL: Set this keyword to draw curves as filled polygons.
Default is curves drawn as outlines.
_EXTRA: Extra keywords to be passed to OPLOT procedure
RESTRICTIONS:
"Extra" keywords must be valid keywords for OPLOT procedure.
EXAMPLE:
Plot one curve with 25 points on an existing axis; use defaults:
atcurv, 1, x, y, 0, 25
Plot two curves as filled polygons with color indicies specified:
atcurv, 2, x, y, [0,24], [25,25], cl=[1,3], /fill
MODIFICATION HISTORY:
Written by: Rebecca Coats, 9/96.
(See ../pfidl/atheta/./atcurv.pro)
NAME:
ATDRAW
PURPOSE:
This procedure sets up the axes and draws the ATHETA geometry
including parts, coilsets and curves.
CATEGORY:
ATHETA
CALLING SEQUENCE:
ATDRAW [, FLIP=Flip] [, FILL=Fill] [, GRID=Grid] [, CLEAN=Clean] $
[, THERMOMETER=Thermometer] [, OTO=oto] [, RADIUS=radius] $
[, OVERPLOT=overplot] [, _EXTRA=Extra]
KEYWORD PARAMETERS:
FLIP: Set this keyword to flip the plot orientation to r: x-axis,
z: y-axis. Default is z: x-axis, r: y-axis.
FILL: Set this keyword to draw parts as filled polygons.
Default is parts drawn as outlines.
GRID: Set this keyword to draw ATHETA grid on plot.
Default is no grid drawn.
CLEAN: Set this keyword to draw geometry with no axes, labels
or tick marks. Default is draw axes, labels and ticks.
THERMOMETER:
Set this keyword to leave space for a thermometer of
contour levels on the plot. Default is no thermometer.
OTO: Set this keyword for a one-to-one aspect ratio
RADIUS: Draw coils as wires with radius "radius"
OVERPLOT:
Set this keyword to overplot geometry on current plot
_EXTRA: Extra keywords to be passed to PLOT procedure
RESTRICTIONS:
ATHETA geometry data must already be loaded in IDL arrays by
previous ATHETA DRAW command.
"Extra" keywords must be valid keywords for PLOT procedure.
EXAMPLE:
Draw ATHETA geometry with parts as filled polygons:
atdraw, /fill
Draw ATHETA geometry with the title specified:
atdraw, title='This is my title'
MODIFICATION HISTORY:
Written by: Rebecca Coats, 9/96.
(See ../pfidl/atheta/./atdraw.pro)
NAME:
ATFLD
PURPOSE:
This procedure overplots contours of a field structure.
CATEGORY:
ATHETA
CALLING SEQUENCE:
ATFLD [, Struct] [, NLEVEL=Nlevel] [, LRANGE=Lrange] $
[, LEVELS=level] [, FLIP=Flip] [, CLEAN=Clean] $
[, THERMOMETER=Thermometer] [, _EXTRA=Extra]
OPTIONAL INPUTS:
Struct: Structure number of field to be plotted. Default is
structure 1.
KEYWORD PARAMETERS:
NLEVEL: Number of contour levels to draw. Default number of
levels is 10.
LRANGE: Two element array giving contour range, [lowest, highest],
for the plot. Defaults are field minimum and maximum.
LEVELS: Specific contour levels to draw. If specified, NLEVEL
and LRANGE keywords are ignored.
FLIP: Set this keyword to flip the plot orientation to r: x-axis,
z: y-axis. Default is z: x-axis, r: y-axis.
CLEAN: Set this keyword to plot with no annotation for number
of contours, field minimum and maximum. Default is
include annotation.
THERMOMETER:
Set this keyword to draw a thermometer of contour levels
on the plot. Default is no thermometer.
_EXTRA: Extra keywords to be passed to PLOTFLD procedure.
RESTRICTIONS:
ATHETA geometry and field data must be already be loaded in
IDL arrays by previous ATHETA PLOT command. This procedure
overplots contours on an existing plot axis.
"Extra" keywords must be valid keywords for PLOTFLD procedure.
EXAMPLE:
Draw ATHETA contour plot on an existing axis. Field is in
structure 2:
atfld, 2
Overplot ATHETA contour plot with 20 contour levels:
atfld, nlevel=20
MODIFICATION HISTORY:
Written by: Rebecca Coats, 9/96.
(See ../pfidl/atheta/./atfld.pro)
NAME: ATGEOM PURPOSE: This procedure plots different parts of the ATHETA geometry individually. These parts are the axes; ATHETA parts, coilsets and curves; and curves stored as "temporary". CATEGORY: ATHETA CALLING SEQUENCE: ATGEOM, Label [, FLIP=Flip] [, FILL=Fill] [, CLEAN=Clean] $ [, THERMOMETER=Thermometer] [, OTO=oto] [, RADIUS=Radius] $ [, _EXTRA=Extra] INPUTS: Label: Label of entity to draw: axes: set up and draw axes part: draw ATHETA parts coil: draw ATHETA coilsets curv: draw ATHETA curves temp: draw curves stored as "temporary" KEYWORD PARAMETERS: FLIP: Set this keyword to flip the plot orientation to r: x-axis, z: y-axis. Default is z: x-axis, r: y-axis. FILL: Set this keyword to draw parts as filled polygons. Default is parts drawn as outlines. CLEAN: Set this keyword to draw axes with no axes, labels or tick marks. Default is draw axes, labels and ticks. THERMOMETER: Set this keyword to leave room for a thermometer of contour levels on the plot. Default is no thermometer. OTO: Set this keyword for a one-to-one aspect ratio RADIUS: Draw coils as wires with radius "radius" _EXTRA: Extra keywords to be passed to PLOT procedure RESTRICTIONS: ATHETA geometry data must already be loaded in IDL arrays by previous ATHETA DRAW command. "Extra" keywords must be valid keywords for PLOT procedure. EXAMPLE: Draw ATHETA axes and parts only: atgeom, 'axes' atgeom, 'part' Draw the curve stored as "temp" on an existing plot: atgeom, 'temp' MODIFICATION HISTORY: Written by: Rebecca Coats, 9/96.
(See ../pfidl/atheta/./atgeom.pro)
NAME:
ATPLOT
PURPOSE:
This procedure draws the ATHETA geometry and plots contours
of the stream function field.
CATEGORY:
ATHETA
CALLING SEQUENCE:
ATPLOT [, Struct] [, FLIP=Flip] [, FILL=Fill] [, GRID=Grid] $
[, CLEAN=Clean] [, NLEVEL=Nlevel] [, LRANGE=Lrange] $
[, THERMOMETER=Thermometer] [, OTO=oto] [, _EXTRA=Extra]
OPTIONAL INPUTS:
Struct: Structure number of field to be plotted. Default is
structure 1.
KEYWORD PARAMETERS:
FLIP: Set this keyword to flip the plot orientation to r: x-axis,
z: y-axis. Default is z: x-axis, r: y-axis.
FILL: Set this keyword to draw parts as filled polygons.
Default is parts drawn as outlines.
GRID: Set this keyword to draw ATHETA grid on plot.
Default is no grid drawn.
CLEAN: Set this keyword to draw geometry with no axes, labels
or tick marks. Default is draw axes, labels and ticks.
NLEVEL: Number of contour levels to draw. Default number of
levels is 10.
LRANGE: Two element array giving contour range, [lowest, highest],
for the plot. Defaults are field minimum and maximum.
THERMOMETER:
Set this keyword to draw a thermometer of contour levels
on the plot. Default is no thermometer.
OTO: Set this keyword for a one-to-one aspect ratio
_EXTRA: Extra keywords to be passed to PLOT procedure.
RESTRICTIONS:
ATHETA geometry and field data must be already be loaded in
IDL arrays by previous ATHETA PLOT command.
"Extra" keywords must be valid keywords for PLOT procedure.
EXAMPLE:
Draw ATHETA contour plot. Field is in structure 2:
atplot, 2
Draw ATHETA contour plot with the title specified; include
a thermometer:
atplot, title='My ATHETA field', /thermometer
MODIFICATION HISTORY:
Written by: Rebecca Coats, 9/96.
(See ../pfidl/atheta/./atplot.pro)