home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 June / SIMTEL_0692.cdr / msdos / spredsht / prof2d.arc / TUTORIAL.PR2 < prev   
Encoding:
Text File  |  1990-01-03  |  11.6 KB  |  377 lines
  1. : Prof2d, The 2D Scientific Spreadsheet                IBM-PC Version
  2. : by Gertjan L. Ouwerling, Electrical Materials Lab, Delft University
  3. : -------------------------------------------------------------------
  4. : Execute this tutorial by typing:  prof2d tutorial.pr2 <enter>
  5. :
  6. : NOTE: some steps may be slow without a co-processor!
  7. :       Graphical pictures are terminated by giving <enter>
  8. : -------------------------------------------------------------------
  9. :
  10. : In this tutorial the following subjects are treated:
  11. :
  12. : 1. Prof2d on the IBM-PC (and its video adaptor card)
  13. : 2. Prof2d data structures (variables and data types)
  14. : 3. Internal generation of data and making graphs
  15. : 4. Reading and writing data from and to file
  16. : 5. Escaping to the operating system (on the PC MS-DOS)
  17. : 6. Integration of 2D data to find a volume
  18. : 7. Data manipulation (reduction, partial removal, transformations)
  19. : 8. List of interesting but not demonstrated commands
  20. :
  21. :
  22. :
  23. pause
  24. : -------------------------------------------------------------------
  25. :
  26. : 1. Prof2d on the IBM-PC (and its video adaptor card)
  27. :
  28. : Prof2d runs on (among many computers) IBM-PCs or true compatibles with 
  29. : Hercules, CGA, EGA, VGA or AT&T 6300 (Olivetti) graphics adaptors. It 
  30. : automatically senses which adaptor is present, but sometimes makes a mistake.
  31. :
  32. : The command  adapt  is used to ask which card is sensed and to set another
  33. : one if this is wrong. If the wrong card is sensed, edit tutorial.pr2 and 
  34. : remove one of the five comment colons (: means comment in Prof2d) below:
  35.  
  36. : adapt Hercules
  37. : adapt Olivetti/AT&T
  38. : adapt CGA
  39. : adapt EGA
  40. : adapt VGA
  41.  
  42. : we will now ask Prof2d what adaptor card it is currently sensing:
  43.  
  44. adapt ?
  45. pause
  46. : 
  47. : 2. Prof2d data structures (variables and data types)
  48. :
  49. : Basic data structures of Prof2d are:
  50. :
  51. : - integer and real variables (scalar)
  52. : - horizontal 1D arrays of data (rows)
  53. : - vertical   1D arrays of data (columns)
  54. : -            2D arrays of data (fields)
  55. :
  56. : Most data structures must be declared before using with the commands
  57. : var, row, column and field.
  58. :
  59. : However, some variables and rows and columns are present by 
  60. : default and need not be declared. Most notable examples are:
  61. :
  62. : -> integer variable nx, active number of elements in rows 
  63. : -> integer variable ny, active number of elements in columns 
  64. : -> row    xcount, counts from 0 to nx-1 
  65. : -> column ycount, counts from 0 to ny-1 
  66. :
  67. :
  68. pause
  69. :
  70. : We will now declare some data structures to be used further. Later
  71. : on we will declare some more (this is always possible).
  72.  
  73.  
  74. var int nx1 ny1 $
  75. row x1 $
  76. column y1 $
  77. field gauss $
  78.  
  79. : Declarations end in $ to indicate the end of the argument list.
  80. : Currently, the maximum field dimension is 64x64 elements (IBM-PC).
  81.  
  82. pause
  83. :
  84. : 3. Internal generation of data and making graphs
  85. :
  86. : Prof2d accepts either commands (such as adapt or field) or 
  87. : mathematical expressions containing variables, data types and constants.
  88. : If an = sign is present, assignment is made. Otherwise the result is
  89. : printed. Some much used constants are present by default, for example
  90.  
  91. pi
  92.  
  93. : The default row and column xcount and ycount may be used for 
  94. : data generation. A 2D gaussian (normal distribution) is synthesized
  95. : by using the default row xcount and column ycount:
  96.  
  97. nx = 21
  98. x1 = -2.0 + 4.0*xcount/(nx-1)
  99. ny = 21
  100. y1 = -2.5 + 5.0*ycount/(ny-1)
  101. : This may take a while!
  102. gauss = exp(-(x1*x1+y1*y1))
  103.  
  104. pause
  105.  
  106. : The  cview  command may be used to make a contour plot on the screen
  107. : of the data. The default number of contours is 10, and they run between
  108. : 10% and 90% of the interval that the viewed field spans.
  109. :
  110. : The number of contours can be specified by the (default) integer variable
  111. : ncont. We will do only 5 contours (to save computation time on PCs without
  112. : a mathematical coprocessor).
  113. :
  114. : After completion, give <enter> to leave the picture.
  115.  
  116. ncont = 5
  117.  
  118. pause
  119. cview x1 y1 gauss 
  120.  
  121. : Some Prof2d variables choose the region of the contour plot:
  122. :
  123. : nxs (starting x mesh line)   if nxs >= nxe, the whole row is used
  124. : nxe (ending   x mesh line)
  125. : nys (starting y mesh line)   if nys >= nye, the whole column is used
  126. : nye (ending   y mesh line)
  127. : 
  128. : Naturally, the contour plot also depends on the row and column used!
  129. : A small demonstration is given by perturbing x1 and y1 and 
  130. : selecting part of the field region to be plotted.
  131.  
  132.  
  133. row x2 $ column y2 $
  134. x2 = sqrt(x1+2.0)
  135. y2 = 0.05*sgn(y1)*(y1*y1)
  136.  
  137. nxs=8
  138. nxe=16
  139.  
  140. : remember to finish the cview with <enter>
  141.  
  142. pause
  143. cview x2 y2 gauss
  144.  
  145. : the default full region contour plotting is restored:
  146.  
  147. nxs=nxe
  148.  
  149. : other possibilities of cview are:
  150. :
  151. : - use default row xmesh and default column ymesh to select mesh lines
  152. :   to be shown in the picture (with the assign command)
  153. :
  154. : - use command  setcont  to select contour values to be used by hand
  155. :
  156. : Please read the cview, assign and setcont manual pages to find out
  157. : more about this (with the help command).
  158. :
  159.  
  160. pause
  161.  
  162. : 1D Cross Sections through a field with view.
  163. : -------------------------------------------
  164. :
  165. : The  view  command makes 1D cross-sections through a 2D data field
  166. : along either a selected row or a selected column. By default, up to 
  167. : 10 lines are selected for cross-sectioning in one graph.
  168. :
  169. : The default row xplot and column yplot can be used to assign cross-
  170. : section lines to be used. Here we use assign to view the first 8
  171. : horizontal cross sections.
  172. :
  173. : View commands are also ended by <enter>.
  174.  
  175. assign yplot 1 1 2 1 3 1 4 1 5 1 6 1 7 1 8 1 $
  176. pause
  177. view x1 gauss
  178.  
  179. : In fact, the Prof2d view command was directly derived from the Profile 
  180. : view command (Profile is the 1D scientific spreadsheet and optimizer,
  181. : also available in the Public Domain). The use of the (again present by
  182. : default) scaling variables xls, xrs, yus and yls is explained in the
  183. : view manual page and in the Profile tutorial.
  184.  
  185. pause
  186. :
  187. : Now, using the expression evaluation capabilities of Prof2d, we will
  188. : produce a so called 'Schmoo' plot of our Gaussian field.
  189. : The built-in function pos(x) returns 1 if x > 0, otherwise it returns 0.
  190. : A formula is defined and remembered with the  define  command.
  191.  
  192. field s t $
  193. var real c1 c2 c3 c4 c5 $
  194.  
  195. define schmoo=pos(t-c1)+pos(t-c2)+pos(t-c3)+pos(t-c4)+pos(t-c5)
  196.  
  197. c1=0.1
  198. c2=0.3
  199. c3=0.5
  200. c4=0.7
  201. c5=0.9
  202.  
  203. t=gauss
  204. s=schmoo
  205.  
  206. : the plot is produced by evaluating the very simple expression 's'
  207.  
  208. pause
  209. s
  210. pause
  211.  
  212. :
  213. : 4. Reading and writing data from and to file
  214. :
  215. : Of course, often you will use Prof2d to view or transform externally
  216. : generated or measured data.
  217. :
  218. : Prof2d has two formats in which it can read and write data:
  219. :
  220. : 1. The list   format (commands get  & put)   
  221. : 2. The matrix format (commands mget & mput)
  222. :
  223. : In the list format, you can read or write more than 1 field at the time:
  224. :
  225. :   x(i) y(j) z1(i,j) z2(i,j) z3(i,j) ..... (one line from a file)
  226. :    
  227. : In the matrix format, only one field can be filed, optionally together
  228. : with a row and column. Give <help formats> for more detailed information.
  229. :
  230. : We will now put a file in list format and then read back its contents 
  231. : into different rows, columns and fields.
  232.  
  233. pause
  234.  
  235. : reduce number of lines a little ...
  236. nx=5
  237. ny=4
  238.  
  239. put tutor.dat x1 y1 gauss s $
  240.  
  241. get tutor.dat x2 y2 s t $
  242.  
  243. pause
  244.  
  245. : 5. Escaping to the operating system (on the PC MS-DOS)
  246. :
  247. : Many operating system commands (such as dir and del, etc) can be typed
  248. : to the Prof2d prompt ("pr2d> ", only shown interactively). They are
  249. : executed if a command.com file can be loaded by the system.
  250. :
  251. : If Prof2d doesn't recognize a command (e.g. because it is not a standard
  252. : MS-DOS command or one of the DOS commands that is also a Prof2d command),
  253. : you can use the 'shell escape' sign %
  254. :
  255. : An example (typing the data file tutor.dat):
  256. :
  257. pause
  258. % type tutor.dat
  259. pause
  260.  
  261. : Now look at the directory and delete our data file tutor.dat:
  262.  
  263. dir
  264. del tutor.dat
  265.  
  266. pause
  267.  
  268. : Run your application program (e.g. in development) from Prof2d 
  269. : and use the Prof2d history mechanism to rapidly see your results:
  270. :
  271. : % myprog mydata.in           : execute the external program MYPROG
  272. : get myprog.out x y z $       : read output from MYPROG
  273. : cview x y z                  : look at output
  274. : % edit mydata.in             : change input for myprog with your editor
  275. : % myprog mydata.in           : re-run the external program MYPROG
  276. : !get                         : repeat the last line starting with 'get'
  277. : !cvi                         : repeat the last line starting with 'cvi'
  278. : .... etc
  279.  
  280. pause
  281.  
  282. : 6. Integration of a field to find the volume below a surface.
  283. :
  284. : Prof2d offers a facility for numerical integration. This command uses
  285. : a 2D trapezium derived by integration of the bilinear approximation
  286. : of the 2D function on each mesh rectangle.
  287. :
  288. : The gaussian is integrated over the entire region. This should yield
  289. : a volume of Pi (apart from discretisation error and error due to the
  290. : finite integration area).
  291.  
  292. : Reset number of lines from get/put demonstration
  293. nx=21
  294. ny=21
  295.  
  296. : Real variable to contain the volume and integration by command inte2d
  297. var real volume $
  298. inte volume x1 y1 gauss
  299.  
  300. : Print result and compare with Pi
  301. volume
  302. volume/pi
  303.  
  304. pause
  305.  
  306. : 7. Data manipulation (reduction, partial removal, transformations)
  307. :
  308. : One of the applications of the Prof2d (and also the Profile) package
  309. : is the manipulation of data to bring it in another form, e.g. conversion
  310. : of the output from one program to the input of the next program.
  311. :
  312. : Prof2d offers several possibilities for data manipulation:
  313. :
  314. : - expression evaluation to compute and create new data; use of the pos(),
  315. :   neg() and pls() functions to select only part of a data field to be used;
  316. : - getting data in list format and putting it in matrix format, or vice versa;
  317. : - reduction of the number of data elements in the x- and/or the y-direction
  318. :   with the commands redx and redy;
  319. : - partial removal of data with the commands remx and remy;
  320. : - mirroring a data field (with a row or column) in the x- or y-axis 
  321. :   with the command mirror;
  322. : - transposing a data field (and optionally interchanging a row with a 
  323. :   column) with the command transpose.
  324. :
  325. :
  326. : Not everything can be demonstrated here. One small example:
  327. :
  328. pause
  329. :
  330. : The middle horizontal section of the gaussian is removed and
  331. : the result is looked at:
  332.  
  333. var int nstart nend $
  334. nstart = ny/2 -1
  335. nend   = ny/2 +2
  336. remy nstart nend
  337.  
  338. pause
  339. cview x1 y1 gauss
  340.  
  341. : Gauss is transposed together with x1 and y1  and re-cviewed
  342. : Note that x1 and y1 are interchanged (x1 has become a column, y1 a row)
  343.  
  344. show rows
  345.  
  346. transpose x1 y1 gauss
  347.  
  348. show columns
  349.  
  350. pause
  351. cview y1 x1 gauss
  352.  
  353. : 
  354. : ------------------------------------------------------------------
  355. :
  356. : This completes the Prof2d tutorial introduction.
  357. :
  358. : Many things were not treated. Some omissions are the cplot and plot
  359. : commands to create contour and cross section plots with an HP7550A or
  360. : HP7475 pen plotter, and the bget and bput commands to read and create
  361. : data files in binary format.
  362. :
  363. :
  364. : Please continue playing a little with Prof2d and use
  365. :
  366. : - help <command> for help on a specific command
  367. : - help help      for a list of all help pages
  368. : - show           for a list of variables and data structures in use
  369. : - history or h   for a list of recently given commands (to be repeated)
  370. :
  371. : Note that Prof2d runs on UNIX and VAX/VMS computers as well. Give
  372. : help public  to read Copyright information and find the address to
  373. : apply for a licence agreement to obtain the source code (in C).
  374. :
  375. : Give <quit enter> to leave Prof2d.
  376. :
  377.