Skip to content

Commit 62b850d

Browse files
Merge branch 'fix-mesh-visibility-FE-api' of github.com:scalableminds/webknossos into fix-mesh-visibility-FE-api
2 parents 78c059f + 5379e26 commit 62b850d

File tree

10 files changed

+21
-19
lines changed

10 files changed

+21
-19
lines changed

docs/proofreading/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ WEBKNOSSOS offers several ways for proofreading large-scale, volumetric segmenta
44

55
There are three proofreading workflows supported by WEBKNOSSOS:
66

7-
1. The [Proofreading tool](proofreading_tool.md) to correct split and merge errors in large segmentations based on an underlying super-voxel graph. To use the proofreading tool, you need a [segmentation mapping](segmentation_mappings.md).
7+
1. The [Proofreading tool](proofreading_tool.md) to correct split and merge errors in large segmentations based on an underlying supervoxel graph. To use the proofreading tool, you need a [segmentation mapping](segmentation_mappings.md).
88
2. The [Merger-Mode tool](merger_mode.md) which allows merging of segments by constructing a lightweight skeleton-based mapping.
9-
3. Voxel-based relabeling of segments. Segments can be merged using the fill tool. To split segments there is a dedicated [Split Segments toolkit](split_segments_toolkit.md).
9+
3. Voxel-based relabeling of segments. Segments can be merged using the fill tool. To split segments there is a dedicated [Split Segments toolkit](split_segments_toolkit.md).
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Proofreading Tool
22

