Skip to content

Commit 4c43e78

Browse files
committed
Documentation Updates
- New URLs for ChengLabResearch - Backprojection changes in v1.1
1 parent e3db3a0 commit 4c43e78

File tree

4 files changed

+18
-19
lines changed

4 files changed

+18
-19
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ Quickly extract ROIs from cloud-hosted medical scans.
66

77
This repository is a monorepo containing the code for the Ouroboros app and the Ouroboros Python package (`python` folder).
88

9-
For a **usage guide**, check out the [Documentation](https://wegold.me/ouroboros/).
9+
For a **usage guide**, check out the [Documentation](https://chenglabresearch.github.io/ouroboros/).
1010

1111
# Quick Start
1212

1313
**[Docker](https://www.docker.com/products/docker-desktop/) is REQUIRED to run Ouroboros.**
1414

15-
There are prebuilt applications available in [Releases](https://github.com/We-Gold/ouroboros/releases).
15+
There are prebuilt applications available in [Releases](https://github.com/ChengLabResearch/ouroboros/releases).
1616

1717
- Windows: `*-setup.exe`
1818
- Mac: `*.dmg`
@@ -52,7 +52,7 @@ _Where are plugins installed? In the [appData](https://github.com/electron/elect
5252

5353
### Creating a Plugin
5454

55-
See the [template README](https://github.com/We-Gold/ouroboros/blob/main/plugins/plugin-template/README.md) for more information.
55+
See the [template README](https://github.com/ChengLabResearch/ouroboros/blob/main/plugins/plugin-template/README.md) for more information.
5656

5757
# Development Quick Start
5858

documentation/docs/guide/backproject.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,12 @@ A large amount of helpful data is saved in `*-configuration.json` file after the
5353

5454
**Trilinear Interpolation**
5555

56-
The straightened volume slices are loaded in as a memmap (an in-memory reference to the tiff image on the hard-drive or SSD).
56+
Backprojection iterates through 3D chunks of the straightened volume, as follows following order:
5757

58-
Then, an empty volume is created with the same dimensions as the bounding box. A custom trilinear interpolation implementation is used to copy the slice data into the empty volume.
59-
60-
These volumes are saved to local tiff images. After all volumes have been calculated, Ouroboros creates chunks of an empty volume (same size as the original volume) and copies the data from the smaller volumes into the chunk, and then saves that chunk as a tiff with compression.
61-
62-
Finally, all chunks are combined to produce either a minimum bounding box in the space of the original volume with all of the backprojected data, or a full-size volume with the backprojected data.
58+
1. The slices are loaded from a memmory map of the straightened volume.
59+
2. A custom rapid trilinear interpolation implementation is used to map the slice data into a sparse representation of the backprojected volume, limited to a bounding box containing only points associated with the chunk.
60+
3. As slices are completed, they are written to an uncompressed memory map of the final volume.
61+
4. Once all slices are completed, the final volume is compressed as either a single image or tiff stack.
6362

6463
**Why Is Interpolation Needed?**
6564

documentation/docs/guide/plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ _Where are plugins installed? In the [appData](https://github.com/electron/elect
2424

2525
### Creating a Plugin
2626

27-
See the [template README](https://github.com/We-Gold/ouroboros/blob/main/plugins/plugin-template/README.md) for more information.
27+
See the [template README](https://github.com/ChengLabResearch/ouroboros/blob/main/plugins/plugin-template/README.md) for more information.

documentation/mkdocs.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
site_name: Ouroboros Documentation
22
site_description: Quickly extract long ROIs (e.g. blood vessels, nerves) from cloud-hosted medical scans.
33
site_url: https://wegold.me/ouroboros
4-
copyright: Copyright 2024 Weaver Goldman, All rights reserved
5-
site_author: Weaver Goldman
4+
copyright: Copyright 2024=2025 Weaver Goldman and David Northover, All rights reserved
5+
site_author: Weaver Goldman and David Northover
66

77
nav:
88
- Home: 'index.md'
@@ -12,11 +12,11 @@ nav:
1212
- Backprojection: 'guide/backproject.md'
1313
- Plugins: 'guide/plugins.md'
1414
- Development:
15-
- App: https://github.com/We-Gold/ouroboros/blob/main/README.md
16-
- Python: https://github.com/We-Gold/ouroboros/blob/main/python/README.md
17-
- Plugins: https://github.com/We-Gold/ouroboros/blob/main/plugins/plugin-template/README.md
18-
- Releases: 'https://github.com/We-Gold/ouroboros/releases'
19-
- Repository: https://github.com/We-Gold/ouroboros
15+
- App: https://github.com/ChengLabResearch/ouroboros/blob/main/README.md
16+
- Python: https://github.com/ChengLabResearch/ouroboros/blob/main/python/README.md
17+
- Plugins: https://github.com/ChengLabResearch/ouroboros/blob/main/plugins/plugin-template/README.md
18+
- Releases: 'https://github.com/ChengLabResearch/ouroboros/releases'
19+
- Repository: https://github.com/ChengLabResearch/ouroboros
2020

2121
theme:
2222
name: terminal
@@ -26,5 +26,5 @@ theme:
2626
features:
2727
- footer.prev_next
2828

29-
repo_name: We-Gold/ouroboros
30-
repo_url: https://github.com/We-Gold/ouroboros
29+
repo_name: ChengLabResearch/ouroboros
30+
repo_url: https://github.com/ChengLabResearch/ouroboros

0 commit comments

Comments
 (0)