home *** CD-ROM | disk | FTP | other *** search
/ Peanuts NeXT Software Archives / Peanuts-2.iso / Developer / objc / appkit / ContourPlot.README < prev    next >
Encoding:
Text File  |  1993-01-28  |  6.9 KB  |  157 lines
  1. ContourPlot.app
  2.  
  3.      Contour Plot object and application with color fills.
  4.      OS requirement: Release 3.0 or later.
  5.      Version: V1.01 93-01-25
  6.  
  7.      [Archive Maintainer, please put this into the 3.0 Source Code directory.]
  8.  
  9. -------------------------------------------------------------------------------------
  10. ContourPlot.app demonstrates the use of object class ContourView, but
  11. at the same time it tries to be a usable application for generating
  12. contour plots WITH COLOR FILLS from 2-dimensional grid data.
  13. While I have seen many contour plot routines and programs that produce
  14. contour lines in color, I could not find any that could FILL regions
  15. inside contour paths.  Hence, the ContourView class and this application.
  16. It can only handle 2-D data on a regularly spaced Cartesian grid.
  17.  
  18. ContourPlot reads 2-D grid data files in a simple ASCII format which
  19. may be generated easily by other programs.  See the Info/Help Panel
  20. and a sample data file for details of the file format.
  21.  
  22. * Press  File -> Open Sample File on the menu for a demo plot.
  23.  
  24. * Press  File -> View Sample File on the menu to look at the data
  25.   file that generates the demo plot.
  26.  
  27. Plots may be copied to the pasteboard as EPS (Encapsulated PostScript)
  28. by clicking the plot area once and pressing  Edit ->  Copy on the menu.
  29. Then, the plot may be pasted into documents that accept PostScript
  30. data, such as NeXTMail Compose window (In NeXTMail mode), Edit document
  31. (in RTF mode), ohter drawing/layout apps. 
  32.  
  33. To save to an EPS file, first paste into a Yap (or my BBFig)
  34. (/NextDeveloper/Apps/Yap.app) document, then save from Yap.
  35.  
  36.  
  37.  
  38.  
  39.  
  40. From ContourView README.
  41. -------------------------------------------------------------------------------------
  42.      Distinguishing features of this ContourView class are:
  43.      [1] It does color fills within contours just like colored geological maps.
  44.      As far as I am aware, this is the only public domain source code that can
  45.      do this for PostScript, not as bitmaps. (Let me know if you know of
  46.      any other PD code that does color-filled contour plots.)
  47.      [2] It is a pretty self contained object in the form of a View subclass.
  48.      [3] PostScript may be copied onto pasteboard and pasted into other apps that
  49.      accept EPS data.  Try pasting it into Yap document, NeXTmail compose
  50.      window, Edit RTFD document, etc.
  51.  
  52.      There is really no documentation.  Look at the class implementation file
  53.      ContourView.m and an example test application ContourPlotApp.m for usage
  54.      information.  The app included here is just for testing ContourView
  55.      class.  ContourView is meant to be included in your apps like any other
  56.      objects.
  57.  
  58.      It is pretty easy to use.  If instantiated within IB, all you need to do
  59.      to get a plot is to call the following two method to get a default
  60.      plot.  If you understand the following method, you can use the
  61.      ContourView object easily.
  62.  
  63.      - setCartesianGridData:(float *)f :(float)xmin :(float)xmax
  64.                   :(float)ymin :(float)ymax
  65.                   ofSize:(int)nx :(int)ny
  66.                   withInterpolationTo:(int)n1x :(int)n1y;
  67.  
  68.     f[nx*ny] is a 1-d array containing 2-d grid data such that f[iy*nx+ix]
  69.     contains the value at (ix, iy).
  70.     Typicall, just 3 messages below will produce a contour plot with color
  71.     fills.
  72.  
  73.     [contourView setCartesianGridData: fdata :1.0 :5.0 :1.0 :5.0
  74.                 ofSize: 20 :20
  75.                 withInterpolationTo: 50 :50];
  76.     [contourView setFillEnable:YES];
  77.     [contourView display];
  78.  
  79.     -------------------------------------------------------------------------------
  80.     TO USE:
  81.     ContourView class consists of the following modules/files.  Other files are
  82.     the glue needed for the test application ContourPlot.app.  When incorporating
  83.     ContourView into your app, you need to copy only the follwoing to your
  84.     project directory:
  85.  
  86.     ContourView.h
  87.     ContourView.m      (Class implementation)
  88.     computeContour.m  (contour path computation engine)
  89.     contour.h
  90.     sortContour.c      (sorting of contour path based on inclusion relation)
  91.     splin2.c      (bicubic spiline: ## This file is NOT INCLUDED, see below)
  92.     splin2.h
  93.  
  94.     -------------------------------------------------------------------------------
  95.     TO COMPILE:
  96.  
  97.     When all the files are ready, you can type build the whole application from
  98.     the ProjectBuilder application, or typing "make" from Terminal in this
  99.     directory.  Unfortunately, before you can do that, you must obtain several
  100.     files from the disk for the book "Numerical Recipes in C".
  101.  
  102.  
  103.     Because the authors of the book "Numerical Recipes in C - The Art of
  104.     Scientific Computing" does not allow source distribution of their routines,
  105.     I cannot distribute splin2.c which is necessary for ContourView.  However,
  106.     you can create my version of splin2.c using the "patch" program and applying
  107.     the patch to the original files.
  108.     [The restrictions stink, but I guess I have to be legal even if the rules
  109.     are virtually unenforceable.]
  110.  
  111.     Here's how:
  112.  
  113.     [1] Obtain the following files from "Numerical Recipes in C" disk, and
  114.     store them into the subdirectory ./NumRec
  115.     splin2.c    splie2.c    splint.c    spline.c    nrutil.c
  116.  
  117.     These files should be obtained, if possible, from the 1-st edition's disk.
  118.     I do not know if these files have changed from the 1-st to the 2-nd edition.
  119.  
  120.     [2] Rename them to *.c.orig, so you will have the following files in NumRec
  121.     splin2.c.orig    splie2.c.orig    splint.c.orig    spline.c.orig    nrutil.c.orig
  122.  
  123.     in addition to MakeNR.sh and NRpatch.
  124.  
  125.     [3] Type "MakeNR.sh" from Terminal in NumRec directory.
  126.     This creates the file splin2NEW.c.
  127.  
  128.     [4] Copy splin2NEW.c into the source directory as splin2.c
  129.  
  130.     [5] Build the application ContourPlot.
  131.  
  132.     ## NOTE: If you do not have the program "patch", you should get it.  If
  133.     you don't want to mess with sources, executable for NeXT is available
  134.     from "sutro.sfsu.edu" [130.212.15.230] as /pub/patch.Z via anonymous FTP.
  135.  
  136.     ## NOTE2:  Be aware that there is a bug in the splin2.c in the book (both
  137.     1-st and 2-nd editions and on the disk).  The patch fixes it.
  138.  
  139.     -------------------------------------------------------------------------------
  140.  
  141.     This can use a lot more optimizations which should speed up the drawing
  142.     significantly.  Some of these are:
  143.     [1] All parameter changes currently trigger recomputation of all contour paths,
  144.     because almost everything is done in drawSelf:: method.
  145.     This should not be necessary for some.  E.g., changing fill colors, line
  146.     width etc should not cause recomputation of contour paths.
  147.     [2] Use DoUserPath() etc to optimize drawing.
  148.     [3] Some methods are not yet implemented (It does what I wanted now).
  149.     -------------------------------------------------------------------------------
  150.     Send comments, bug reports, suggestions and improvements to below:
  151.  
  152. ---
  153. Izumi Ohzawa, Ph.D.            [ $@Bg_78^=;(J ]
  154. USMail: University of California, 360 Minor Hall, Berkeley, CA 94720
  155. Telephone: (510) 642-6440     Fax:  (510) 642-3323
  156. Internet: izumi@pinoko.berkeley.edu (NeXT Mail OK)
  157.