Skip to content
valettePublic

About

HTML front-end for DESK

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Repository files navigation

DESK-UI

License: CeCILL-B Node: >=8.0.0 Qooxdoo: 7.9 Three.js: r183

DESK (Desktop Environment for Scientific Knowledge) is a high-performance web front-end and remote desktop designed for interactive 3D visualization and processing of scientific and medical imaging data (CT, MRI, NIfTI, DICOM, MetaImage, and 3D polygonal surface meshes).

desk-ui provides the client-side user interface, rendering engine, and RPC action pipeline built on top of Qooxdoo and Three.js.


📖 Table of Contents


🌐 Live Demo & Project Links


🏛 Architecture & Overview

desk-ui bridges rich browser-based WebGL visualizers with backend scientific computation:

  1. RPC Actions Framework (desk.Actions): Command-line utilities on the server are exposed as JSON-defined "actions". The front-end triggers jobs, tracks progress, streams stdout/stderr logs, and caches deterministic results.
  2. Virtual File System (desk.FileSystem): Client-side abstraction for remote file queries, reading, writing, script execution, and workspace exploration over WebSocket/REST.
  3. Multi-Planar Reconstruction (desk.MPR.*): Interactive 3-plane orthogonal slicing (Axial, Coronal, Sagittal) and 3D surface rendering powered by Web Workers.
  4. WebGL 3D Rendering (desk.THREE.*): Hardware-accelerated rendering for meshes (VTK, OpenCTM, STL, PLY, OBJ, XYZ) with trackball controls, point picking, clipping planes, and cross-viewer camera synchronization.
  5. Integrated Developer Tools: Multi-tab code editor with syntax highlighting (desk.Ace.*), interactive shell terminals (desk.Xterm.*), and virtual file explorer (desk.FileBrowser).

🚀 Key Features

  • Medical Volume Visualization: High-speed slicing and rendering of NIfTI (.nii, .nii.gz), MetaImage (.mhd, .mha), DICOM (.dcm), and raw 3D/4D volumes.
  • Interactive Segmentation Tools (desk.MPR.SegTools): Multi-label 2D seed drawing, graph-cut segmentation algorithms, region growing, and mask-to-mesh conversion.
  • Synchronized Viewers (desk.LinkMixin): Link rotation, zoom, crosshair positions, and clipping planes across multiple 2D and 3D viewers simultaneously.
  • Offline / Static Web Export ("Statifier"): Pre-compute action outputs and file queries into cache/responses.json to publish zero-backend static web demonstrations.
  • Asynchronous Execution: Native async/await support across all file system operations and RPC tasks via desk.core.AddPromises.

📚 Documentation & AI Coding Guides

Document Description
🏗️ docs/ARCHITECTURE.md Deep architectural blueprint, component design, data flow diagrams, and memory management rules.
📑 docs/API.md Exhaustive API reference for all classes, singletons, mixins, properties, methods, and events.
🤖 LLM_GUIDE.md Crucial guidelines, Qooxdoo syntax patterns, and common pitfalls for LLM Coding Agents (Claude, Gemini, Cursor, Copilot).
⚡ AGENTS.md Compact agent prompt instructions (symlinked to CLAUDE.md).

🖥️ Backend Hosts

This repository contains the front-end user interface. To run with a live backend, pair with one of the following:

  • Web Server Hosting: desk (Node.js backend with Socket.IO)
  • Local Desktop App (Electron): desk-electron
  • Local Desktop App (NW.js): desk-nw

📦 Quick Start & Build Instructions

Prerequisites

  • Node.js (>= 8.0.0, recommended LTS 18+)
  • npm
  • git

Installation

git clone https://github.com/valette/desk-ui.git
cd desk-ui
npm install

Building

# Full clean production build:
npm run buildClean

# Or standard build:
npm run build

🛠 Development Workflow

# 1. Start Qooxdoo compiler in watch mode (recompiles on source changes):
npm run dev

# 2. Recompile source target once:
npx qx compile --target source

# 3. Compile interactive Qooxdoo API viewer:
npx qx compile --app-name=apiviewer

# 4. Rebuild Web Workers (SlicerWorker, CTMWorkerBundle):
npm run buildWorkers

# 5. Fix/copy bundled third-party CSS assets:
npm run fixCss

📄 Citation & License

Academic Citation

If you use DESK or desk-ui in academic work, please cite:

H. Jacinto, R. Kéchichan, M. Desvignes, R. Prost, and S. Valette, "A Web Interface for 3D Visualization and Interactive Segmentation of Medical Images", 17th International Conference on 3D Web Technology (Web 3D 2012), Los Angeles, USA, pp. 51-58, 2012. [HAL Open Access PDF]

License

Released under the CeCILL-B License (BSD-compatible). Copyright (c) CNRS, INSA-Lyon, UCBL, INSERM.

About

HTML front-end for DESK

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages