Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
smistad committed Dec 9, 2022
1 parent 79871ff commit 0c85c28
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 3 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions doc/mainpage.dox
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
[![Pip Downloads](https://img.shields.io/pypi/dm/pyfast?label=pip%20downloads&logo=python)](download-stats.html)
[![](https://img.shields.io/github/license/smistad/FAST)](https://github.com/smistad/FAST/blob/master/LICENSE)

FAST is an open-source cross-platform framework with the main goal of making it easier to do high-performance processing and visualization of medical images on heterogeneous systems utilizing both multi-core CPUs and GPUs. To achieve this, FAST use modern C++, OpenCL and OpenGL.
FAST is an open-source framework with the main goal of making it easier to do high-performance processing, neural network inference, and visualization of medical images utilizing multi-core CPUs and GPUs. To achieve this, FAST use modern C++, OpenCL and OpenGL, and neural network inference libraries such as TensorRT, OpenVINO, TensorFlow and ONNX Runtime.

@section get-started Get started
See installation instructions for [Windows](@ref install-windows), [Ubuntu Linux](@ref install-ubuntu-linux) and [macOS](@ref install-mac).
Expand All @@ -23,7 +23,7 @@ Need help? Use the gitter chat: [![Join the chat on Gitter](https://img.shields.
@section features Main features

- **Data streaming** – Processing pipelines in FAST can handle both static and dynamic/temporal data without any change to the code. FAST can stream data from movie files, your webcamera, an Intel RealSense camera, a sequence of images and even directly from ultrasound scanners such as Clarius.
- **Deep learning** – FAST provides a common interface for neural networks supporting different model formats (ONNX, protobuf, SavedModel, OpenVINO, UFF) and backends (Google TensorFlow, NVIDIA TensorRT, Intel OpenVINO), making it possible to create real-time neural network pipelines.
- **Deep learning** – FAST provides a common interface for neural networks supporting different model formats (ONNX, protobuf, SavedModel, OpenVINO, UFF) and backends (Google TensorFlow, NVIDIA TensorRT, Intel OpenVINO, Microsoft ONNX Runtime), making it possible to create real-time neural network pipelines.
- **High-level data management** – Data objects in FAST represent data, such as an image, on all processors. FAST keeps data coherent across the different storage areas thereby removing the burden of explicit memory handling from the developer.
- **Wide data format support** - FAST supports several data formats (DICOM, metaimage (MHD), regular jpg/png/bmp images, videos, HDF5, VTK polydata, whole slide images, ultrasound file format) and data types (images 2D and 3D, grayscale and color, image pyramids, surface mesh, vertices, lines, text ++).
- **High performance algorithms** – FAST has several high performance parallel OpenCL implementations of common algorithms, such as marching cubes surface extraction, Gaussian smoothing, non-local means, block matching tracking and seeded region growing.
Expand Down
1 change: 1 addition & 0 deletions doc/pages/Download-stats.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Download Statistics {#download-stats}
GitHub Downloads
--------------------

* ![](https://shields.io/github/downloads/smistad/fast/v4.6.0/total)
* ![](https://shields.io/github/downloads/smistad/fast/v4.5.0/total)
* ![](https://shields.io/github/downloads/smistad/fast/v4.4.0/total)
* ![](https://shields.io/github/downloads/smistad/fast/v4.3.0/total)
Expand Down
2 changes: 2 additions & 0 deletions doc/pages/Python-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ All the Python examples can be found in the [repository](https://github.com/smis
|[Stream images from Clarius ultrasound scanner and apply a non-local means (NLM) filter](@ref stream_from_clarius_ultrasound_scanner.py)| @image html images/examples/python/clarius_streaming.jpg width=350px; |
|[Extract surface mesh from CT volume and render using GPU-based Marching Cubes algorithm](@ref extract_surface_mesh.py)| @image html images/examples/python/extract_surface_and_render.jpg width=350px; |
|[Inject Python code into a FAST pipeline by creating a custom Python process object](@ref python_process_object.py)| @image html images/examples/python/python_process_object.jpg width=350px; |
|[Create a custom data streamer in Python](@ref python_streamer.py)| @image html images/examples/python/left_ventricle.jpg width=350px; |
|[Create a custom random access streamer with playback GUI in Python](@ref python_random_access_streamer.py)| @image html images/examples/python/python_random_access_streamer.jpg width=350px; |
|[Creating a Qt GUI with PySide2 along FAST](@ref pyfast_and_pyside2.py)| @image html images/examples/python/pyfast_and_pyside.jpg width=350px; |
|[Using FAST in an existing PySide2 application](@ref pyfast_and_pyside2_custom_window.py)| @image html images/examples/python/pyfast_and_pyside_custom_window.jpg width=350px; |
|[Real-time line plotting](@ref real_time_line_plotter.py)| @image html images/examples/python/real_time_line_plotter.jpg width=350px; |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@
labelColors={1: fast.Color.Red(), 2: fast.Color.Blue()},
).connect(segmentationNetwork)

widget = fast.PlaybackWidget(streamer)

window = fast.SimpleWindow2D.create(bgcolor=fast.Color.Black())\
.connect([imageRenderer, segmentationRenderer, labelRenderer])\
.connect(widget)\
.run()
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# This can for instance be streaming data from an ultrasound scanner in real-time or from disk.
# A random access streamer can move to any given frame index at any time, thus enabling
# controllable playback with for instance the PlaybackWidget as shown in this example.
# @image html images/examples/python/python_process_object.jpg width=400px;
# @image html images/examples/python/python_random_access_streamer.jpg width=400px;
import fast
import os
import numpy as np
Expand Down

0 comments on commit 0c85c28

Please sign in to comment.