Skip to content

Commit dfe49be

Browse files
committed
Updated default config, manual, and website. Increased version number to 1.0.2
1 parent 2b23e4f commit dfe49be

9 files changed

Lines changed: 88 additions & 64 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ For help with DNA2Graph, contact the project maintainer at [federico.chinello@st
8080
## Citation
8181

8282
```text
83-
F. Chinello, E. Zanella, M. Giannattasio, F. M. Buffa, and Y. Doksani.
83+
F. Chinello, M. Giannattasio, E. Zanella, F. Bruno, F. M. Buffa, and Y. Doksani.F
8484
DNA2Graph [Computer software]. Zenodo, 2026.
8585
https://doi.org/10.5281/zenodo.20413553
8686
```

dna2graph/assets/defaults.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
"batch_size": 32,
3030
"min_cycle_length": 100,
3131
"min_branch_length": 150,
32-
"max_thickness": 6,
32+
"max_thickness": 20,
3333
"structurality_depth_cutoff": 50,
3434
"repair_1_min_graph_distance": 200,
3535
"repair_1_max_euclidean_distance": 20,

manual/manual.tex

Lines changed: 57 additions & 28 deletions
Large diffs are not rendered by default.

manual/tables/correction_pipeline.tex

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@
55
\hline
66
\textbf{Step} & \textbf{Purpose} \\
77
\hline
8-
Mask-to-Graph Conversion & Convert each segmented DNA molecule in the mask into a spatial graph representation, where nodes correspond to pixels along the molecule with their (x, y) coordinates, and edges encode connectivity. \\
8+
Mask-to-Graph Conversion & Converts each segmented DNA molecule in the mask into a spatial graph representation, where nodes correspond to pixels along the molecule with their $(x, y)$ coordinates, and edges encode connectivity. \\
99
\hline
10-
Repair Connectivity (1) & Operate on spatial graph representations to address fragmentation caused by segmentation errors in thin DNA structures, by selectively adding edges between relevant node pairs to restore connectivity. \\
10+
Repair Connectivity (I) & Operates on spatial graph representations to address fragmentation caused by segmentation errors or signal dropout in thin DNA structures, by adding edges between relevant node pairs to restore connectivity. \\
1111
\hline
12-
Prune Short Cycles & Operate on spatial graph representations to remove spurious short cycles, using a predefined cycle-length threshold. \\
12+
Prune Short Cycles & Operates on spatial graph representations to remove spurious short cycles, using a predefined cycle-length threshold. \\
1313
\hline
14-
Prune Short Branches & Operate on spatial graph representations to remove spurious short branches, using a predefined branch-length threshold. \\
14+
Prune Short Branches & Operates on spatial graph representations to remove spurious short branches, using a predefined branch-length threshold. \\
1515
\hline
16-
Prune by Thinkness & Clean the spatial graph representations by removing nodes associated with abnormally thick regions, leveraging the prior that DNA structures are thin and thicker regions are typically spurious. \\
16+
Prune by Thinkness & Cleans the spatial graph representations by removing nodes associated with abnormally thick regions, leveraging the prior that DNA structures are thin and thicker regions are typically spurious. \\
1717
\hline
18-
Repair Connectivity (2) & Further refine spatial graph representations by performing a second connectivity repair step, using different parameters from the first repair stage. \\
18+
Prune Small Components & Discards small spatial graph representations that are likely spurious. \\
1919
\hline
20-
Prune Small Components & Discard small spatial graph representations that are likely spurious. \\
20+
Repair Connectivity (II) & Further refines spatial graph representations by performing a second connectivity repair step, using different parameters from the first repair stage. \\
2121
\hline
22-
Graph-to-Mask Conversion & Convert the refined spatial graph representations back into mask form for downstream analysis or visualization. \\
22+
Graph-to-Mask Conversion & Converts the refined spatial graph representations back into mask form. \\
2323
\hline
2424
\end{tabular}
2525
\label{tab:correction_pipeline}

manual/tables/segmentation_pipeline.tex

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@
55
\hline
66
\textbf{Step} & \textbf{Purpose} \\
77
\hline
8-
Validity mask computation & Compute a binary mask that identifies valid regions of the image, used throughout the pipeline to exclude corrupted or irrelevant areas and prevent them from influencing segmentation. \\
8+
Validity mask computation & Computes a binary mask that identifies valid regions of the image, used throughout the pipeline to exclude corrupted or irrelevant areas and prevent them from influencing segmentation. \\
99
\hline
10-
Preprocessing & Enhance contrast and standardize intensity distributions to reduce inter-image variability; convert 16-bit images to 8-bit and invert intensities so DNA molecules exhibit higher grayscale values than the background. \\
10+
Preprocessing & Enhances contrast and standardizes intensity distributions to reduce inter-image variability; converts 16-bit images to 8-bit and inverts intensities so DNA molecules exhibit higher grayscale values than the background. \\
1111
\hline
12-
Bilateral Filter & Reduce background noise while preserving edge information, ensuring that thin DNA molecules remain well-defined for subsequent processing. \\
12+
Bilateral Filter & Reduces background noise while preserving edge information, ensuring that thin DNA molecules remain well-defined for subsequent processing. \\
1313
\hline
14-
Unsharp Masking & Enhance edges and local contrast to better highlight DNA structures against the background. \\
14+
Unsharp Masking & Enhances edges and local contrast to better highlight DNA structures against the background. \\
1515
\hline
16-
Hysteresis Thresholding & Generate a binary segmentation by separating DNA molecules from the background. \\
16+
Hysteresis Thresholding & Generates a binary segmentation by separating DNA molecules from the background. \\
1717
\hline
18-
Area-based Pruning (1) & Remove small, spurious segmented regions based on a predefined area threshold. \\
18+
Area-based Pruning (I) & Removes small, spurious segmented regions based on a predefined area threshold. \\
1919
\hline
20-
Morphological Closing & Fill small gaps and discontinuities between segmented regions to improve the structural continuity of DNA molecules. \\
20+
Morphological Closing & Fills small gaps and discontinuities between segmented regions to improve the structural continuity of DNA molecules. \\
2121
\hline
22-
Area-based Pruning (2) & Remove small, spurious segmented regions based on a predefined area threshold, which can differ from the one used in the first pruning stage. \\
22+
Area-based Pruning (II) & Removes small, spurious segmented regions based on a predefined area threshold, which can differ from the one used in the first pruning stage. \\
2323
\hline
2424
\end{tabular}
2525
\label{tab:segmentation_pipeline}

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "dna2graph"
7-
version = "1.0.1"
7+
version = "1.0.2"
88
description = """Imaging software that automates the segmentation and analysis of DNA molecules in electron microscopy images (CLI + GUI)."""
99
authors = [
1010
{ name = "Federico Chinello", email = "federico.chinello@studbocconi.it" }

website/download.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,12 @@ <h2>Installation</h2>
4646

4747
<p>
4848
This command installs the complete DNA2Graph application, including both
49-
the graphical interface and the command-line interface.
49+
the graphical user interface and the command-line interface.
5050
</p>
5151
</section>
5252

5353
<section>
54-
<h2>Launching the Graphical Interface</h2>
54+
<h2>Launching the Graphical User Interface (GUI)</h2>
5555

5656
<p>
5757
After installation, DNA2Graph can be started from a terminal with:
@@ -62,16 +62,16 @@ <h2>Launching the Graphical Interface</h2>
6262
</div>
6363

6464
<p>
65-
This command opens the graphical user interface (GUI).
65+
This command opens the graphical user interface.
6666
</p>
6767
</section>
6868

6969
<section>
70-
<h2>Using the Command-Line Interface</h2>
70+
<h2>Using the Command-Line Interface (CLI)</h2>
7171

7272
<p>
7373
DNA2Graph can also be used directly from the terminal through the
74-
command-line interface (CLI):
74+
command-line interface:
7575
</p>
7676

7777
<div class="code-block">

website/index.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,7 @@ <h2>What can you do with DNA2Graph?</h2>
8282
<section id="how-works">
8383
<h2>How does DNA2Graph work?</h2>
8484
<p>
85-
DNA2Graph offers two alternative approaches for segmentation: a custom, non-learning-based pipeline based on traditional image processing techniques, and a deep learning model trained specifically for this task.
86-
In addition, it incorporates novel post-processing algorithms to ensure structural continuity and biological plausibility.
85+
DNA2Graph performs an initial segmentation of DNA molecules and subsequently represents each molecule as a spatial graph of nodes and edges. Rather than treating segmentation as a purely pixel-level task, it employs novel graph-based error-correction algorithms to repair segmentation errors and signal interruptions while enforcing biological priors of DNA molecules, such as continuity and thinness.
8786
</p>
8887
</section>
8988

@@ -110,7 +109,7 @@ <h2>Where can I get help with DNA2Graph?</h2>
110109
<h2>How to cite DNA2Graph?</h2>
111110

112111
<div class="code-block">
113-
<p>F. Chinello, E. Zanella, M. Giannattasio, F. M. Buffa, and Y. Doksani.</p>
112+
<p>F. Chinello, M. Giannattasio, E. Zanella, F. Bruno, F. M. Buffa, and Y. Doksani.</p>
114113
<p>DNA2Graph [Computer software]. Zenodo, 2026.</p>
115114
<p>https://doi.org/10.5281/zenodo.20413553</p>
116115
</div>

website/tutorials.html

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
<h2>Example Input Image</h2>
3838

3939
<p>
40-
We provide the input image used in the GUI and CLI tutorials for download.
40+
We provide the input image used in the tutorials for download.
4141
</p>
4242

4343
<a href="https://github.com/chinefed/DNA2Graph/releases/download/v1.0.1/sample_input.tif" class="btn">Download Example Input Image</a>
@@ -59,8 +59,8 @@ <h2>Getting Started</h2>
5959
<div class="note-box">
6060

6161
<strong>NOTE:</strong>
62-
The trained segmentation pipeline is available as a beta feature.
63-
Try the standard pipeline first.
62+
The trained segmentation pipeline is a beta feature.
63+
The default pipeline is recommended for most users.
6464
</div>
6565

6666
</section>
@@ -93,12 +93,8 @@ <h2>Advanced Options</h2>
9393

9494
<div class="note-box">
9595
<strong>NOTE:</strong>
96-
The segmenter patch size must not be smaller than the shortest side of the input image.
97-
</div>
98-
99-
<div class="note-box">
100-
<strong>NOTE:</strong>
101-
When using the trained segmentation pipeline, the patch size must also be divisible by 32.
96+
The segmenter patch size must be smaller than the shortest side of the input image.
97+
When using the trained segmentation pipeline, the segmenter patch size must also be divisible by 32.
10298
</div>
10399

104100
</section>

0 commit comments

Comments
 (0)