THESE/codes/snake/gvf_dist_v4.2c/README

   1 GRADIENT VECTOR FLOW DEMONSTRATION USING MATLAB
   2 Chenyang Xu and Jerry Prince
   3 Image Analysis and Communications Laboratory
   4 Johns Hopkins University
   5 June 17, 1997, updated on September 9, 1999.
   6
   7 Please see contact and copyright information below.
   8
   9 1. Introduction and Installation Instructions
  10 ----------------------------------------------
  11
  12 Welcome to the Gradient Vector Flow (GVF) Active Contour Toolbox.  The
  13 Matlab *.m files in this software distribution implement our GVF snake,
  14 the original (Kass, Witkin, and Terzopoulos) snake, the balloon snake,
  15 and the distance snake. These programs were designed, written and tested
  16 by Chenyang Xu and Jerry Prince.
  17
  18 To install this software, simply unzip the file into an empty directory,
  19 making sure to ask your unzipper program to restore the directory
  20 structure of the zipped files. In this documentation, we will assume
  21 that you have unzipped the files into C:\GVF.
  22
  23
  24 2. Documentation
  25 ----------------
  26
  27 We have included two research papers that describe GVF. You can find
  28 these in C:\GVF\papers.
  29
  30 Brief descriptions of the software modules can be found in this file
  31 below.  For more detail, you should run Matlab, add the path
  32 C:\GVF\snake, and type "help function-name".  For even more help, you can
  33 read the *.m files themselves.
  34
  35 Also, see our GVF demonstration website: http://iacl.ece.jhu.edu/projects/gvf
  36
  37
  38 3. MATLAB functions
  39 -------------------
  40
  41 The MATLAB functions included in the distribution are found in
  42 C:\GVF\snake (assuming the distribution was unzipped into C:\GVF).
  43 They are classified and listed as follows:
  44
  45  Image input/output
  46    rawread       - Read a Portable Bitmap file, or a raw file
  47    rawwrite      - Write a Portable Bitmap file, or a raw file
  48
  49  Image Display
  50    imdisp        - Display an image
  51
  52  Active Contour
  53    snakeinit     - Initialize the snake manually
  54    snakedeform   - Deform snake in the given external force field
  55    snakedeform2  - Deform snake in the given external force field with
  56                    pressure force
  57    snakedisp     - Display a snake
  58
  59    snakeinterp   - Interpolate the snake adaptively
  60    snakeinterp1  - Interpolate the snake at a fixed resolution
  61                    (better implemented than snakeinterp)
  62
  63  Gradient Vector Flow
  64    GVF           - Compute the gradient vector flow field
  65
  66  Other
  67    dt            - Simple distance transform
  68    gaussianBlur  - Blurring an image using gaussian kernel
  69    gaussianMask  - Generate a discrete gaussian mask
  70
  71 To use these functions, add the path C:\GVF\snake to the Matlab path
  72 using the "path" command. Once the path is set, you can type "help
  73 snake" to list more details about the above functions.
  74
  75
  76 4. Examples
  77
  78 To see how these functions work, it is best to start by running
  79 the following example macros. To do this, in Matlab cd to the directory
  80 C:\GVF\examples.  Then type one of the following commands and follow
  81 the instructions of the demo.
  82
  83    balloon_ex.m
  84    distance_ex.m
  85    gvf_ex.m
  86    tradition_ex.m
  87
  88 5. Test Images
  89 --------------
  90
  91 ./images/U64.pgm   - a U-shaped object
  92 ./images/room.pgm  - a room-shaped object
  93
  94
  95 6. Contact Information
  96 ----------------------
  97
  98 Image Analysis and Communications Lab
  99 Department of Electrical and Computer Engineering
 100 The Johns Hopkins University
 101 Baltimore, MD 21218
 102
 103 E-mail: chenyang@jhu.edu, prince@jhu.edu
 104 Phone: 410-516-7567 (lab)
 105 FAX:   410-516-5566
 106
 107
 108 7. Copyright and Disclaimer
 109 ---------------------------
 110
 111 Copyright (c) 1996-1997 Chenyang Xu and Jerry Prince.
 112
 113 This software is copyrighted by Chenyang Xu and Jerry Prince.  The
 114 following terms apply to all files associated with the software unless
 115 explicitly disclaimed in individual files.
 116
 117 The authors hereby grant permission to use, copy, and distribute this
 118 software and its documentation for any purpose, provided that existing
 119 copyright notices are retained in all copies and that this notice is
 120 included verbatim in any distributions. Additionally, the authors grant
 121 permission to modify this software and its documentation for any
 122 purpose, provided that such modifications are not distributed without
 123 the explicit consent of the authors and that existing copyright notices
 124 are retained in all copies.
 125
 126 IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY FOR
 127 DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
 128 OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY DERIVATIVES
 129 THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF
 130 SUCH DAMAGE.
 131
 132 THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
 133 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 134 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
 135 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND
 136 DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
 137 UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 138
 139 =========================================================================
 140