dcmqi-guide
  • Introduction
  • Quick Start
  • Frequently Asked Questions (FAQ)
  • Tutorials
  • Use cases
    • Multi-structure segmentation of the brain
    • Segmentations and measurements from prostate MRI
  • User guide
    • Installation
      • Binary packages
      • Docker images
      • Build from source
      • 3D Slicer extension
    • General principles
    • Coding schemes
      • DICOM-defined coding schemes
      • Searching for codes outside DICOM
      • "Private" coding schemes
    • Command line tools usage
      • Segmentations
        • itkimage2segimage
        • segimage2itkimage
      • Measurements
        • tid1500writer
        • tid1500reader
      • Parametric maps
        • itkimage2paramap
        • paramap2itkimage
  • Developer guide
    • Update Appveyor build dependencies
    • Github release generation
    • Add new attribute to the schema
  • Troubleshooting
  • Limitations
  • Open source credits
Powered by GitBook
On this page
  • Checking out the source code
  • Prerequisites
  • Superbuild approach
  • Non-superbuild approach
  • Troubleshooting
Export as PDF
  1. User guide
  2. Installation

Build from source

PreviousDocker imagesNext3D Slicer extension

Last updated 7 years ago

dcmqi should build on Linux, Mac and Windows. You can confirm this is the case for the current version of the code by looking at the continuous integration (CI) platforms.

  • Linux build:

  • Windows build:

  • Mac OS X build:

Note that the failure icons indicate that something in the dashboard script failed - this could be build error, failed test, failed artifact upload, or failed download of a prerequisite. You will need to check the console output for the specific platform to see if there are problems with the build.

Checking out the source code

We use git/github to maintain the repository. You can clone the repository using this command:

git clone https://github.com/QIICR/dcmqi.git

If you are not familiar with git, there are many guides to help you get started, such as this one that should take about 10 minutes: .

Prerequisites

  1. developer environment for your platform (compiler, git)

  2. recent version of

Both can be installed with npm as follows:

sudo npm install jsonlint -g
sudo npm install ajv-cli -g

Superbuild approach

Non-superbuild approach

You can use this approach if you have (some of) the dependency libraries already built on your platform. dcmqi dependencies are

To reuse builds of those libraries, you will need to pass the corresponding variables to cmake as shown in the example below:

cmake DITK_DIR:PATH=C:\ITK-install \ 
  -DSlicerExecutionModel_DIR:PATH=C:\SlicerExecutionModel\SlicerExecutionModel-build \
  -DDCMTK_DIR:PATH=C:\DCMTK-install\cmake  \
  -DZLIB_ROOT:PATH=c:\zlib-install \ 
  -DZLIB_INCLUDE_DIR:PATH=c:\zlib-install\include \ 
  -DZLIB_LIBRARY:FILEPATH=c:\zlib-install\lib\zlib.lib \
  <dcmqi source directory>

Troubleshooting

dcmqi/dcmqi-build/apps/seg/itkimage2segimageCLP.h:214:1: error: stray ‘\’ in program
{
^
dcmqi/dcmqi-build/apps/seg/itkimage2segimageCLP.h:214:3: warning: missing terminating " character
{
^
dcmqi/dcmqi-build/apps/seg/itkimage2segimageCLP.h:214:1: error: missing terminating " character
{
^

To resolve this, check your global git settings. If you have autocrlf set, you may try setting it to auto.

Note that you can also see the specific components and steps needed to build dcmqi by looking at the CI configuration scripts ( for Lunux, for Mac, and for Windows).

If you would like to run dcmqi tests, you will need to install few extra tools for validating JSON files. These tools depend on npm installed as part of , and are the following:

With the superbuild approach, all of the will be build as part of the build process. This approach is the easiest, but also most time-consuming. 1. create dcmqi-superbuild directory 2. configure the project by running cmake <dcmqi source directory> from dcmqi-superbuild 3. run make from the superbuild directory

Under certain conditions, line endings may be incorrectly initialized for your platform by the checkout process (reported by @CJGoch in ), which may result in errors like below:

circle.yml
.travis.yml
appveyor.yml
Node.js
jsonlint
ajv-cli
dependencies
DCMTK
ITK
SlicerExecutionModel
zlib
https://github.com/QIICR/dcmqi/issues/14
https://guides.github.com/activities/hello-world/
cmake
Circle CI
TravisCI
Build status