Shortcuts module
Functions for reducing boiler plate code such as display2D and display3D.
Classes
- struct fast::Display2DArgs
- Arguments for display2D function.
- struct fast::Display3DArgs
- Arguments for display3D function.
Enums
- enum class DisplayType { SLICER = 1, ALPHA_BLENDING = 2, MAXIMUM_INTENSITY_PROJECTION = 3 }
- Enum to choose how to display 3D data in display3D.
Functions
Enum documentation
enum class DisplayType
#include <FAST/Visualization/Shortcuts.hpp>
Enum to choose how to display 3D data in display3D.
| Enumerators | |
|---|---|
| SLICER |
Display 3D image and segmentation using SlicerWindow. |
| ALPHA_BLENDING |
Display 3D image using AlphaBlendingVolumeRenderer. |
| MAXIMUM_INTENSITY_PROJECTION |
Display 3D image using MaximumIntensityProjection. |
Function documentation
std::variant<std::monostate, Window::pointer, Image::pointer> display2D(Display2DArgs args)
#include <FAST/Visualization/Shortcuts.hpp>
A function for displaying data in 2D.
| Parameters | |
|---|---|
| args | See the Display2DArgs struct |
| Returns | A variant which is either empty, Window or Image depending on the choice of Display2DArgs.returnWindow and Display2DArgs.renderToImage |
Use this to reduce boiler plate code when displaying data in 2D.
std::variant<std::monostate, Window::pointer> display3D(Display3DArgs args)
#include <FAST/Visualization/Shortcuts.hpp>
A function for displaying data in 3D.
| Parameters | |
|---|---|
| args | See the Display3DArgs struct |
| Returns | A variant which is either empty or a Window depending on whether Display3DArgs.returnWindow is set to true or not. |
Use this to reduce boiler plate code when displaying data in 3D.
TODO:
- Geometry support
- renderToImage