Changes between Initial Version and Version 1 of MindSeer_Developer_Documentation

05/08/06 16:23:25 (12 years ago)



  • MindSeer_Developer_Documentation

    v1 v1  
     1= Developer Documentation = 
     3This page is currently very sparse, and likely will be for quite a while 
     5== Javadoc == 
     6[ MindSeer JavaDoc] 
     7The Javadoc will often lag the released version and sometimes the comments are fairly sparse. 
     9== Compiling == 
     10The 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 
     19== IDE == 
     20With 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) 
     26== Assertions == 
     28 * Currently there are assertions in the shwing package.  These ensure the proper thread, but will fail in Client/Server mode.   
     29   {{{-ea:edu.washington.biostr.sig.brainj3d.shwing...}}} to enable just these assertions and 
     30   {{{-da:edu.washington.biostr.sig.brainj3d.shwing...}}} to disable just these assertions 
     31 * There are many other assertions spread around, to enable these use {{{-ea}}}. On the server make sure to disable shwing assertions. 
     33== Plugins == 
     35[ Graphical Diagram] 
     37 *  [wiki:MindSeer Plugin File] ''An XML descriptor file'' 
     38 *  [wiki:MindSeer Client plugin] ''The client supports new menus and popups'' 
     39 *  [wiki:MindSeer FileType plugin] ''includes decoders, encoders and Data plugins'' 
     40 *  [wiki:MindSeer View plugin] ''A View provides a new window type for visualization, i.e. 3D or Slice View'' 
     41 *  [wiki:MindSeer DataView plugin] ''A Data View encapsulates a Data instance for visualization in a given View'' 
     43== File Formats == 
     44MindSeer supports various common file formats.  These formats were chosen to either maximize compatibility or when we need to make a custom format, XML was used.  MindSeer will read files the are gzipped for all formats (add ".gz" to the extension). 
     45=== Volume File Formats === 
     46 * Analyze 7.5 (with SPM extensions) 
     47 * NIFTI (will eventually be the default format) 
     48 * Minc 
     50=== Model File Formats === 
     51 * MAT file (version 4 or 5) with 2 data matrices (faces and vertices) 
     52 * Wavefront OBJ (planned) 
     53 * Geomview ([ OFF format] is supported and we plan support for [ MESH format].)  A modified OFF format is the default output format,  [wiki:MindSeer Model Format]). 
     55=== Image File Formats === 
     56 * MindSeer supports all image file formats that are in java.imageio.ImageIO.  These include the built in formats (jpg, gif(read only), png, bmp, wbmp) and any formats that were installed separately. 
     57 * To add TIFF support go to [ ImageIO Download] and download the latest ImageIO package.  Follow the instructions. 
     59=== Other File Formats === 
     60 *  [wiki:MindSeer Workspace] 
     61 * Map file (XML, default map format)  
     62 * Legacy Map File (SKANDHA Brain Mapper)