home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 December / simtel1292_SIMTEL_1292_Walnut_Creek.iso / msdos / spredsht / profile.arc / TUTORIAL.PRO < prev   
Text File  |  1990-01-03  |  12KB  |  394 lines
  1. : Profile, The 1D Scientific Spreadsheet               IBM-PC Version
  2. : by Gertjan L. Ouwerling, Electrical Materials Lab, Delft University
  3. : -------------------------------------------------------------------
  4. : Execute this tutorial by typing:  prof tutorial.pro <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. Profile on the IBM-PC (and its video adaptor card)
  13. : 2. Profile 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, differentiation and curve-fit
  18. : 7. Data manipulation and use of auxiliary files
  19. : 8. List of interesting but not demonstrated commands
  20. :
  21. :
  22. :
  23. pause
  24. : -------------------------------------------------------------------
  25. :
  26. : 1. Profile on the IBM-PC (and its video adaptor card)
  27. :
  28. : Profile 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.pro and 
  34. : remove one of the five comment colons (: means comment in Profile) 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 Profile what adaptor card it is currently sensing:
  43.  
  44. adapt ?
  45. pause
  46. : 
  47. : 2. Profile data structures (variables and data types)
  48. :
  49. : Basic data structures of Profile are integer and real variables (scalar)
  50. : and 1D columns of real data (called 'data types'). Most data structures
  51. : must be declared before using with the commands  var  and  type. 
  52. :
  53. : However, some variables and 'data types' (columns) are present by 
  54. : default and need not be declared. Most notable examples are:
  55. :
  56. : -> integer variable ndata, contains current number of data lines
  57. : -> data type count, counts from 0 to ndata-1 (unless changed)
  58. :
  59. : We will now declare some data structures to be used further. Later
  60. : on we will declare some more (this is always possible).
  61.  
  62. var int  naxis1 naxis2   $
  63. var real ysum   yinte    $
  64. type xaxis1 y1 y2 $
  65.  
  66. : Declarations end in $ to indicate the end of the argument list
  67.  
  68. pause
  69. :
  70. : 3. Internal generation of data and making graphs
  71. :
  72. : Profile accepts either commands (such as adapt or type) or 
  73. : mathematical expressions containing variables, data types and constants.
  74. : If an = sign is present, assignment is made. Otherwise the result is
  75. : printed. Some much used constants are present by default, for example
  76.  
  77. pi
  78.  
  79. : The default data type count may be used for data generation:
  80.  
  81. ndata=40
  82. xaxis1=count/(ndata-1)*2*pi
  83. y1=sin(xaxis1)
  84. naxis1=ndata
  85.  
  86. : The view command is used to look at data. Give  <enter> to leave!
  87.  
  88. pause
  89. view xaxis1 y1 $
  90.  
  91. : Columns of data are listed using the  print  command.
  92. : Part of the lines are optionally selected by ending in: | [start] [end] 
  93.  
  94. pause
  95. print xaxis1 y1 | 12 24 
  96.  
  97. : Some more data is generated and a graph is made with both y1 and y2
  98.  
  99. y2=cos(2*xaxis1)
  100.  
  101. pause
  102. view xaxis1 y1 y2 $
  103.  
  104. : The view command has more possibilities: a right xaxis may also be 
  105. : used and scaling values can be forced using the default variables:
  106. :
  107. : xls  - X Left  Scale
  108. : xrs  - X Right Scale
  109. : yls  - Y Lower Scale       (left  y axis)
  110. : yus  - Y Upper Scale       (left  y axis)
  111. : ryls - Right Y Lower Scale (right y axis)
  112. : ryus - Right Y Upper Scale (right y axis)
  113. :
  114. : Autoscaling is restored if  xls >= xrs,  etcetera.
  115.  
  116. xls  = -1.0
  117. xrs  =  8.0
  118. yus  =  1.2
  119. yls  = -1.2
  120. ryus =  2.0
  121. ryls = -2.0
  122.  
  123. pause
  124. view xaxis1 y1 | y2 $
  125.  
  126. : Restore the autoscaling by (re)setting scaling variables to zero
  127.  
  128. xls  = 0
  129. xrs  = 0
  130. yus  = 0
  131. yls  = 0
  132. ryus = 0
  133. ryls = 0
  134.  
  135. : Log plots can be made by taking the logarithm of the data
  136. : ---------
  137.  
  138. type log_y1 log_y2 $
  139.  
  140. : Argument of log() may not become zero!
  141.  
  142. log_y1 = log(abs(y1)+0.001)
  143. log_y2 = log(abs(y2)+0.001)
  144.  
  145. pause
  146. view xaxis1 log_y1 log_y2 $
  147.  
  148. :
  149. : 4. Reading and writing data from and to file
  150. :
  151. : Data can be written to and read from file with the commands  put & get.
  152. :
  153. : -> put [filename] [data type names] $
  154. : -> get [filename] [data type names] $
  155. :
  156. : Data has to be present in the form of legible columns of numbers. A one
  157. : line heading containing the names of the columns is allowed (and made by
  158. : the put command).
  159. :
  160. : If the get command is given without arguments, it automatically uses and
  161. : necessarily declares the appropriate columns ('data types').
  162. : The view command also shows these 'last read' types automatically. A fast
  163. : "get 'n see" sequence thus becomes:
  164. :
  165. : get file.dat $
  166. : view $              (or also print $  and even put [filename] $)
  167. :
  168. : This will be illustrated by putting a file, and getting and viewing it.
  169.  
  170. pause
  171.  
  172. put tutor.dat xaxis1 y1 y2 $
  173. get tutor.dat $
  174.  
  175. pause
  176.  
  177. : show last read data types
  178. view $
  179.  
  180. : It is remarked (but not demonstrated) that the commands
  181. :
  182. : startmark [begin of reading marker text]
  183. : endmark   [end   of reading marker text]
  184. :
  185. : are available to select only part of a file for reading.
  186. : Later on, try typing  help startmark  for some explanation.
  187.  
  188. pause
  189.  
  190. : 5. Escaping to the operating system (on the PC MS-DOS)
  191. :
  192. : Many operating system commands (such as dir and del, etc) can be typed
  193. : to the Profile prompt ("prof> ", only shown interactively). They are
  194. : executed if a command.com file can be loaded by the system.
  195. :
  196. : If Profile doesn't recognize a command (e.g. because it is not a standard
  197. : MS-DOS command or one of the DOS commands that is also a Profile command
  198. : such as type and print), you can use the 'shell escape' sign %
  199. :
  200. : An example:
  201. :
  202. pause
  203. % type tutor.dat
  204.  
  205. : Now look at the directory and delete our data file tutor.dat:
  206.  
  207. dir
  208. del tutor.dat
  209.  
  210. pause
  211.  
  212. : Run your application program (e.g. in development) from Profile 
  213. : and use the Profile history mechanism to rapidly see your results:
  214. :
  215. : % myprog mydata.in           : execute the external program MYPROG
  216. : get myprog.out $             : read output (file with header)
  217. : view $                       : look at output
  218. : % edit mydata.in             : change input for myprog with your editor
  219. : % myprog mydata.in           : re-run the external program MYPROG
  220. : !get                         : repeat the last line starting with 'get'
  221. : !vi                          : repeat the last line starting with 'vi'
  222. : .... etc
  223.  
  224. pause
  225.  
  226. : 6. Integration, differentiation and curve-fit
  227. :
  228. : Profile offers facilities for numerical data processing. With an example
  229. : integration, differentiation and curve-fit are demonstrated. 
  230. :
  231. : Using a synthetic x-axis, a Gaussian curve is formed. This is integrated
  232. : to give the shape of the error function erf(x). The integral value on a
  233. : sufficiently large interval should equal sqrt(pi). This is verified.
  234.  
  235. type x2 gauss errorf $
  236. ndata = 100
  237. : reset the count default data type
  238. recount
  239. x2 = 6*((count/(ndata-1))-0.5)
  240. gauss = exp(-x2*x2)
  241. : integrate gaussian function to find error function
  242. inte gauss x2 errorf
  243.  
  244. : Take a look at the results up till now
  245.  
  246. xls = -3.5
  247. xrs =  3.5
  248. pause
  249. view x2 gauss errorf $
  250.  
  251. : Check integral value by assigment of data type errorf to a real variable,
  252. : and divide by the expected value to see the relative error:
  253.  
  254. var real gaussarea $
  255. gaussarea = errorf
  256. gaussarea
  257. gaussarea / sqrt(pi)
  258.  
  259. pause
  260.  
  261. : Curve-fit.
  262. :
  263. : The Profile command  fit  makes a polynomial (recursive) fit to available
  264. : data. This is done by minimizing the sum of squared differences between 
  265. : measured and fit data. The data type  weight  (present by default) may be 
  266. : used to assign different weights to error sum components. By default, 
  267. : weight=1 for all elements. The default integer variable  npoly  may be 
  268. : used to limit the order of the polynomial. 
  269. :
  270. : A polynomial of 6th order is fit to the computed gaussian. A list is 
  271. : printed of the variance (a measure of the fit accuracy) and the ratio
  272. : between subsequent variances. Note that for the even gaussian function,
  273. : addition of odd polynomial orders does not improve the fit!
  274.  
  275. npoly=6
  276. type fitgauss $
  277.  
  278. pause
  279. fit gauss x2 fitgauss
  280.  
  281. : The fit command does not end in '$' because the number of 
  282. : arguments is known in advance. Let's take a look at the results:
  283.  
  284. pause
  285. view x2 gauss fitgauss $
  286.  
  287. : A better fit can be obtained by setting npoly=12 (the highest allowed). 
  288. : Maybe you can try this your self at the end of this tutorial.
  289. :
  290. : Note that the fit command supplies the first and second derivatives
  291. : of the fitted polynomial in the default data types tmp1 and tmp2. 
  292. : 
  293. : The same method of differentiation can be invoked by using the 
  294. : diff  command like:
  295. :
  296. : -> diff fit gauss x2 dgaussdx
  297. :
  298. : Here we will demonstrate differentiation by simple differencing
  299. : (subtraction of values). This is useful only if your data is very 
  300. : smooth. The differentiation of errorf (integrated from gauss)
  301. : should return our gaussian function:
  302.  
  303. type derf_dx2 $
  304. diff num errorf x2 derf_dx2 
  305. compare derf_dx2 gauss
  306.  
  307. pause
  308. : The compare command shows only a small difference. Look at the graphs:
  309.  
  310. pause
  311. view x2 gauss derf_dx2 $
  312.  
  313. : 7. Data manipulation and use of auxiliary files
  314. :
  315. : Finally, we will show some small Profile 'tricks' to bring data in
  316. : a desired form. With some creativity, many things can be arranged
  317. : using:
  318. :
  319. : - the pos(), pls() and neg() functions to select parts of a data type
  320. :   this is demonstrated in example2.pro
  321. : - the assign and extract commands to access individual data elements
  322. : - the map command to interpolate data from one x-axis to another
  323. : - the reduce and remove commands to throw away data lines
  324. : - the insert command to add new (zeroed) data lines
  325. : - the sort command to sort all lines according to one data type
  326. : - intermediate files to temporarily store data
  327. :
  328. : Not everything can be demonstrated here. One small example:
  329. :
  330. pause
  331. :
  332. : The gaussian will be put in front of the error function to form one
  333. : long data column. The x2 x-axis is also duplicated.
  334. : 
  335. : First save the gaussian in a temporary file.
  336.  
  337. put gauss.tmp x2 gauss $
  338.  
  339. : Create the prolonged x-axis by copy and addition.
  340.  
  341. var real xmin xmin2 xmax $
  342.  
  343. extract x2 1     xmin 
  344. extract x2 2     xmin2
  345. extract x2 ndata xmax
  346.  
  347. x2 = x2 + (xmax-xmin) + (xmin2-xmin) 
  348.  
  349. pause
  350.  
  351. : Insert enough lines to contain the first x-axis and the gauss.
  352. : Put the error function 'on top'.
  353. : Read the gauss and put it in front of the error function.
  354.  
  355. insert 1 ndata
  356. gauss = errorf
  357. get gauss.tmp x2 gauss $
  358. del gauss.tmp
  359. ndata = ndata*2
  360.  
  361. : look at the result!
  362.  
  363. pause
  364.  
  365. : disable forced x-axis scaling
  366. xls=0
  367. xrs=0
  368. view x2 gauss $
  369.  
  370. : 
  371. : ------------------------------------------------------------------
  372. :
  373. : This completes the Profile tutorial introduction.
  374. :
  375. : Many things were not treated. The most important omission is the 
  376. : Profile command  levmar  that does non-linear parameter extraction
  377. : by the Levenberg-Marquardt method on parametrized data models.
  378. :
  379. : Example1.pro gives a demonstration of the levmar command.
  380. :
  381. : Please continue playing a little with Profile and use
  382. :
  383. : - help <command> for help on a specific command
  384. : - help help      for a list of all help pages
  385. : - show           for a list of variables and data types in use
  386. : - history or h   for a list of recently given commands (to be repeated)
  387. :
  388. : Note that Profile runs on UNIX and VAX/VMS computers as well. Give
  389. : help public  to read Copyright information and find the address to
  390. : apply for a licence agreement to obtain the source code (in C).
  391. :
  392. : Give <quit enter> to leave Profile.
  393. :
  394.