Difference between revisions of "Documentation/Nightly/FAQ/General"

From Slicer Wiki
Jump to: navigation, search
Tag: 2017 source edit
(Removed obsolete parts or parts that have been moved to readthedocs)
Line 1: Line 1:
−
<noinclude>{{documentation/versioncheck}}</noinclude>
+
<noinclude>{{documentation/versioncheck}}
 +
</noinclude>
 
<noinclude>__TOC__
 
<noinclude>__TOC__
−
={{#titleparts: {{PAGENAME}} | | -1 }}=</noinclude><includeonly>
+
={{#titleparts: {{PAGENAME}} | | -1 }}=
 +
</noinclude><includeonly>
 
{{#ifeq: {{#titleparts: {{PAGENAME}} | 3 }} | Documentation/{{documentation/version}}/Developers | | ='''User FAQ: {{{1}}}'''=}}
 
{{#ifeq: {{#titleparts: {{PAGENAME}} | 3 }} | Documentation/{{documentation/version}}/Developers | | ='''User FAQ: {{{1}}}'''=}}
 
</includeonly>
 
</includeonly>
−
== What is Slicer ? ==
+
==What is Slicer?==
 
{{:Documentation/{{documentation/version}}/Slicer}}
 
{{:Documentation/{{documentation/version}}/Slicer}}
−
 
+
==Where can I download Slicer?==
−
 
 
−
== Where can I download Slicer? ==
 
 
3DSlicer is available for download by visiting the following link:  '''http://download.slicer.org'''
 
3DSlicer is available for download by visiting the following link:  '''http://download.slicer.org'''
  
Line 16: Line 16:
  
 
Always include these parameters:
 
Always include these parameters:
−
* ''stability'', which can be ''release'', ''nightly'', or ''any''
+
 
−
* ''os'', which can be ''win'', ''macosx'', or ''linux''
+
*''stability'', which can be ''release'', ''nightly'', or ''any''
 +
*''os'', which can be ''win'', ''macosx'', or ''linux''
  
 
Additional options:
 
Additional options:
−
* revision built before or on the date: ''date=2015-01-01''
+
 
−
* same but checkout date: ''checkout-date=2015-02-01''
+
*revision built before or on the date: ''date=2015-01-01''
−
* exact revision: ''revision=27000''
+
*same but checkout date: ''checkout-date=2015-02-01''
−
* revision less than of equal: ''closest-revision=26000''
+
*exact revision: ''revision=27000''
−
* latest revision of 4.3 branch, can include patch as well: ''version=4.3''
+
*revision less than of equal: ''closest-revision=26000''
 +
*latest revision of 4.3 branch, can include patch as well: ''version=4.3''
  
 
Any of these queries can be combined with the offset param, which will step forward or backward a given number of revisions. So,
 
Any of these queries can be combined with the offset param, which will step forward or backward a given number of revisions. So,
 
''stability=release&version=4.5.0&offset=-1'' should give you the revision just before the first 4.5 release.
 
''stability=release&version=4.5.0&offset=-1'' should give you the revision just before the first 4.5 release.
  
−
== Where can I download older release of Slicer ? ==
+
==Where can I download older release of Slicer ?==
  
 
Older releases of 3DSlicer are available here: https://slicer-packages.kitware.com/#collection/5f4474d0e1d8c75dfc70547e/folder/5f4474d0e1d8c75dfc705482
 
Older releases of 3DSlicer are available here: https://slicer-packages.kitware.com/#collection/5f4474d0e1d8c75dfc70547e/folder/5f4474d0e1d8c75dfc705482
  
 
Extensions can be downloaded for old Slicer releases manually from the Extensions Catalog at the URL: <code>https://extensions.slicer.org/catalog/All/(revision_number)/(operating_system)</code>. Revision number is available in Slicer menu: Help / About Slicer (or in the [https://www.slicer.org/wiki/Release_Details#Slicer_4.8 Slicer Releases page]). Operating system can be: <code>win</code>, <code>linux</code>, or <code>macosx</code>. For example for Slicer-4.8.0 on Windows extensions are available at: https://extensions.slicer.org/catalog/All/26489/win
 
Extensions can be downloaded for old Slicer releases manually from the Extensions Catalog at the URL: <code>https://extensions.slicer.org/catalog/All/(revision_number)/(operating_system)</code>. Revision number is available in Slicer menu: Help / About Slicer (or in the [https://www.slicer.org/wiki/Release_Details#Slicer_4.8 Slicer Releases page]). Operating system can be: <code>win</code>, <code>linux</code>, or <code>macosx</code>. For example for Slicer-4.8.0 on Windows extensions are available at: https://extensions.slicer.org/catalog/All/26489/win
−
 
−
== Does Slicer work for non-English computing? ==
 
−
 
−
At this point no, Slicer uses US English conventions.  Specifically this means that directory paths should use ASCII characters only.
 
−
 
−
There has been some discussion and planning about internationalization but it is not yet available:
 
−
* https://www.slicer.org/wiki/Documentation/Labs/I18N
 
−
* https://discourse.slicer.org/t/slicer-internationalization/579
 
−
 
−
== How to install Slicer ? ==
 
−
 
−
{{:Documentation/{{documentation/version}}/Slicer/Install}}
 
−
 
−
 
 
==Is Slicer really free?==
 
==Is Slicer really free?==
  
Line 53: Line 41:
  
 
See [http://www.slicer.org/pages/LicenseText the Slicer License page] for the legal version of this.
 
See [http://www.slicer.org/pages/LicenseText the Slicer License page] for the legal version of this.
−
 
−
==Where can I find someone to help me use Slicer?==
 
−
 
−
We rely on the community of users and developers to share their expertise. Slicer Community support and development discussions are hosted on Discourse, which provides a modern web forum as well as email-only interaction:
 
−
 
−
    https://discourse.slicer.org
 
−
 
−
If you post to any public forum, be sure not to include any [http://en.wikipedia.org/wiki/Protected_health_information Protected Health Information (PHI)] or any other data that would get you or anyone else in trouble.  However, posting example data can be very important to people who are interested in helping you solve your problems.  If you can replicate your question using data from the [[Documentation/{{documentation/version}}/Modules/SampleData|Sample Data]] or [[Documentation/{{documentation/version}}/Modules/DataStore|Data Store]] modules that's the first choice.
 
−
 
−
The [[Documentation/Nightly | Users Manual]] gives descriptions for using each module, and you can check out the [[Documentation/Nightly/Training | Training pages]] for in depth tutorials about workflows.
 
−
 
−
Mailing list discussions before 2017 April are [https://www.slicer.org/wiki/Help#Mailing_List_.28discontinued.29_Archives archived]
 
  
 
==Can I use slicer for patient care?==
 
==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.
 
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?==
−
 
 
−
==How to cite Slicer?==
 
−
{{:CitingSlicer}}
 
−
 
 
−
== 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.
 
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.
  
−
==Can I install Slicer without administrator rights?==
+
==How to uninstall Slicer?==
  
−
The most convenient way to install Slicer is to run the installer package (Slicer-{{documentation/currentversion}}....exe) as administrator. However, installation is not necessary, you just need to unpack the files in the installer package and copy them to your user directory or a USB drive and start it by running ''Slicer.exe''.
 
−
 
−
You can unpack the installation package by one of the following methods:
 
−
* Install Slicer on any computer where you have administrator access. All the files that you need to run Slicer are in the C:\Program Files\Slicer... directory.
 
−
* Unpack the installation package by using 7zip or using the InstallExplorer plugin in Total commander or FAR manager (http://nsis.sourceforge.net/Can_I_decompile_an_existing_installer). All the Slicer files will be in the $_OUTDIR directory, except Slicer.exe, so you have to copy Slicer.exe into $_OUTDIR and run it from there. You can rename the $_OUTDIR directory and discard all the other directories ($COMMONFILES, $PLUGINSDIR, etc).
 
−
 
−
 
−
==What if I have problems with Slicer installation?==
 
−
You can read our guide explaining [https://slicer.readthedocs.io/en/latest/user_guide/get_help.html#i-want-to-report-a-problem how to report a problem].
 
−
 
−
==Slicer does not start==
 
−
 
−
=== "Insufficient graphics capability" popup is displayed ===
 
−
 
−
In Slicer-4.9, minimum graphics requirements have been increased compared to earlier versions. Computers running Slicer must support OpenGL 3.2. This OpenGL version was released in 2009 and so all desktop and laptop computers should already support it. However, on virtual machines or when connecting to a computer via remote desktop, this minimum requirements may not be met.
 
−
 
−
* If you are trying to connect through Windows remote desktop (RDP):
 
−
** Recent Intel integrated GPUs and some NVidia GPUs (Quadro series) running on Windows 10 now support running current OpenGL versions. You may consider upgrading your hardware and operating system.
 
−
** You can use other remote desktop applications, such as [https://www.realvnc.com/ RealVNC], [https://anydesk.com/ AnyDesk], or [https://remotedesktop.google.com/ Google remote desktop] (all free, or free for personal use)
 
−
** If your computer can normally run Slicer but when started through remote desktop it displays "Insufficient graphics capability" popup: You need to start Slicer in normal desktop mode and then establish remote connection. You can achieve this by following these steps:
 
−
*** Connect to the remote computer using remote desktop
 
−
*** Start Slicer on the remote computer
 
−
*** Click "Retry" when "Insufficient graphics capability" popup appears
 
−
*** Grant administrator access in the displayed user account control popup (administrator access is needed for termination of the current remote desktop session), this will close the remote desktop connection
 
−
*** Reconnect to the remote computer using remote desktop - you should see Slicer application started up successfully
 
−
 
−
=== Any other issues ===
 
−
 
−
See [https://slicer.readthedocs.io/en/latest/user_guide/get_help.html#slicer-application-does-not-start debugging application startup issues].
 
−
 
−
==How to uninstall Slicer?==
 
 
*On Windows, choose "Uninstall" option from the Start menu.
 
*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 the Mac, remove the Slicer.app file. To clean up settings, remove "~/.config/www.na-mic.org/"
Line 116: Line 56:
  
 
See the information about the location of [[Documentation/{{documentation/version}}/SlicerApplication/Settings|Settings]] for all platforms.  If the uninstaller is not working on windows you may need to remove the settings manually.
 
See the information about the location of [[Documentation/{{documentation/version}}/SlicerApplication/Settings|Settings]] for all platforms.  If the uninstaller is not working on windows you may need to remove the settings manually.
−
 
−
== Where can I find Slicer tutorials? ==
 
−
Slicer tutorials associated with the latest {{documentation/currentversion}} stable release are available by visiting the following link:  [[Documentation/Nightly/Training|Click Here]].
 
−
 
−
 
−
==I read errors in the logs complaining about memory==
 
−
 
−
Errors such as “Description: Failed to allocate memory for image.” indicate that you don’t have enough memory space.
 
−
This can be a common issue if you run a 32-bit version of Slicer. You cannot expect a 32-bit executable to deal with any moderately complex problem. The [[Documentation/{{documentation/version}}/SlicerApplication/HardwareConfiguration#32_bit_versus_64_bit|recommended solution]] is to download/build/use Slicer in 64-bit mode.
 
−
 
−
Possible workarounds:
 
−
* Use a 64-bit version of Slicer
 
−
* You have somewhat more memory if you run the module in a separate process. To do that open [[Documentation/{{documentation/version}}/SlicerApplication/ApplicationSettings#Modules|Edit / Application Settings / Modules]] and check the “Prefer Executable CLIs” option, then restart Slicer.
 
−
* Decrease the size and/or resolution of the input and output images
 
−
** Consider [[Documentation/{{documentation/version}}/Modules/Crop_Volume|Crop Volume]] to focus on just your area of interest.
 
−
** Consider [[Documentation/{{documentation/version}}/Modules/ResampleScalarVectorDWIVolume|ResampleScalarVectorDWIVolume]] or [[Documentation/{{documentation/version}}/Modules/ResampleScalarVolume|ResampleScalarVolume]] increase the sample spacing (decrease the resolution) of your data.
 
−
 
−
 
−
== Which Slicer version should I use: 3.X or 4.X ? ==
 
−
 
−
In general slicer3 and slicer4 have roughly similar functionality with respect to registration basics.  Probably the most important thing to keep in mind is that slicer3 is no longer actively maintained.
 
−
 
−
Slicer4, on the other hand, has benefited from literally hundreds of bug fixes over the past several years, and typically has better features and much better performance.  Also, the nightly builds of slicer4 are now using ITKv4, which has significantly improved registration code.  I am told by active users/developers of ITK that ITKv4 should provide significantly better results in many cases.  Also, several new registration techniques are being actively developed for slicer4.
 
−
 
−
Source: http://massmail.spl.harvard.edu/public-archives/slicer-users/2013/006190.html
 
−
 
−
 
−
== What is my HOME folder ? ==
 
−
 
−
{|width = "100%"
 
−
! width="50%" style="border-bottom: 1px solid darkgrey;font-size: 75%;"| Linux or MacOSX
 
−
! width="50%" style="border-bottom: 1px solid darkgrey;font-size: 75%;"| Windows
 
−
|-
 
−
| valign="top" |
 
−
Start a terminal.
 
−
{{pre2|<nowiki>
 
−
$ echo ~
 
−
/home/jchris
 
−
</nowiki>}}
 
−
| valign="top" |
 
−
 
−
Start Command Prompt (Start Menu -> All Programs -> Accessories -> Command Prompt)
 
−
{{pre2|<nowiki>
 
−
> echo %userprofile%
 
−
C:\Users\jcfr
 
−
</nowiki>}}
 
−
|}
 

Revision as of 20:48, 30 December 2025

Home < Documentation < Nightly < FAQ < General


For the latest Slicer documentation, visit the read-the-docs.


General

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

Where can I download Slicer?

3DSlicer is available for download by visiting the following link: http://download.slicer.org

You can also get older releases by using the offset parameter in the download page. For example, download page from 7 days ago: http://download.slicer.org/?offset=-7

To get a direct download link of previous revision on a selected operating system: http://download.slicer.org/download?os=macosx&stability=any&offset=-1

Always include these parameters:

  • stability, which can be release, nightly, or any
  • os, which can be win, macosx, or linux

Additional options:

  • revision built before or on the date: date=2015-01-01
  • same but checkout date: checkout-date=2015-02-01
  • exact revision: revision=27000
  • revision less than of equal: closest-revision=26000
  • latest revision of 4.3 branch, can include patch as well: version=4.3

Any of these queries can be combined with the offset param, which will step forward or backward a given number of revisions. So, stability=release&version=4.5.0&offset=-1 should give you the revision just before the first 4.5 release.

Where can I download older release of Slicer ?

Older releases of 3DSlicer are available here: https://slicer-packages.kitware.com/#collection/5f4474d0e1d8c75dfc70547e/folder/5f4474d0e1d8c75dfc705482

Extensions can be downloaded for old Slicer releases manually from the Extensions Catalog at the URL: https://extensions.slicer.org/catalog/All/(revision_number)/(operating_system). Revision number is available in Slicer menu: Help / About Slicer (or in the Slicer Releases page). Operating system can be: win, linux, or macosx. For example for Slicer-4.8.0 on Windows extensions are available at: https://extensions.slicer.org/catalog/All/26489/win

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.

Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/Nightly/FAQ/General&oldid=64449"