home *** CD-ROM | disk | FTP | other *** search
/ The Fred Fish Collection 1.5 / ffcollection-1-5-1992-11.iso / ff_progs / educ / listplot.lzh / LISTPLOT / LISTPLOT.1 < prev    next >
Text File  |  1991-08-15  |  9KB  |  502 lines
  1. .de PP
  2. .sp 1;.ne 2
  3. .en
  4. .TH ListPlot 1 "AMIGA Manual" 5/15/90 "Duke University"
  5. .SH NAME
  6. ListPlot - a vanilla plotting filter
  7. .SH SYNOPSIS
  8. .B ListPlot
  9. [ options ]
  10. .SH DESCRIPTION
  11. .I ListPlot
  12. a simple 2D plotting filter based on the
  13. .I PLPLOT
  14. plotting library.
  15. .PP
  16. Its principle advantage is that it supports a variety of graphics
  17. devices.  
  18. .PP
  19. .IR ListPlot
  20. reads from stdin and writes to stdout unless input and/or
  21. output files are specified on the command line.
  22. The program accepts a file of n-tuples.  Each tuple consists of
  23. a sequence of space-separated numbers terminated with a newline.
  24. The first element of each tuple is assumed to be the independent
  25. variable.  Each remaining element is plotted against the first to
  26. produce n-1 curves.
  27. .PP
  28. .IR ListPlot
  29. takes a number of command line arguments that may be
  30. used to control the appearance of the plots.
  31. Command line arguments are specified in the form
  32. .ti +10
  33. .IR variable=value
  34. .PP
  35. For a list of the arguments enter:
  36. .sp
  37. .ti +10
  38. ListPlot Help=All.
  39. .SH VARIABLES TYPES
  40. .ta
  41. .in 20
  42. .ta 20
  43. .ti -10
  44. .B Boolean
  45. @tvalues accept values such as 
  46. .B true, false, yes, no, on, off, 0, 
  47. and 
  48. .B 1
  49. (ex. PlotColor=yes).
  50. .sp
  51. .ti -10
  52. .B String
  53. @tvalues expect the strings to entered as
  54. indicated and is case sensitive (ex. Domain=All).
  55. .sp
  56. .ti -10
  57. .B Dbl
  58. @tvalues expect real numbers (ex. AspectRatio=1.0).
  59. .sp
  60. .ti -10
  61. .B Interval
  62. @tvalues expect a pair of comma separated reals
  63. (ex. Range=-1.0,3.0).
  64. .sp
  65. .ti -10
  66. .B Set
  67. @tvalues expect a list of comma separated elements enclosed in
  68. curly braces ({}). (ex. LineStyle={MS,MMS,MSmmS})
  69. .sp
  70. .ti -10
  71. .B Rect
  72. @tvalues expect a list of comma separated numbers representing
  73. a diagonal from the lower-left corner to the upper-right corner
  74. (ex. ViewPort={0.1,0.3, 0.9,0.6}).
  75. .in 10
  76.  
  77. .PP
  78. The title and label variables accept strings that include
  79. the following control sequences:
  80. .sp
  81. .in +10
  82. .B #u: 
  83. move up to superscript (ended with 
  84. .B #d
  85. )
  86. .br
  87. .B #d: 
  88. move down to subscript (ended with
  89. .B #u
  90. )
  91. .br
  92. .B #b: 
  93. backspace to allow overprinting
  94. .br
  95. .B ##: 
  96. the number symbol
  97. .br
  98. .B #+: 
  99. toggle overline mode
  100. .br
  101. .B #-: 
  102. toggle underline mode
  103. .br
  104. .B #gx: 
  105. Greek letter corresponding to Roman letter x
  106. .br
  107. .in -10
  108. .SH OPTIONS
  109. The currently available arguments are indicated below.
  110. .B Bold
  111. face arguments indicate that they should be entered
  112. exactly as shown.
  113. An '*' indicates that an arbitrary string may be given.
  114. A string with embedded spaces must be quoted.
  115.  
  116. .in +10
  117. .ti -10
  118. .B AngularUnit=[ degrees | radians ]
  119. .br
  120. .I AngularUnit
  121. specifies the angular unit of measure
  122. used for polar plots.  For angles in radians use 
  123. .B AngularUnit=radians.
  124. .sp 1
  125. .ti -10
  126. .B AnnotationScale=[ 
  127. .I dbl 
  128. .B ]
  129. .br
  130. .I AnnotationScale
  131. controls the size of the characters
  132. used to annotate the axes.
  133. .sp 1
  134. .ti -10
  135. .B AspectRatio=[ 
  136. .I dbl
  137. .B | Automatic ]
  138. .br
  139. .I AspectRatio
  140. controls the relative lengths of the vertical to horizontal axes.
  141. If set this value overrides the value of 
  142. .I ViewPort.
  143. .sp 1
  144. .ti -10
  145. .B Boxed=[
  146. .I boolean
  147. .B | * ]
  148. .br
  149. .I Boxed
  150. adds axes to the edges of the plot.
  151. If 
  152. .I Boxed
  153. is given a boolean value then axes are placed on
  154. all of the edges.  If 
  155. .I Boxed
  156. is given a string consisting
  157. of one or more of 
  158. .I t, b, r, l
  159. then axes are added to
  160. top, bottom, right and left edges respectively.
  161. .sp 1
  162. .ti -10
  163. .B Domain=[
  164. .I interval
  165. .B | All | Automatic ]
  166. .br
  167. .I Domain
  168. may be used to specify the bounds on the X axis.
  169. When set to 
  170. .B All, 
  171. all points are plotted.  When set to
  172. .B Automatic, 
  173. outlying points may not be plotted.
  174. .sp 1
  175. .ti -10
  176. .B Gridding=[
  177. .I boolean
  178. .B ]
  179. .br
  180. .I Gridding
  181. puts a grid on the plot.
  182. .sp 1
  183. .ti -10
  184. .B Help=[ All | all | * ]
  185. .br
  186. .I Help
  187. provides some descriptive text for the user-settable
  188. plotting variables.  If the variable 
  189. .I Verbose
  190. is set then an extended description is provided. To set verbose enter
  191. .br
  192. .sp
  193. ListPlot Verbose=yes Help=[
  194. .I variable
  195. |
  196. .B All
  197. ].
  198. .sp 1
  199. .ti -10
  200. .B LabelScale=[
  201. .I dbl
  202. .B ]
  203. .br
  204. .I LabelScale
  205. specifies the relative size of the vertical and
  206. horizontal axis labels.  The typical range is [0.5 - 2.0].
  207. .sp 1
  208. .ti -10
  209. .B LineColor=[
  210. .I set
  211. .B ]
  212. .br
  213. .I LineColor
  214. may be used to specify a list of line colors for
  215. plots with multiple curves if this feature is supported for
  216. a particular output device.
  217. .sp 1
  218. .ti -10
  219. .B LineStyle=[
  220. .I set
  221. .B ]
  222. .br
  223. .I LineStyle
  224. may be used to specify a list of line styles for
  225. plots with multiple curves.  Each linestyle is specified as
  226. a sequence of pen down... pen up elements. The elements are encoded
  227. using the following characters to indicate element lengths:
  228. .in +10
  229. .br
  230. .B m: 
  231. 250 micron mark
  232. .br
  233. .B M: 
  234. 1mm mark
  235. .B (mmmm)
  236. .br
  237. .B s: 
  238. 250 micron space
  239. .br
  240. .B S: 
  241. 1mm space
  242. .B (ssss)
  243. .br
  244. .in -10
  245. For example, a set of line styles might be indicated
  246. .ti +10
  247. LineStyle={MS,MMSS,MMSmmS,mmS,mmSmmSMMS}
  248. .sp 1
  249. .ti -10
  250. .B Orientation=[ portrait | landscape ]
  251. .br
  252. .I Orientation
  253. controls whether the plot is displayed in
  254. landscape or portrait orientation.
  255. .sp 1
  256. .ti -10
  257. .B Origin=[
  258. .I interval
  259. .B | Automatic | Median ]
  260. .br
  261. .I Origin
  262. allows the placement of a set of axes at an 
  263. arbitrary point.
  264. The 
  265. .I Median 
  266. value places the axes at the median 
  267. .I X 
  268. and the median
  269. .I Y 
  270. of the data values.
  271. .sp 1
  272. .ti -10
  273. .B PlotColor=[
  274. .I boolean
  275. .B ]
  276. .br
  277. .I PlotColor
  278. if 
  279. .B true
  280. causes the plot to generated in color if this
  281. feature is supported on a particular output device.
  282. .sp 1
  283. .ti -10
  284. .B PlotJoined=[
  285. .I boolean
  286. .B ]
  287. .br
  288. .I PlotJoined,
  289. if set, connects each data point with a line in the
  290. current line style.
  291. .sp 1
  292. .ti -10
  293. .B PlotPoints=[
  294. .I boolean
  295. .B ]
  296. .br
  297. .I PlotPoints
  298. if 
  299. .B true
  300. causes symbols to be plotted in the current
  301. symbol style at each data point.
  302. .sp 1
  303. .ti -10
  304. .B PointScale=[
  305. .I dbl
  306. .B ]
  307. .br
  308. .I PointScale
  309. controls the relative size of the data point symbols
  310. when data point symbols are being plotted.
  311. .sp 1
  312. .ti -10
  313. .B PointSymbol=[ Automatic | 
  314. .I set
  315. .B ]
  316. .br
  317. .I PointSymbol
  318. specifies a list of symbols to be used when plotting
  319. data points. The symbols types are encoded as integers.
  320. (See the 
  321. .B PLPLOT
  322. library documentation to find the symbols available.)
  323. .sp 1
  324. .ti -10
  325. .B PlotTitle=[ * ]
  326. .br
  327. .I PlotTitle
  328. takes the plot title as an argument.
  329. Text control sequences described above may be included.
  330. .sp 1
  331. .ti -10
  332. .B PlotDevice=[amiga| printer | iff | 
  333. .B hp | aegis | postscript]
  334. .br
  335. .I PlotDevice
  336. specifies output device type.
  337. .sp 1
  338. .ti -10
  339. .B PlotType=[ linlin | loglin | 
  340. .B linlog | loglog | polar ]
  341. .br
  342. .I PlotType
  343. specifies the 
  344. .I graph paper
  345. upon which the plot is drawn.
  346. The current implementation plots in
  347. .in +10
  348. .br
  349. linear-linear,
  350. .br
  351. log-linear,
  352. .br
  353. linear-log,
  354. .br
  355. log-log, and
  356. .br
  357. polar
  358. .br
  359. .in -10
  360. .sp
  361. formats.
  362. For the log type plots, the log of the data is computed.
  363. For polar plots, see also 
  364. .I AngularUnit
  365. and 
  366. .I PolarVariable.
  367. .sp 1
  368. .ti -10
  369. .B PolarVariable=[ angle | radius ]
  370. .br
  371. .I PolarVariable
  372. for polar plots is used to specify
  373. whether the independent variable is angular or radial.
  374. .sp 1
  375. .ti -10
  376. .B Range=[
  377. .I interval
  378. .B | All | Automatic ]
  379. .br
  380. .I Range
  381. specifies the y axis bounds. (ex. Range=-1,1 )
  382. When set to 
  383. .B All, 
  384. all points are plotted.  When set to
  385. .B Automatic, 
  386. outlying points may not be plotted.
  387. .sp 1
  388. .ti -10
  389. .B SubPages=[
  390. .I interval
  391. .B ]
  392. .br
  393. .I SubPages
  394. specifies the number of plots on a pages.
  395. This is a vestige of PLPLOT and I am not sure this has any use
  396. within the context of 
  397. .I ListPlot.  
  398. It might be useful for
  399. controlling the size of the plots but the 
  400. .I ViewPort
  401. might be a more direct solution.
  402. .sp 1
  403. .ti -10
  404. .B SupplyAbscissa=[
  405. .I boolean
  406. .B ]
  407. .br
  408. .I SupplyAbscissa
  409. if set causes 
  410. .I ListPlot
  411. to supply a value for the independent variable.
  412. .sp 1
  413. .ti -10
  414. .B TitleScale=[
  415. .I dbl
  416. .B ]
  417. .br
  418. .I TitleScale
  419. controls the relative size of the title text.
  420. .sp 1
  421. .ti -10
  422. .B UseInputFile=[ * ]
  423. .br
  424. .I UseInputFile
  425. permits the specification of an input file if you would rather not use stdin.
  426. .sp 1
  427. .ti -10
  428. .B UseOutputFile=[ * ]
  429. .br
  430. .I UseOutputFile
  431. permits the specification of an output file if
  432. you would rather not use stdout.
  433. .sp 1
  434. .ti -10
  435. .B Verbose=[
  436. .I boolean
  437. .B ]
  438. .br
  439. .I Verbose
  440. if set causes extended messaging.
  441. .sp 1
  442. .ti -10
  443. .B ViewPort=[
  444. .I rect
  445. .B ]
  446. .br
  447. .I ViewPort
  448. allows control over the size of a plot. Takes
  449. a viewing rectangle diagonal as an argument.
  450. .ti +10
  451. ex. ViewPort={0.1,0.3, 0.9,0.6}
  452. .sp 1
  453. .ti -10
  454. .B XLabel=[ * ]
  455. .br
  456. .I XLabel
  457. specifies X axis label.  Text control sequences described
  458. above may be included.
  459. .sp 1
  460. .ti -10
  461. .B YLabel=[ * ]
  462. .br
  463. .I YLabel
  464. specifies Y axis label.  Text control sequences described
  465. above may be included.
  466. .sp 1
  467. .ti -10
  468. .B XTick=[ Automatic |
  469. .I interval
  470. .B ]
  471. .br
  472. .I XTick
  473. controls the spacing of major axis ticks and the number
  474. of minor subdivisions. (ex. 
  475. .I XTick=0.1,10
  476. indicates major ticks at units of 0.1 with 10 minor subdivisions.)
  477. .sp 1
  478. .ti -10
  479. .B YTick=[ Automatic |
  480. .I Interval
  481. .B ]
  482. .br
  483. .I YTick
  484. controls the spacing of major axis ticks and the number
  485. of minor subdivisions.
  486. .in -10
  487. .SH FILES
  488. .SH IDENTIFICATION
  489. Authors: Frederick R. Bartram and Anthony M. Richardson,
  490. Dept. of Electrical Engineering, Duke University, Durham, N.C. 27706.
  491. .sp 0
  492. InterNet: frb@@dukee.egr.duke.edu,amr@@dukee.egr.duke.edu
  493. .sp 0
  494. Copyright 1990 by Frederick R. Bartram and Anthony M. Richardson.
  495. .sp 0
  496. Amiga port by Anthony M. Richardson
  497. .SH BUGS
  498. Please report any bugs or unusual 
  499. .I features
  500. to the authors.
  501.  
  502.