From 855e8c287b54429ee04ceca4288bd85e06583169 Mon Sep 17 00:00:00 2001 From: kieftrav Date: Tue, 6 Aug 2024 08:45:36 -0500 Subject: [PATCH] ADR 60: Volumetric Viewer --- docs/arch/adr-60.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/arch/adr-60.md diff --git a/docs/arch/adr-60.md b/docs/arch/adr-60.md new file mode 100644 index 0000000000..917fa798e1 --- /dev/null +++ b/docs/arch/adr-60.md @@ -0,0 +1,32 @@ +# ADR 60: Volumetric Viewer + +## Status + +Proposed: 2024-08-06 + +## Context + +As part of an NIH grant, there is a need for a 3D viewer and annotation tools for FEM. Specifically, there is a need to visualize a "cube" of data and explore it volumetrically. Additionally, as part a follow up ADR, a method to generate and efficiently store the annotations to the data is needed. A prototype of the viewer - [VolumetricViewer](https://github.com/zooniverse/volumetric-viewer) - has been developed and released for alpha testing, with the feedback being compiled into the below recommendation. + +## Decision + +The Volumetric Viewer is a separate viewer than all the other viewers because of how it handles 3D data. The concept of pan, zoom, rotate, and annotation models take on a different level of complexity within a 3D context, therefore the viewer should be separate with tailored controls for the 3D context. + +## Features + +Features of the FEM Volumetric Viewer will include: +1. Configuration of Volumetric Viewer for 3D volumetric and/or 2D planar view choice +1. Mouse and/or Keyboard interactions for navigating the volumetric data in both 2D & 3D +1. Mouse and/or Keyboard interactions for annotating the volumetric data in both 2D & 3D +1. Hiding of the ImageToolbar component (pan, zoom, rotate, invert, etc) + +### Viewer Configuration + +```js +{ + enable2D: , + frame: [, , ] + threshold: , + tool: 'point-volumetric' +} +```