Changes between Initial Version and Version 1 of MindSeer_Package_Guide


Ignore:
Timestamp:
09/26/06 13:02:52 (13 years ago)
Author:
ebmoore
Comment:

Starting the package guide

Legend:

Unmodified
Added
Removed
Modified
  • MindSeer_Package_Guide

    v1 v1  
     1= Package Overview =
     2While there are many packages in MindSeer, there is a method to the madness.  To begin with, a good deal of the structure is designed to eliminate circular dependencies.  Also things are split up so that some packages could be broken off with relatively little work for use in other projects.
     3
     4== edu.washington.biostr.sig ==
     5Packages in this hierarchy are owned by the University of Washington and the long name follows Java guidelines.
     6
     7=== brainj3d ===
     8These files represent the core of MindSeer
     9
     10=== vault ===
     11The vault classes were originally conceived as a library for metadata about files.  It is not known if this library could be used externally from MindSeer.  It contains most of the MindSeer independent logic for displaying, querying and building a data set.  The original design was a little ambitious and so users can create alternate backing stores using databases or basic maps.
     12
     13==== core ====
     14These are the central classes for creating nodes, associating meta data and creating collections (DataVault) of files with metadata.  It also contains classes to execute queries.
     15
     16==== display ====
     17This includes classes for displaying and rearranging trees in Swing.
     18
     19==== files ====
     20These classe include filters for file types and utilities for files.
     21
     22==== remote ====
     23These classes were supposed to handle synchronization of the vault.  They are not used or tested.
     24
     25==== xml ===
     26The xml package contains classes to convert a Data Vault to or from XML.
     27
     28=== nifti ===
     29Generic NIFTI classes live here.  They can be used as an external library for reading NIFTI files.  Because it also handles SPM's transform, this library depends on matfile.
     30
     31=== matfile ===
     32These classes are responsible for reading a Matlab version 4 or 5 file and converting it into Java objects.  They are a separate library from MindSeer.
     33
     34== org.eiderman ==
     35Packages in this hierarchy are copyrighted by Eider Moore.  They were from his personal library and released under the LGPL.