/statismo

Framework for building statistical image and shape models

Primary LanguageC++OtherNOASSERTION

Due to lack of time and fundings, this fork is unfortunately no longer actively maintained.

Major bug fixes might be addressed but new algorithms won't be transferred back from Scalismo. If you need Scalismo features from C++, here are some tips:

  • Extend scalismo-ui to fill your needs
  • Call Scalismo as an external process from C++
    • Scalismo can be run in docker file (see Dockerfile)

Latest Release Build Status Documentation License

Statismo

Statismo is a c++ framework for statistical shape modeling. It supports all shape modeling tasks, from model building to shape analysis. Although the main focus of statismo lies on shape modeling, it is designed such that it supports any kind of PCA based statistical model, including statistical deformation models and intensiy models. One of the main goals of statismo is to make the exchange of statistical shape models easy. This is achieved by using a well documented file format based on HDF5. It also add shape modeling capabilities to other frameworks used in medical imaging (VTK and ITK).

This repository is a fork of the original projet created for keeping the SSM features available to the C++ community now that the original team is more focused on the development and maintainance of Scalismo.

The main purposes of this fork are:

  • Keeping the framework up-to-date with new build toochain versions (cmake, compilers),
  • Keeping the framework up-to-date with new language standards (c++, python),
  • Keeping the framework compatible with new dependency versions,
  • Backport main compatible features from Scalismo.

Browse the About section to get more information about the project (history, details).

Quick Start

Installation instructions can be found in the Install section.

Usage instructions can be found in the Usage section.

Need Some Help?

Try the following locations to get more documentation on the project:

In the source code, each directory contains a README that can help you understand the file hierarchy.

There is also the statismo-users google group for general questions and discussion regarding statismo and shape models in general.

Do not hesitate to browse the project issues or read the Known Build Issues if you encountered some problems with the project.

Want To Help?

Any help would be greatly appreciate as the current resources dedicated to the project are limited.

Read up on our guidelines for contributing!

You can file a bug or check out for an issue to solve here.

You can also contribute to new features described in the TODO list. Specific contributions to the project compatiblity or the packaging would be very useful.

Any other code contribution or documentation improvement would be excellent too, of course!

Do not hesitate to keep the community alive by sharing your questions and experiences on the group.

Version Numbers

Statismo uses semantic versioning based on a sequence of identifiers (x.y.z) that are updated according to change significance and degree of compatility:

  • x is the major version (increment for changes which are not backward-compatible),
  • y is the minor version (increment for new but backward-compatible API features),
  • z is the patch version (increment for fixes that does not change the API).

WARNING: Before the first 1.y.z version, backward-compatibility is not ensured.

License

Statismo itself is licensed under the BSD license. It depends, however, on other open source projects, which are distributed under different licenses. Most notably, these are:

and, depending on the configuration:

Acknowledgement

Thanks to the team behind Statismo and Scalismo for their great work.

Thanks to Marcel Luethi for his sound advises.