3-
The proofreading tool enables users to fix merge and split errors in a segmentation generated from an automated workflow (outside of WEBKNOSSOS), e.g. from a machine learning system such as [Voxelytics](https://voxelytics.com). Split and merge operations are directly executed on the underlying [super-voxel graph structure](../terminology.md#agglomerates) of a segmentation.
3+
The proofreading tool enables users to fix merge and split errors in a segmentation generated from an automated workflow (outside of WEBKNOSSOS), e.g. from a machine learning system such as [Voxelytics](https://voxelytics.com). Split and merge operations are directly executed on the underlying [supervoxel graph structure](../terminology.md#agglomerates) of a segmentation.
44

55
Watch this video to get started with the proofreading tools:
66
![youtube-video](https://www.youtube.com/embed/h_paTLAIIwY)
77

8-
To use the proofreading tool you need to enable an [ID mapping for your segmentation](./segmentation_mappings.md) to load the super-voxel graph. Once, WEBKNOSSOS detects this the proofreading tool can be activated on the toolbar (clipboard icon):
8+
To use the proofreading tool you need to enable an [ID mapping for your segmentation](./segmentation_mappings.md) to load the supervoxel graph. Once, WEBKNOSSOS detects this the proofreading tool can be activated on the toolbar (clipboard icon):
99

1010
1. Select an ID mapping for a segmentation layer from the left-hand side panel
1111
2. From the toolbar, switch to the proofreading tool (clipboard icon)
12-
3. [Optional] Shift + middle-click on any segment to load and display its super-voxel graph
12+
3. [Optional] Shift + middle-click on any segment to load and display its supervoxel graph
1313
4. Proceed to fix split and merge errors:
1414

1515
## Fixing Split Errors
@@ -22,14 +22,14 @@ To use the proofreading tool you need to enable an [ID mapping for your segmenta
2222

2323
1. Left-click on any part of the source segment. It will be marked with a white crosshair
2424
2. Right-click on the part of the source segment that you would like to split off to bring up the context menu. Select `Split from active segment (Min-Cut)`
25-
3. WEBKNOSSOS will perform a min-cut operation to delete all super-voxel graph edges between the source and target segments, effectively splitting the two into individual segments
25+
3. WEBKNOSSOS will perform a min-cut operation to delete all supervoxel graph edges between the source and target segments, effectively splitting the two into individual segments
2626
4. WEBKNOSSOS will split both segments and reload the updated segmentation and 3D meshes
2727

2828
Note, the proofreading operations rely directly on the information and quality of an initial over-segmentation. If cells/segments are already erroneously connected in this state, then WEBKNOSSOS cannot split them apart (this might change in the future, though).
2929

3030
If case you want to reload, hide or remove a 3D mesh during proofreading, you can use the context menu in the 3D viewport by hovering the mesh. You can enable and disable the automatic mesh loading by toggling the respective button in the toolbar, right of the proofreading tool button.
3131

32-
In addition to the handy shortcuts available from the right-click context menu, users can also directly modify the super-voxel graph like any other skeleton to manually add/remove nodes and edges for fine-grained control.
32+
In addition to the handy shortcuts available from the right-click context menu, users can also directly modify the supervoxel graph like any other skeleton to manually add/remove nodes and edges for fine-grained control.
3333

3434
!!!info
35-
The proofreading tool requires a super-voxel graph representation of a segmentation to work. At this time, these can only be obtained from the [Voxelytics AI segmentation pipeline](https://voxelytics.com). We are actively working to make this available for more users, so please reach out to us to get you started and provide feedback: [hello@webknossos.org](mailto:hello@webknossos.org)
35+
The proofreading tool requires a supervoxel graph representation of a segmentation to work. At this time, these can only be obtained from the [Voxelytics AI segmentation pipeline](https://voxelytics.com). We are actively working to make this available for more users, so please reach out to us to get you started and provide feedback: [hello@webknossos.org](mailto:hello@webknossos.org)

docs/terminology.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,4 @@ Typically, many segments make up a segmentation. Segments can be painted manuall
4646

4747
## Agglomerates
4848
An agglomerate is the combination of several (smaller) segments to reconstruct a larger biological structure. Typically an agglomerate combines the fragments of an over-segmentation created by some automated method, e.g. a machine learning system.
49-
Sometimes this is also referred to as a super-voxel graph.
49+
Sometimes this is also referred to as a supervoxel graph.

docs/volume_annotation/tools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Volume annotation in WEBKNOSSOS allows you to label and segment 3D structures in
3535
The AI mode works across various imaging modalities and can significantly speed up annotation workflows. See the [Quick-select tool](#quick-select-tool) section for detailed usage.
3636

3737
![Proofreading Tool](../ui/images/proofreading-tool.jpg){align=left width="60"}
38-
**Proofreading**: Fix merge and split errors in automated segmentations using the underlying super-voxel graph by combining and breaking apart segments. Read more about [proofreading](../proofreading/proofreading_tool.md).
38+
**Proofreading**: Fix merge and split errors in automated segmentations using the underlying supervoxel graph by combining and breaking apart segments. Read more about [proofreading](../proofreading/proofreading_tool.md).
3939

4040

4141
In the [Segments tab](./segments_list.md) on the right-hand side panel, you can find all segment IDs which are available in your annotation. You can rename and organize segments as needed.

frontend/javascripts/viewer/controller/combinations/tool_controls.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1131,9 +1131,9 @@ export class ProofreadToolController {
11311131
if (isTDViewportActive) {
11321132
let maybeLeftClick: Partial<ActionDescriptor> = {};
11331133
if (shiftKey) {
1134-
maybeLeftClick.leftClick = "Jump to point";
1134+
maybeLeftClick.leftClick = "Jump to Point";
11351135
} else if (ctrlOrMetaKey) {
1136-
maybeLeftClick.leftClick = "Activate super-voxel";
1136+
maybeLeftClick.leftClick = "Activate Supervoxel";
11371137
}
11381138

11391139
return {

frontend/javascripts/viewer/model/sagas/volume/proofread_saga.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1628,7 +1628,7 @@ function* gatherInfoForOperation(
16281628
// The action was triggered via a data viewport (not 3D). In this case,
16291629
// the active segment's position can be used as a source.
16301630
if (activeUnmappedSegmentId != null) {
1631-
// The user has selected a super-voxel in the 3D viewport and then clicked
1631+
// The user has selected a supervoxel in the 3D viewport and then clicked
16321632
// in a data viewport to select the second merge partner. However, this mix
16331633
// is currently not supported.
16341634
Toast.warning(MISSING_INFORMATION_WARNING);
@@ -1655,7 +1655,7 @@ function* gatherInfoForOperation(
16551655

16561656
// The action was triggered in the 3D viewport. In this case, we don't have
16571657
// a mouse position and also the active segment position isn't necessarily
1658-
// a position of the clicked super-voxel.
1658+
// a position of the clicked supervoxel.
16591659
if (
16601660
action.agglomerateId == null ||
16611661
activeCellId == null ||
@@ -1687,7 +1687,7 @@ function* gatherInfoForOperation(
16871687
} else {
16881688
// When splitting two segments, we don't really have reliable positions at hand.
16891689
// For the source position, we cannot rely on the active segment position, because
1690-
// the active super-voxel doesn't necessarily match the last click position within
1690+
// the active supervoxel doesn't necessarily match the last click position within
16911691
// the data viewports.
16921692
// For the target position, we also don't have reliable information available.
16931693
[sourcePosition, targetPosition] = yield* all([

frontend/javascripts/viewer/shaders/segmentation.glsl.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -472,7 +472,7 @@ export const getSegmentationAlphaIncrement: ShaderModule = {
472472
if (isProofreading) {
473473
if (isActiveCell) {
474474
return (isHoveredUnmappedSegment
475-
? 0.4 // Highlight the hovered super-voxel of the active segment
475+
? 0.4 // Highlight the hovered supervoxel of the active segment
476476
: (isHoveredSegment
477477
? 0.15 // Highlight the not-hovered super-voxels of the hovered segment
478478
: 0.0

frontend/javascripts/viewer/view/context_menu.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,7 @@ function getMeshItems(
512512
? `within Segment ${clickedMeshId}`
513513
: clickedMeshId;
514514
const segmentOrSuperVoxel =
515-
isProofreadingActive && maybeUnmappedSegmentId != null ? "Super-Voxel" : "Segment";
515+
isProofreadingActive && maybeUnmappedSegmentId != null ? "Supervoxel" : "Segment";
516516

517517
const proofreadingMultiSplitToolActions =
518518
isProofreadingActive && isMultiSplitActive && minCutPartitions && maybeUnmappedSegmentId != null
@@ -1040,7 +1040,7 @@ function getNoNodeContextMenuOptions(props: NoNodeContextMenuProps): ItemType[]
10401040
? `within Segment ${maybeUnmappedSegmentId}`
10411041
: segmentIdAtPosition;
10421042
const segmentOrSuperVoxel =
1043-
isProofreadingActive && maybeUnmappedSegmentId != null ? "Super-Voxel" : "Segment";
1043+
isProofreadingActive && maybeUnmappedSegmentId != null ? "Supervoxel" : "Segment";
10441044
Store.dispatch(maybeFetchMeshFilesAction(visibleSegmentationLayer, dataset, false));
10451045

10461046
const loadPrecomputedMesh = async () => {

frontend/javascripts/viewer/view/plane_view.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ class PlaneView {
345345
return null;
346346
}
347347
// If the proofreading tool is not active, pretend that
348-
// activeUnmappedSegmentId is null so that no super-voxel
348+
// activeUnmappedSegmentId is null so that no supervoxel
349349
// is highlighted.
350350
return storeState.uiInformation.activeTool === AnnotationTool.PROOFREAD
351351
? segmentationTracing.activeUnmappedSegmentId

unreleased_changes/8952.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
### Fixed
2+
- Fixed spelling of super-voxel to supervoxel.

0 commit comments

Comments
 (0)