Documentation/Nightly/Developers/FAQ
Contents
What is Slicer?
3D Slicer is:
- A software platform for the analysis (including registration and interactive segmentation) and visualization (including volume rendering) of medical images and for research in image guided therapy.
- A free, open source software available on multiple operating systems: Linux, MacOSX and Windows
- Extensible, with powerful plug-in capabilities for adding algorithms and applications.
Features include:
- Multi organ: from head to toe.
- Support for multi-modality imaging including, MRI, CT, US, nuclear medicine, and microscopy.
- Bidirectional interface for devices.
There is no restriction on use, but Slicer is not approved for clinical use and intended for research. Permissions and compliance with applicable rules are the responsibility of the user. For details on the license see here
Is Slicer really free?
Yes, really, truly, free. Not just a free trial. No pro version with all the good stuff. Slicer is free with no strings attached. You can even re-use the code in any way you want with no royalties and you don't even need to ask us for permission. (Of course we're always happy to hear from people who've found slicer interesting).
See the Slicer License page for the legal version of this.
Can I use slicer for patient care?
Slicer is intended for research work and has no FDA clearances or approvals of any kind. It is the responsibility of the user to comply with all laws and regulations (and moral/ethical guidelines) when using slicer.
How do I create an account for the Slicer wiki?
Current content of this wiki will be moved to https://slicer.readthedocs.io, https://www.slicer.org, and https://github.com/Slicer/Slicer/wiki websites and legacy content will be archived. New user accounts are no longer offered for this wiki.
How to uninstall Slicer?
- On Windows, choose "Uninstall" option from the Start menu.
- On the Mac, remove the Slicer.app file. To clean up settings, remove "~/.config/www.na-mic.org/"
- On Linux, remove the directory where the application is located. To clean up settings, remove "~/.config/NA-MIC/"
See the information about the location of Settings for all platforms. If the uninstaller is not working on windows you may need to remove the settings manually.
Developer FAQ: Modules
Within a Slicer build-tree, where are Slicer modules located?
Slicer module executables and libraries are located in your main Slicer build directory Slicer-Superbuild/Slicer-build. Refer to Directory Structure description for more details.
How to build module outside of Slicer source tree
Follow developers guide for building modules
How to modify local version of external module
Some Slicer modules (such as OpenIGTLink and OpenIGTLinkIF) are built as External git projects by CMake scripts in the Slicer/SuperBuild directory. The SuperBuild process may refresh from the repository unexpectedly, overwriting any local changes. To avoid this, comment out the git settings in the appropriate external build file while making local edits. For example, in SuperBuild/External_OpenIGTLinkIF.cmake:
GIT_REPOSITORY "${git_protocol}://github.com/openigtlink/OpenIGTLinkIF.git"
GIT_TAG "f9b65b1ffd2992862025f3c6ec5fe30e6f5dd395"
SOURCE_DIR ${CMAKE_BINARY_DIR}/${proj}
|
# GIT_REPOSITORY "${git_protocol}://github.com/openigtlink/OpenIGTLinkIF.git"
# GIT_TAG "f9b65b1ffd2992862025f3c6ec5fe30e6f5dd395"
SOURCE_DIR ${CMAKE_BINARY_DIR}/${proj}
|
How to call a CLI module from a C++ loadable module?
Discussion: http://slicer-devel.65872.n3.nabble.com/Calling-CLI-module-from-a-C-loadable-module-tt4031930.html
Example: vtkSlicerCropVolumeLogic.cxx#L318-351
How to call a CLI module from command-line?
Example:
Slicer.exe --launch CastScalarVolume input.mha output.mha
Notes for windows:
- Full name of the Slicer executable is required (Slicer.exe, not just Slicer)
- To get help on command-line arguments the CLI module supports, run:
Slicer.exe --launch CastScalarVolume 2>c:\SomeWriteAbleDirectory\usage.txt
