[ismrmrd] 82/281: Bringing back xml2struct.m for the simple matlab read examples. Added some documentation about generating the javadoc for the xml header api.

[Ghislain Vaillant]

This is an automated email from the git hooks/post-receive script.

ghisvail-guest pushed a commit to annotated tag ismrmrd0.5
in repository ismrmrd.

commit d623407ae842f63a0ef00c4a69cf0a6ca5207863
Author: Souheil Inati <souheil.inati at nih.gov>
Date:   Tue Jan 22 15:39:42 2013 -0500

    Bringing back xml2struct.m for the simple matlab read examples.
    Added some documentation about generating the javadoc for the xml header api.
---
 matlab/README.txt                                   | 7 +++++--
 {examples/matlab/deprecated => matlab}/xml2struct.m | 0
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/matlab/README.txt b/matlab/README.txt
index e664a18..ffeea07 100644
--- a/matlab/README.txt
+++ b/matlab/README.txt
@@ -1,6 +1,8 @@
 The ISMRMRD Matlab Interface
 ============================
 
+The ISMRM raw data file format is based on HDF5.  Each dataset consists of an XML text header and a set of acquisitions or images.  Matlab has very good built-in support for reading HDF5, this makes reading ISMRMRD files into Matlab very straightforward.
+
 XML Header Interface
 --------------------
 The two methods, readxml and writexml, read and write a XML header
@@ -44,9 +46,10 @@ Compiling the JAVA bindings to the XML Header
 --------------------------------------------- 
 Assuming the ismrmrd library was installed in ${ISMRMRD_HOME}, the JAVA interface to the XML header can be created from the XML schema using the JAXB bindings in the following way: 
   cd ${ISMRMRD_HOME}/matlab/+ismrmrd
-  xjc -p org.ismrm.ismrmrd.xmlhdr ${ISMRMRD_HOME}/schema/ismrmrd.xsd
+  xjc -p org.ismrm.ismrmrd.xmlhdr ../schema/ismrmrd.xsd
   javac org/ismrm/ismrmrd/xmlhdr/*.java
-  jar -cvf xmlhdr.jar org/ismrm/ismrmrd/xmlhdr/*.class 
+  jar -cvf xmlhdr.jar org/ismrm/ismrmrd/xmlhdr/*.class
+  javadoc -d xmlhdr.javadoc org/ismrm/ismrmrd/xmlhdr/*.java
   rm -rf org
 
 
diff --git a/examples/matlab/deprecated/xml2struct.m b/matlab/xml2struct.m
similarity index 100%
rename from examples/matlab/deprecated/xml2struct.m
rename to matlab/xml2struct.m

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/ismrmrd.git