README.md 4.75 KB
Newer Older
1
2
# Sight

3
4
| Branch |    Status |
|--------|-----------|
5
6
| Dev    | [![pipeline status](https://git.ircad.fr/Sight/sight/badges/dev/pipeline.svg)](https://git.ircad.fr/Sight/sight/commits/dev) |
| Master | [![pipeline status](https://git.ircad.fr/Sight/sight/badges/master/pipeline.svg)](https://git.ircad.fr/Sight/sight/commits/master) |
7

8
## Description
9

10
**Sight**, the **S**urgical **I**mage **G**uidance and **H**ealthcare **T**oolkit aims to ease the creation of applications based on medical imaging.
11
It includes various features such as 2D and 3D digital image processing, visualization, augmented reality and medical interaction simulation. It runs on many different environments (Windows, linux, macOS), is written in C++, and features rapid interface design using XML files. It is freely available under the LGPL.
12

13
**Sight** is mainly developed by the research and development team of [IRCAD France](https://www.ircad.fr) and [IHU Strasbourg](https://www.ihu-strasbourg.eu), where it is used everyday to develop experimental applications for the operating room.
14

15
**Sight** was formerly known as [FW4SPL](https://github.com/fw4spl-org/fw4spl). It was renamed in 2018, firstly to make its purpose clearer, and secondly as part of a major change in design and in the governance of the development team. For instance, FW4SPL was made of several repositories, whereas Sight now contains all open-source features in a single one, for the sake of simplicity.
Flavien BRIDAULT's avatar
Flavien BRIDAULT committed
16

17
Lots of **tutorials** and **examples** can also be found in the `Samples` directory. The tutorials can help you to learn smoothly how to use **Sight**, detailed steps are described [here](https://sight.pages.ircad.fr/sight-doc/Tutorials/index.html).
Flavien BRIDAULT's avatar
Flavien BRIDAULT committed
18

19
### Features
Flavien BRIDAULT's avatar
Flavien BRIDAULT committed
20

21
22
23
24
25
26
27
* 2D/3D visualization of images, meshes, and many widgets, either with [VTK](https://www.vtk.org/) or [Ogre3D](https://www.ogre3d.org/),
* Configurable GUI
* Advanced memory management to support large data
* webcam, network video and local video playing based on [QtMultimedia](http://doc.qt.io/qt-5/qtmultimedia-index.html),
* mono and stereo camera calibration,
* [ArUco](https://sourceforge.net/projects/aruco/) optical markers tracking,
* [openIGTLink](http://openigtlink.org/) support through client and server services,
28
* TimeLine data, allowing to store buffers of various data (video, matrices, markers, etc...). These can be used to synchronize these data across time.
29
* Data serialization in xml/json/zip
30

31
## Applications
32

33
### VRRender
34

35
**Sight** comes with **VRRender**, a medical image and segmentation viewer. It supports many import formats including DICOM and VTK.
36

37
38
39
![VRRender main page](https://sight.pages.ircad.fr/sight-doc/_images/SDB.png)
![MPR](https://sight.pages.ircad.fr/sight-doc/_images/MPR.png)
![3D](https://sight.pages.ircad.fr/sight-doc/_images/3D.png)
40

41
### ARCalibration
42

43
44
45
46
47
**ARCalibration** is a user-friendly application to calibrate mono and stereo cameras. This software is a must-have since camera calibration is a mandatory step in any AR application.

![ARCalibration](https://sight.pages.ircad.fr/sight-doc/_images/calibration.png)
![ARCalibration](https://sight.pages.ircad.fr/sight-doc/_images/calibrationExt.png)

48
## Install
49
50

See [detailed install instructions](https://sight.pages.ircad.fr/sight-doc/Installation/index.html) for each supported platforms :
51

52
53
54
55
* [Windows](https://sight.pages.ircad.fr/sight-doc/Installation/src/WindowsInstall.html)
* [Linux](https://sight.pages.ircad.fr/sight-doc/Installation/src/LinuxInstall.html)
* [MacOs](https://sight.pages.ircad.fr/sight-doc/Installation/src/MacOSXInstall.html)

56
## Documentation
57
58
59
60
61
62

* [Documentation](https://sight.pages.ircad.fr/sight-doc)
* [Tutorials](https://sight.pages.ircad.fr/sight-doc/Tutorials/index.html)
* [Doxygen](https://sight.pages.ircad.fr/sight)
* Former FW4SPL [Blog](http://fw4spl-org.github.io/fw4spl-blog/) (new website coming soon)

63
## Support
64
65
66

Please note that our GitLab is currently only available in read-only access
for external developers and users. This is a restriction because of the licensing
67
model of GitLab. Since we use an EE version, we would be forced to pay for every
68
69
70
71
72
73
74
75
76
community user, and unfortunately we cannot afford it. This licensing
model might change in the
future https://gitlab.com/gitlab-org/gitlab-ee/issues/4382 though.

Until then, we gently ask our community users to use our GitHub mirror to [report any issues](https://github.com/IRCAD-IHU/sight/issues)
or propose [contributions](https://github.com/IRCAD-IHU/sight/pulls).

You can also get live community support on the [gitter chat room](https://gitter.im/IRCAD-IHU/sight-support).

77
## Annex
78

79
80
* [Artifactory](https://conan.ircad.fr): registry containing the external binary dependencies required by **Sight**.
* [Conan](https://git.ircad.fr/conan): repositories used to generate conan packages used by **Sight** (Boost, VTK, ITK, Qt, ...).