Changes between Version 2 and Version 3 of MindSeer_Developer_Documentation


Ignore:
Timestamp:
09/25/06 14:29:13 (11 years ago)
Author:
ebmoore
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • MindSeer_Developer_Documentation

    v2 v3  
    11= Developer Documentation = 
    22 
    3 This page is currently very sparse, and likely will be for quite a while 
    4  
    5 == Javadoc == 
    6 [http://sig.biostr.washington.edu/~ebmoore/javadoc/mindseer/index.html MindSeer JavaDoc] 
    7 The Javadoc will often lag the released version and sometimes the comments are fairly sparse. 
    8  
    9 == Compiling == 
    10 The easiest way to compile MindSeer is to use ApacheAnt.  All dependencies must be in the lib/ directory.  There are many build targets, a summary of the most common ones follows: 
    11  * compile - clean any build and compile the files 
    12  * help - compile the help.jar file.  This is needed in your class path to access help. 
    13  * makeStandalone - make the standalone jar file (MindSeer.jar). 
    14  * makeClientServer - make the jar files for the client and server (MindSeer-client.jar and MindSeer-server.jar). 
    15  * deploy - make all jar files (MindSeer.jar, MindSeer-client.jar and MindSeer-server.jar) 
    16  * matfile - compile just the code to load matlab files and put it in matfile.jar 
    17  * nifti - compile the code needed to load nifti files and put it in nifti.jar 
    18  
    19 == IDE == 
    20 With Java 1.5, it is much easier to integrate into an IDE.   
    21  1. Make sure that the source, compiler and system libraries point to JDK 1.5+ (with Java3D installed).   
    22  1. You need to make sure to exclude some files.  The convention we are using for system specific files is to prepend the name with the system (Mac, Linux and Win).  Currently, only Mac has a system specific file, so make sure to exclude {{{**/Mac*.java}}}. 
    23  1. Run the help target in ant.  This will generate the help files. 
    24  1. Setup the build path to use netcdf, fastutil, jnlp.jar and help.jar (in Eclipse, go to Project>Properties>Java Build Path>Libraries) 
    25  
     3== Helpful links == 
     4 * [http://femur.biostr.washington.edu/~mindseer/doc/ MindSeer JavaDoc]  The Javadoc will always correspond to the version deployed on femur and sometimes the comments are fairly sparse. 
     5 * [wiki:CompilingMindSeer Compiling MindSeer] 
     6  
    267== Assertions == 
    278 
     
    3617 
    3718 *  [wiki:MindSeer_Plugin_File] ''An XML descriptor file'' 
    38  *  [wiki:MindSeer_Client_plugin] ''The client supports new menus and popups'' 
    3919 *  [wiki:MindSeer_FileType_plugin] ''includes decoders, encoders and Data plugins'' 
    4020 *  [wiki:MindSeer_View_plugin] ''A View provides a new window type for visualization, i.e. 3D or Slice View'' 
     
    4525=== Volume File Formats === 
    4626 * Analyze 7.5 (with SPM extensions) 
    47  * NIFTI (will eventually be the default format) 
     27 * NIFTI 
    4828 * Minc 
    4929 
    5030=== Model File Formats === 
    5131 * MAT file (version 4 or 5) with 2 data matrices (faces and vertices) 
    52  * Wavefront OBJ (planned) 
    5332 * Geomview ([http://www.geomview.org/docs/html/geomview_41.html OFF format] is supported and we plan support for [http://www.geomview.org/docs/html/geomview_39.html#SEC42 MESH format].)  A modified OFF format is the default output format,  [wiki:MindSeer Model Format]). 
    5433