search

ismrmrd / ge_to_ismrmrd

GE to ISMRMRD converter
Other
7 stars 10 forks source link

readme

Getting started with the Orchestra to ISMRMRD converter library

Orchestra conversion tools

To manually build and install the tools to convert GE raw files (using Orchestra 2.1-1) into ISMRMRD files:

As of Orchestra 2.1-1, GE now provides all support libraries to link against, when building against Orchestra's API. Library versions have also up been updated / modernized, therefore compilation using older ABIs might not be necessary. This will be explored in subsequent commits.

The steps outlined below should allow you to build and install ISMRMRD using Orchestra's Boost and HDF5 libraries, and the GE-to-ISMRMRD converter.

  1. Define the SDKTOP environment variable:

    export SDKTOP=/fmrif/projects/ESE/Orchestra

  2. Define the ISMRMRD_HOME AND GE_TOOLS_HOME variables. These specify installation location(s), e.g.

    export ISMRMRD_HOME=<prefix>/ismrmrd
export GE_TOOLS_HOME=<prefix>/ge-tools

  3. Obtain the ISMRMRD source code:

    git clone https://github.com/ismrmrd/ismrmrd

  4. Pre-define the location of HDF5 in order to use Orchestra's static HDF5 library:

    export HDF5_ROOT=$SDKTOP/3p

    Any other version of HDF5 on the system can cause conflicts as cmake will find all versions, and will cause issues or conflicts with the build process. For these instructions to work, only the HDF5 supplied with Orchestra should be on the system.

  5. Configure, compile, and install ISMRMRD:

    cd ismrmrd/
mkdir build
cd build/
cmake -D build4GE=ON -D CMAKE_INSTALL_PREFIX=$ISMRMRD_HOME ..
make install
cd ../

    If the situation is encountered where the system compilers and Boost version are "too far ahead" of how Orchestra's support libraries (which include Boost) were compiled, then it may be necessary to have the ISMRMRD build explicitly refer to Orchestra's Boost libraries, with a command like:

    cmake -D CMAKE_INSTALL_PREFIX=$ISMRMRD_HOME -D build4GE=TRUE -D Boost_NO_BOOST_CMAKE=TRUE -D Boost_NO_SYSTEM_PATHS=TRUE ..

    A good discussion of pointing cmake to alternate Boost installations can be found at this link.

    It may also be necessary to force the usage of older ABIs standards for C++. To accomplish this, a switch along the lines of:

    -D_GLIBCXX_USE_CXX11_ABI=0

    will have to be added to the "CMAKE_CXX_FLAGS" option in the project's CMakeLists.txt file.

  6. If using the Gadgetron for reconstruction, please use a standard Gadgetron installation or Docker container. The Gadgetron now requires Boost version 1.65 or newer, which is newer than that supplied with GE's latest Orchestra Linux SDK. Therefore, Gadgetron currently cannot be built using components from GE's Orchestra Linux SDK, as was previously possible.

  7. Obtain the GE converter source code:

    git clone https://github.com/ismrmrd/ge_to_ismrmrd.git

  8. Configure, compile and install the converter:

    cd ge_to_ismrmrd/
mkdir build
cd build/
cmake -D CMAKE_INSTALL_PREFIX=$GE_TOOLS_HOME ..
make install
cd ../

Converting GE raw files into ISMRMRD files:

Make sure $ISMRMRD_HOME/bin and $GE_TOOLS_HOME/bin are added to your environment's PATH variable, and that $ISMRMRD_HOME/lib and $GE_TOOLS_HOME/lib are added to your environment's LD_LIBRARY_PATH variable, to be able to use the libraries and binaries supplied with these tools.

  1. A typical command line to convert the supplied P-file using this library is:

    ge2ismrmrd -v P21504_FSE.7

  2. If customized conversion libraries and/or stylesheets are desired, the corresponding command will be:

    ge2ismrmrd -v -p NIH2dfastConverter -x $GE_TOOLS_HOME/share/ge-tools/config/default.xsl P21504_FSE.7

    The source code that enables this example is included with these tools. This example is a straightforward copy of the GenericConverter, but it shows how these classes can be inherited from and implemented.

  3. Similarly, a typical command line to convert an example ScanArchive file using this library is:

    ge2ismrmrd -v -p GenericConverter -x $GE_TOOLS_HOME/share/ge-tools/config/default.xsl ScanArchive_FSE.h5

    Sample raw data files are now in the 'sampleData' directory.

Building a Docker image containing ge2ismrmrd tools

  1. Copy the orchestra-sdk-[version].tar.gz into your local ge_to_ismrmrd respository

  2. Build a Docker image using:

    docker build --file Dockerfile --tag ge_to_ismrmrd .

  3. An example of using ge_to_ismrmrd Docker image to convert GE raw files:

    docker run -it --rm -v `pwd`/src/config:/config -v `pwd`/sampleData:/sampleData ge_to_ismrmrd ge2ismrmrd -v -p GenericConverter -x /config/default.xsl /sampleData/ScanArchive_FSE.h5 -o /sampleData/ismrmrd_FSE.h5