datashader speedup and bugfixes - #309

Merged
timtreis merged 34 commits into
mainfrom
feature/296-datashader-canvas-size
Oct 23, 2024
Merged

datashader speedup and bugfixes#309
timtreis merged 34 commits into
mainfrom
feature/296-datashader-canvas-size

Conversation

@Sonja-Stockhaus

Copy link
Copy Markdown
Collaborator

This speeds everything up for me locally, but for the benchmark (#296), I see an effect (aka datashader faster than matplotlib) for e.g. 10k points/shapes etc.

@Sonja-StockhausSonja-Stockhaus linked an issue Jul 17, 2024 that may be closed by this pull request
@codecov-commenter

codecov-commenter commented Jul 17, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 83.43195% with 28 lines in your changes missing coverage. Please review.

Project coverage is 83.36%. Comparing base (80c6f77) to head (73568ec).

Files with missing linesPatch %Lines
src/spatialdata_plot/pl/render.py76.59%22 Missing ⚠️
src/spatialdata_plot/pl/utils.py91.78%6 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #309 +/- ##
==========================================
- Coverage 83.73% 83.36% -0.37% 
==========================================
Files 8 8 Lines 1543 1653 +110 ==========================================
+ Hits 1292 1378 +86 - Misses 251 275 +24 
Files with missing linesCoverage Δ
src/spatialdata_plot/pl/basic.py89.26% <ø> (ø)
src/spatialdata_plot/pl/render_params.py100.00% <100.00%> (ø)
src/spatialdata_plot/pl/utils.py77.48% <91.78%> (+1.11%)⬆️
src/spatialdata_plot/pl/render.py90.25% <76.59%> (-4.47%)⬇️

Comment threadsrc/spatialdata_plot/pl/render.py Outdated
trans = mtransforms.Affine2D(matrix=affine_trans)
trans_data = trans + ax.transData

rgba_image = np.transpose(rgba_image.data.compute(), (1, 2, 0)) # type: ignore[attr-defined]

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here (and in render_shapes), we access the image as numpy array from the SpatialImage. mypy doesn't believe that compute() exists...

@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as ready for review July 17, 2024 18:57
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment on lines +452 to +460

# compute canvas size in pixels close to the actual image size to speed up computation
plot_width = x_ext[1] - x_ext[0]
plot_height = y_ext[1] - y_ext[0]
plot_width_px = int(round(fig_params.fig.get_size_inches()[0] * fig_params.fig.dpi))
plot_height_px = int(round(fig_params.fig.get_size_inches()[1] * fig_params.fig.dpi))
factor = np.min([plot_width / plot_width_px, plot_height / plot_height_px])
plot_width = int(np.round(plot_width / factor))
plot_height = int(np.round(plot_height / factor))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd consider bundling this code in a private function since it's duplicate from above.

Comment threadsrc/spatialdata_plot/pl/render.py Outdated

rbga_image = np.transpose(ds_result.to_numpy().base, (0, 1, 2))
cax = ax.imshow(rbga_image, zorder=render_params.zorder, alpha=render_params.alpha)
# create SpatialImage to get it back to original size

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also this code is a duplicate, I'd consider it refactoring it into a private function.

@Sonja-StockhausSonja-Stockhaus linked an issue Jul 19, 2024 that may be closed by this pull request
@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as draft July 19, 2024 15:48
@Sonja-StockhausSonja-Stockhaus linked an issue Jul 30, 2024 that may be closed by this pull request
3 tasks
@Sonja-StockhausSonja-Stockhaus linked an issue Jul 31, 2024 that may be closed by this pull request
@LucaMarconato

LucaMarconato commented Aug 1, 2024

Copy link
Copy Markdown
Member

Thanks @Sonja-Stockhaus ! I have tried the PR on the Visium HD data and the speed up is significant! I switched back to using datashader instead of matplotlib in the notebook 😊

@LucaMarconato

LucaMarconato commented Aug 9, 2024

Copy link
Copy Markdown
Member

Sonja, I found a bug with this PR when the rasterized object needs to be aligned with the rest #291. The solution seems straightforward, I think one just needs to initialize the image element from datashader using the old coordinate transformations.

@timtreistimtreis self-assigned this Aug 14, 2024
@timtreis

Copy link
Copy Markdown
Member

Will look into it!

@timtreis
timtreis marked this pull request as ready for review August 14, 2024 23:59
@LucaMarconato

LucaMarconato commented Sep 27, 2024

Copy link
Copy Markdown
Member

Thanks for the update!

outline of polygons need to be implemented in datashader

This task here seems tricky. I would consider raising a warning saying that the outline is currently not supported and workin on this on a separate PR (with low priority).

@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

outline of polygons need to be implemented in datashader

This task here seems tricky. I would consider raising a warning saying that the outline is currently not supported and workin on this on a separate PR (with low priority).

If you use cvs.line instead of cvs.polygons you get only the outline, so you should be able to overlay the two. Depending on how fast we want to merge this PR, we can of course move that to a new one

@LucaMarconato

Copy link
Copy Markdown
Member

Ah ok, then it should be a fast addition, thanks for the update.

@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as ready for review October 2, 2024 07:20
@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

General problem of datashader so far: when you render elements, coloring them by a value and a color map, you wouldn't see a single element if all of them have the same value X. This is due to the scaling of the data for the colormap that happens in datashader (scaled_data = (data - span[0])/(span[1] - span[0])) which leads to all elements being assigned alpha=0.

Fix in this PR: internally, not the whole colormap is passed to datashader, but just the color given by cmap(0.0). It is used to color all elements. Still, a colorbar of the cmap is drawn with the range [X, X+1].

@LucaMarconato

Copy link
Copy Markdown
Member

Thanks for the explanation, I think the approach that you implemented is a good one!

@melonoramelonora left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Sonja-Stockhaus, thanks for the amazing work. I think it is very far already, but would like some minor changes here and there, mainly to shorten the code a bit and some refactorings to keep it more maintainable.

Comment threadsrc/spatialdata_plot/pl/basic.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated

@timtreistimtreis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as discussed

Comment threadsrc/spatialdata_plot/pl/render_params.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadCHANGELOG.md Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadtests/_images/Points_datashader_can_use_std_as_reduction.png
Comment threadtests/pl/test_render_shapes.py
Comment threadtests/pl/test_render_shapes.py
@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

As discussed with @timtreis, we now use sum as default datashader aggregation for points and mean for shapes

@timtreis
timtreis merged commit bc2db2c into mainOct 23, 2024
@timtreis
timtreis deleted the feature/296-datashader-canvas-size branch October 23, 2024 22:16
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugSomething isn't workingpoints 🧮Anything related to Pointspriority: highshapes 🫧Anything related to Shapes

Projects

None yet

5 participants

@Sonja-Stockhaus@codecov-commenter@LucaMarconato@timtreis@melonora
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

datashader speedup and bugfixes - #309

Merged
timtreis merged 34 commits into
mainfrom
feature/296-datashader-canvas-size
Oct 23, 2024
Merged

datashader speedup and bugfixes#309
timtreis merged 34 commits into
mainfrom
feature/296-datashader-canvas-size

Conversation

@Sonja-Stockhaus

Copy link
Copy Markdown
Collaborator

This speeds everything up for me locally, but for the benchmark (#296), I see an effect (aka datashader faster than matplotlib) for e.g. 10k points/shapes etc.

@Sonja-StockhausSonja-Stockhaus linked an issue Jul 17, 2024 that may be closed by this pull request
@codecov-commenter

codecov-commenter commented Jul 17, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 83.43195% with 28 lines in your changes missing coverage. Please review.

Project coverage is 83.36%. Comparing base (80c6f77) to head (73568ec).

Files with missing linesPatch %Lines
src/spatialdata_plot/pl/render.py76.59%22 Missing ⚠️
src/spatialdata_plot/pl/utils.py91.78%6 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #309 +/- ##
==========================================
- Coverage 83.73% 83.36% -0.37% 
==========================================
Files 8 8 Lines 1543 1653 +110 ==========================================
+ Hits 1292 1378 +86 - Misses 251 275 +24 
Files with missing linesCoverage Δ
src/spatialdata_plot/pl/basic.py89.26% <ø> (ø)
src/spatialdata_plot/pl/render_params.py100.00% <100.00%> (ø)
src/spatialdata_plot/pl/utils.py77.48% <91.78%> (+1.11%)⬆️
src/spatialdata_plot/pl/render.py90.25% <76.59%> (-4.47%)⬇️

Comment threadsrc/spatialdata_plot/pl/render.py Outdated
trans = mtransforms.Affine2D(matrix=affine_trans)
trans_data = trans + ax.transData

rgba_image = np.transpose(rgba_image.data.compute(), (1, 2, 0)) # type: ignore[attr-defined]

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here (and in render_shapes), we access the image as numpy array from the SpatialImage. mypy doesn't believe that compute() exists...

@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as ready for review July 17, 2024 18:57
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment on lines +452 to +460

# compute canvas size in pixels close to the actual image size to speed up computation
plot_width = x_ext[1] - x_ext[0]
plot_height = y_ext[1] - y_ext[0]
plot_width_px = int(round(fig_params.fig.get_size_inches()[0] * fig_params.fig.dpi))
plot_height_px = int(round(fig_params.fig.get_size_inches()[1] * fig_params.fig.dpi))
factor = np.min([plot_width / plot_width_px, plot_height / plot_height_px])
plot_width = int(np.round(plot_width / factor))
plot_height = int(np.round(plot_height / factor))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd consider bundling this code in a private function since it's duplicate from above.

Comment threadsrc/spatialdata_plot/pl/render.py Outdated

rbga_image = np.transpose(ds_result.to_numpy().base, (0, 1, 2))
cax = ax.imshow(rbga_image, zorder=render_params.zorder, alpha=render_params.alpha)
# create SpatialImage to get it back to original size

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also this code is a duplicate, I'd consider it refactoring it into a private function.

@Sonja-StockhausSonja-Stockhaus linked an issue Jul 19, 2024 that may be closed by this pull request
@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as draft July 19, 2024 15:48
@Sonja-StockhausSonja-Stockhaus linked an issue Jul 30, 2024 that may be closed by this pull request
3 tasks
@Sonja-StockhausSonja-Stockhaus linked an issue Jul 31, 2024 that may be closed by this pull request
@LucaMarconato

LucaMarconato commented Aug 1, 2024

Copy link
Copy Markdown
Member

Thanks @Sonja-Stockhaus ! I have tried the PR on the Visium HD data and the speed up is significant! I switched back to using datashader instead of matplotlib in the notebook 😊

@LucaMarconato

LucaMarconato commented Aug 9, 2024

Copy link
Copy Markdown
Member

Sonja, I found a bug with this PR when the rasterized object needs to be aligned with the rest #291. The solution seems straightforward, I think one just needs to initialize the image element from datashader using the old coordinate transformations.

@timtreistimtreis self-assigned this Aug 14, 2024
@timtreis

Copy link
Copy Markdown
Member

Will look into it!

@timtreis
timtreis marked this pull request as ready for review August 14, 2024 23:59
@LucaMarconato

LucaMarconato commented Sep 27, 2024

Copy link
Copy Markdown
Member

Thanks for the update!

outline of polygons need to be implemented in datashader

This task here seems tricky. I would consider raising a warning saying that the outline is currently not supported and workin on this on a separate PR (with low priority).

@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

outline of polygons need to be implemented in datashader

This task here seems tricky. I would consider raising a warning saying that the outline is currently not supported and workin on this on a separate PR (with low priority).

If you use cvs.line instead of cvs.polygons you get only the outline, so you should be able to overlay the two. Depending on how fast we want to merge this PR, we can of course move that to a new one

@LucaMarconato

Copy link
Copy Markdown
Member

Ah ok, then it should be a fast addition, thanks for the update.

@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as ready for review October 2, 2024 07:20
@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

General problem of datashader so far: when you render elements, coloring them by a value and a color map, you wouldn't see a single element if all of them have the same value X. This is due to the scaling of the data for the colormap that happens in datashader (scaled_data = (data - span[0])/(span[1] - span[0])) which leads to all elements being assigned alpha=0.

Fix in this PR: internally, not the whole colormap is passed to datashader, but just the color given by cmap(0.0). It is used to color all elements. Still, a colorbar of the cmap is drawn with the range [X, X+1].

@LucaMarconato

Copy link
Copy Markdown
Member

Thanks for the explanation, I think the approach that you implemented is a good one!

@melonoramelonora left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Sonja-Stockhaus, thanks for the amazing work. I think it is very far already, but would like some minor changes here and there, mainly to shorten the code a bit and some refactorings to keep it more maintainable.

Comment threadsrc/spatialdata_plot/pl/basic.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated

@timtreistimtreis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as discussed

Comment threadsrc/spatialdata_plot/pl/render_params.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadCHANGELOG.md Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadtests/_images/Points_datashader_can_use_std_as_reduction.png
Comment threadtests/pl/test_render_shapes.py
Comment threadtests/pl/test_render_shapes.py
@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

As discussed with @timtreis, we now use sum as default datashader aggregation for points and mean for shapes

@timtreis
timtreis merged commit bc2db2c into mainOct 23, 2024
@timtreis
timtreis deleted the feature/296-datashader-canvas-size branch October 23, 2024 22:16
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugSomething isn't workingpoints 🧮Anything related to Pointspriority: highshapes 🫧Anything related to Shapes

Projects

None yet

5 participants

@Sonja-Stockhaus@codecov-commenter@LucaMarconato@timtreis@melonora
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

datashader speedup and bugfixes - #309

Merged
timtreis merged 34 commits into
mainfrom
feature/296-datashader-canvas-size
Oct 23, 2024
Merged

datashader speedup and bugfixes#309
timtreis merged 34 commits into
mainfrom
feature/296-datashader-canvas-size

Conversation

@Sonja-Stockhaus

Copy link
Copy Markdown
Collaborator

This speeds everything up for me locally, but for the benchmark (#296), I see an effect (aka datashader faster than matplotlib) for e.g. 10k points/shapes etc.

@Sonja-StockhausSonja-Stockhaus linked an issue Jul 17, 2024 that may be closed by this pull request
@codecov-commenter

codecov-commenter commented Jul 17, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 83.43195% with 28 lines in your changes missing coverage. Please review.

Project coverage is 83.36%. Comparing base (80c6f77) to head (73568ec).

Files with missing linesPatch %Lines
src/spatialdata_plot/pl/render.py76.59%22 Missing ⚠️
src/spatialdata_plot/pl/utils.py91.78%6 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #309 +/- ##
==========================================
- Coverage 83.73% 83.36% -0.37% 
==========================================
Files 8 8 Lines 1543 1653 +110 ==========================================
+ Hits 1292 1378 +86 - Misses 251 275 +24 
Files with missing linesCoverage Δ
src/spatialdata_plot/pl/basic.py89.26% <ø> (ø)
src/spatialdata_plot/pl/render_params.py100.00% <100.00%> (ø)
src/spatialdata_plot/pl/utils.py77.48% <91.78%> (+1.11%)⬆️
src/spatialdata_plot/pl/render.py90.25% <76.59%> (-4.47%)⬇️

Comment threadsrc/spatialdata_plot/pl/render.py Outdated
trans = mtransforms.Affine2D(matrix=affine_trans)
trans_data = trans + ax.transData

rgba_image = np.transpose(rgba_image.data.compute(), (1, 2, 0)) # type: ignore[attr-defined]

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here (and in render_shapes), we access the image as numpy array from the SpatialImage. mypy doesn't believe that compute() exists...

@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as ready for review July 17, 2024 18:57
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment on lines +452 to +460

# compute canvas size in pixels close to the actual image size to speed up computation
plot_width = x_ext[1] - x_ext[0]
plot_height = y_ext[1] - y_ext[0]
plot_width_px = int(round(fig_params.fig.get_size_inches()[0] * fig_params.fig.dpi))
plot_height_px = int(round(fig_params.fig.get_size_inches()[1] * fig_params.fig.dpi))
factor = np.min([plot_width / plot_width_px, plot_height / plot_height_px])
plot_width = int(np.round(plot_width / factor))
plot_height = int(np.round(plot_height / factor))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd consider bundling this code in a private function since it's duplicate from above.

Comment threadsrc/spatialdata_plot/pl/render.py Outdated

rbga_image = np.transpose(ds_result.to_numpy().base, (0, 1, 2))
cax = ax.imshow(rbga_image, zorder=render_params.zorder, alpha=render_params.alpha)
# create SpatialImage to get it back to original size

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also this code is a duplicate, I'd consider it refactoring it into a private function.

@Sonja-StockhausSonja-Stockhaus linked an issue Jul 19, 2024 that may be closed by this pull request
@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as draft July 19, 2024 15:48
@Sonja-StockhausSonja-Stockhaus linked an issue Jul 30, 2024 that may be closed by this pull request
3 tasks
@Sonja-StockhausSonja-Stockhaus linked an issue Jul 31, 2024 that may be closed by this pull request
@LucaMarconato

LucaMarconato commented Aug 1, 2024

Copy link
Copy Markdown
Member

Thanks @Sonja-Stockhaus ! I have tried the PR on the Visium HD data and the speed up is significant! I switched back to using datashader instead of matplotlib in the notebook 😊

@LucaMarconato

LucaMarconato commented Aug 9, 2024

Copy link
Copy Markdown
Member

Sonja, I found a bug with this PR when the rasterized object needs to be aligned with the rest #291. The solution seems straightforward, I think one just needs to initialize the image element from datashader using the old coordinate transformations.

@timtreistimtreis self-assigned this Aug 14, 2024
@timtreis

Copy link
Copy Markdown
Member

Will look into it!

@timtreis
timtreis marked this pull request as ready for review August 14, 2024 23:59
@LucaMarconato

LucaMarconato commented Sep 27, 2024

Copy link
Copy Markdown
Member

Thanks for the update!

outline of polygons need to be implemented in datashader

This task here seems tricky. I would consider raising a warning saying that the outline is currently not supported and workin on this on a separate PR (with low priority).

@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

outline of polygons need to be implemented in datashader

This task here seems tricky. I would consider raising a warning saying that the outline is currently not supported and workin on this on a separate PR (with low priority).

If you use cvs.line instead of cvs.polygons you get only the outline, so you should be able to overlay the two. Depending on how fast we want to merge this PR, we can of course move that to a new one

@LucaMarconato

Copy link
Copy Markdown
Member

Ah ok, then it should be a fast addition, thanks for the update.

@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as ready for review October 2, 2024 07:20
@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

General problem of datashader so far: when you render elements, coloring them by a value and a color map, you wouldn't see a single element if all of them have the same value X. This is due to the scaling of the data for the colormap that happens in datashader (scaled_data = (data - span[0])/(span[1] - span[0])) which leads to all elements being assigned alpha=0.

Fix in this PR: internally, not the whole colormap is passed to datashader, but just the color given by cmap(0.0). It is used to color all elements. Still, a colorbar of the cmap is drawn with the range [X, X+1].

@LucaMarconato

Copy link
Copy Markdown
Member

Thanks for the explanation, I think the approach that you implemented is a good one!

@melonoramelonora left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Sonja-Stockhaus, thanks for the amazing work. I think it is very far already, but would like some minor changes here and there, mainly to shorten the code a bit and some refactorings to keep it more maintainable.

Comment threadsrc/spatialdata_plot/pl/basic.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated

@timtreistimtreis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as discussed

Comment threadsrc/spatialdata_plot/pl/render_params.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadCHANGELOG.md Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadtests/_images/Points_datashader_can_use_std_as_reduction.png
Comment threadtests/pl/test_render_shapes.py
Comment threadtests/pl/test_render_shapes.py
@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

As discussed with @timtreis, we now use sum as default datashader aggregation for points and mean for shapes

@timtreis
timtreis merged commit bc2db2c into mainOct 23, 2024
@timtreis
timtreis deleted the feature/296-datashader-canvas-size branch October 23, 2024 22:16
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugSomething isn't workingpoints 🧮Anything related to Pointspriority: highshapes 🫧Anything related to Shapes

Projects

None yet

5 participants

@Sonja-Stockhaus@codecov-commenter@LucaMarconato@timtreis@melonora
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

datashader speedup and bugfixes - #309

Merged
timtreis merged 34 commits into
mainfrom
feature/296-datashader-canvas-size
Oct 23, 2024
Merged

datashader speedup and bugfixes#309
timtreis merged 34 commits into
mainfrom
feature/296-datashader-canvas-size

Conversation

@Sonja-Stockhaus

Copy link
Copy Markdown
Collaborator

This speeds everything up for me locally, but for the benchmark (#296), I see an effect (aka datashader faster than matplotlib) for e.g. 10k points/shapes etc.

@Sonja-StockhausSonja-Stockhaus linked an issue Jul 17, 2024 that may be closed by this pull request
@codecov-commenter

codecov-commenter commented Jul 17, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 83.43195% with 28 lines in your changes missing coverage. Please review.

Project coverage is 83.36%. Comparing base (80c6f77) to head (73568ec).

Files with missing linesPatch %Lines
src/spatialdata_plot/pl/render.py76.59%22 Missing ⚠️
src/spatialdata_plot/pl/utils.py91.78%6 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #309 +/- ##
==========================================
- Coverage 83.73% 83.36% -0.37% 
==========================================
Files 8 8 Lines 1543 1653 +110 ==========================================
+ Hits 1292 1378 +86 - Misses 251 275 +24 
Files with missing linesCoverage Δ
src/spatialdata_plot/pl/basic.py89.26% <ø> (ø)
src/spatialdata_plot/pl/render_params.py100.00% <100.00%> (ø)
src/spatialdata_plot/pl/utils.py77.48% <91.78%> (+1.11%)⬆️
src/spatialdata_plot/pl/render.py90.25% <76.59%> (-4.47%)⬇️

Comment threadsrc/spatialdata_plot/pl/render.py Outdated
trans = mtransforms.Affine2D(matrix=affine_trans)
trans_data = trans + ax.transData

rgba_image = np.transpose(rgba_image.data.compute(), (1, 2, 0)) # type: ignore[attr-defined]

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here (and in render_shapes), we access the image as numpy array from the SpatialImage. mypy doesn't believe that compute() exists...

@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as ready for review July 17, 2024 18:57
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment on lines +452 to +460

# compute canvas size in pixels close to the actual image size to speed up computation
plot_width = x_ext[1] - x_ext[0]
plot_height = y_ext[1] - y_ext[0]
plot_width_px = int(round(fig_params.fig.get_size_inches()[0] * fig_params.fig.dpi))
plot_height_px = int(round(fig_params.fig.get_size_inches()[1] * fig_params.fig.dpi))
factor = np.min([plot_width / plot_width_px, plot_height / plot_height_px])
plot_width = int(np.round(plot_width / factor))
plot_height = int(np.round(plot_height / factor))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd consider bundling this code in a private function since it's duplicate from above.

Comment threadsrc/spatialdata_plot/pl/render.py Outdated

rbga_image = np.transpose(ds_result.to_numpy().base, (0, 1, 2))
cax = ax.imshow(rbga_image, zorder=render_params.zorder, alpha=render_params.alpha)
# create SpatialImage to get it back to original size

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also this code is a duplicate, I'd consider it refactoring it into a private function.

@Sonja-StockhausSonja-Stockhaus linked an issue Jul 19, 2024 that may be closed by this pull request
@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as draft July 19, 2024 15:48
@Sonja-StockhausSonja-Stockhaus linked an issue Jul 30, 2024 that may be closed by this pull request
3 tasks
@Sonja-StockhausSonja-Stockhaus linked an issue Jul 31, 2024 that may be closed by this pull request
@LucaMarconato

LucaMarconato commented Aug 1, 2024

Copy link
Copy Markdown
Member

Thanks @Sonja-Stockhaus ! I have tried the PR on the Visium HD data and the speed up is significant! I switched back to using datashader instead of matplotlib in the notebook 😊

@LucaMarconato

LucaMarconato commented Aug 9, 2024

Copy link
Copy Markdown
Member

Sonja, I found a bug with this PR when the rasterized object needs to be aligned with the rest #291. The solution seems straightforward, I think one just needs to initialize the image element from datashader using the old coordinate transformations.

@timtreistimtreis self-assigned this Aug 14, 2024
@timtreis

Copy link
Copy Markdown
Member

Will look into it!

@timtreis
timtreis marked this pull request as ready for review August 14, 2024 23:59
@LucaMarconato

LucaMarconato commented Sep 27, 2024

Copy link
Copy Markdown
Member

Thanks for the update!

outline of polygons need to be implemented in datashader

This task here seems tricky. I would consider raising a warning saying that the outline is currently not supported and workin on this on a separate PR (with low priority).

@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

outline of polygons need to be implemented in datashader

This task here seems tricky. I would consider raising a warning saying that the outline is currently not supported and workin on this on a separate PR (with low priority).

If you use cvs.line instead of cvs.polygons you get only the outline, so you should be able to overlay the two. Depending on how fast we want to merge this PR, we can of course move that to a new one

@LucaMarconato

Copy link
Copy Markdown
Member

Ah ok, then it should be a fast addition, thanks for the update.

@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as ready for review October 2, 2024 07:20
@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

General problem of datashader so far: when you render elements, coloring them by a value and a color map, you wouldn't see a single element if all of them have the same value X. This is due to the scaling of the data for the colormap that happens in datashader (scaled_data = (data - span[0])/(span[1] - span[0])) which leads to all elements being assigned alpha=0.

Fix in this PR: internally, not the whole colormap is passed to datashader, but just the color given by cmap(0.0). It is used to color all elements. Still, a colorbar of the cmap is drawn with the range [X, X+1].

@LucaMarconato

Copy link
Copy Markdown
Member

Thanks for the explanation, I think the approach that you implemented is a good one!

@melonoramelonora left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Sonja-Stockhaus, thanks for the amazing work. I think it is very far already, but would like some minor changes here and there, mainly to shorten the code a bit and some refactorings to keep it more maintainable.

Comment threadsrc/spatialdata_plot/pl/basic.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated

@timtreistimtreis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as discussed

Comment threadsrc/spatialdata_plot/pl/render_params.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadCHANGELOG.md Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadtests/_images/Points_datashader_can_use_std_as_reduction.png
Comment threadtests/pl/test_render_shapes.py
Comment threadtests/pl/test_render_shapes.py
@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

As discussed with @timtreis, we now use sum as default datashader aggregation for points and mean for shapes

@timtreis
timtreis merged commit bc2db2c into mainOct 23, 2024
@timtreis
timtreis deleted the feature/296-datashader-canvas-size branch October 23, 2024 22:16
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugSomething isn't workingpoints 🧮Anything related to Pointspriority: highshapes 🫧Anything related to Shapes

Projects

None yet

5 participants

@Sonja-Stockhaus@codecov-commenter@LucaMarconato@timtreis@melonora
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

datashader speedup and bugfixes - #309

Merged
timtreis merged 34 commits into
mainfrom
feature/296-datashader-canvas-size
Oct 23, 2024
Merged

datashader speedup and bugfixes#309
timtreis merged 34 commits into
mainfrom
feature/296-datashader-canvas-size

Conversation

@Sonja-Stockhaus

Copy link
Copy Markdown
Collaborator

This speeds everything up for me locally, but for the benchmark (#296), I see an effect (aka datashader faster than matplotlib) for e.g. 10k points/shapes etc.

@Sonja-StockhausSonja-Stockhaus linked an issue Jul 17, 2024 that may be closed by this pull request
@codecov-commenter

codecov-commenter commented Jul 17, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 83.43195% with 28 lines in your changes missing coverage. Please review.

Project coverage is 83.36%. Comparing base (80c6f77) to head (73568ec).

Files with missing linesPatch %Lines
src/spatialdata_plot/pl/render.py76.59%22 Missing ⚠️
src/spatialdata_plot/pl/utils.py91.78%6 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #309 +/- ##
==========================================
- Coverage 83.73% 83.36% -0.37% 
==========================================
Files 8 8 Lines 1543 1653 +110 ==========================================
+ Hits 1292 1378 +86 - Misses 251 275 +24 
Files with missing linesCoverage Δ
src/spatialdata_plot/pl/basic.py89.26% <ø> (ø)
src/spatialdata_plot/pl/render_params.py100.00% <100.00%> (ø)
src/spatialdata_plot/pl/utils.py77.48% <91.78%> (+1.11%)⬆️
src/spatialdata_plot/pl/render.py90.25% <76.59%> (-4.47%)⬇️

Comment threadsrc/spatialdata_plot/pl/render.py Outdated
trans = mtransforms.Affine2D(matrix=affine_trans)
trans_data = trans + ax.transData

rgba_image = np.transpose(rgba_image.data.compute(), (1, 2, 0)) # type: ignore[attr-defined]

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here (and in render_shapes), we access the image as numpy array from the SpatialImage. mypy doesn't believe that compute() exists...

@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as ready for review July 17, 2024 18:57
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment on lines +452 to +460

# compute canvas size in pixels close to the actual image size to speed up computation
plot_width = x_ext[1] - x_ext[0]
plot_height = y_ext[1] - y_ext[0]
plot_width_px = int(round(fig_params.fig.get_size_inches()[0] * fig_params.fig.dpi))
plot_height_px = int(round(fig_params.fig.get_size_inches()[1] * fig_params.fig.dpi))
factor = np.min([plot_width / plot_width_px, plot_height / plot_height_px])
plot_width = int(np.round(plot_width / factor))
plot_height = int(np.round(plot_height / factor))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd consider bundling this code in a private function since it's duplicate from above.

Comment threadsrc/spatialdata_plot/pl/render.py Outdated

rbga_image = np.transpose(ds_result.to_numpy().base, (0, 1, 2))
cax = ax.imshow(rbga_image, zorder=render_params.zorder, alpha=render_params.alpha)
# create SpatialImage to get it back to original size

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also this code is a duplicate, I'd consider it refactoring it into a private function.

@Sonja-StockhausSonja-Stockhaus linked an issue Jul 19, 2024 that may be closed by this pull request
@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as draft July 19, 2024 15:48
@Sonja-StockhausSonja-Stockhaus linked an issue Jul 30, 2024 that may be closed by this pull request
3 tasks
@Sonja-StockhausSonja-Stockhaus linked an issue Jul 31, 2024 that may be closed by this pull request
@LucaMarconato

LucaMarconato commented Aug 1, 2024

Copy link
Copy Markdown
Member

Thanks @Sonja-Stockhaus ! I have tried the PR on the Visium HD data and the speed up is significant! I switched back to using datashader instead of matplotlib in the notebook 😊

@LucaMarconato

LucaMarconato commented Aug 9, 2024

Copy link
Copy Markdown
Member

Sonja, I found a bug with this PR when the rasterized object needs to be aligned with the rest #291. The solution seems straightforward, I think one just needs to initialize the image element from datashader using the old coordinate transformations.

@timtreistimtreis self-assigned this Aug 14, 2024
@timtreis

Copy link
Copy Markdown
Member

Will look into it!

@timtreis
timtreis marked this pull request as ready for review August 14, 2024 23:59
@LucaMarconato

LucaMarconato commented Sep 27, 2024

Copy link
Copy Markdown
Member

Thanks for the update!

outline of polygons need to be implemented in datashader

This task here seems tricky. I would consider raising a warning saying that the outline is currently not supported and workin on this on a separate PR (with low priority).

@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

outline of polygons need to be implemented in datashader

This task here seems tricky. I would consider raising a warning saying that the outline is currently not supported and workin on this on a separate PR (with low priority).

If you use cvs.line instead of cvs.polygons you get only the outline, so you should be able to overlay the two. Depending on how fast we want to merge this PR, we can of course move that to a new one

@LucaMarconato

Copy link
Copy Markdown
Member

Ah ok, then it should be a fast addition, thanks for the update.

@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as ready for review October 2, 2024 07:20
@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

General problem of datashader so far: when you render elements, coloring them by a value and a color map, you wouldn't see a single element if all of them have the same value X. This is due to the scaling of the data for the colormap that happens in datashader (scaled_data = (data - span[0])/(span[1] - span[0])) which leads to all elements being assigned alpha=0.

Fix in this PR: internally, not the whole colormap is passed to datashader, but just the color given by cmap(0.0). It is used to color all elements. Still, a colorbar of the cmap is drawn with the range [X, X+1].

@LucaMarconato

Copy link
Copy Markdown
Member

Thanks for the explanation, I think the approach that you implemented is a good one!

@melonoramelonora left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Sonja-Stockhaus, thanks for the amazing work. I think it is very far already, but would like some minor changes here and there, mainly to shorten the code a bit and some refactorings to keep it more maintainable.

Comment threadsrc/spatialdata_plot/pl/basic.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated

@timtreistimtreis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as discussed

Comment threadsrc/spatialdata_plot/pl/render_params.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadCHANGELOG.md Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadtests/_images/Points_datashader_can_use_std_as_reduction.png
Comment threadtests/pl/test_render_shapes.py
Comment threadtests/pl/test_render_shapes.py
@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

As discussed with @timtreis, we now use sum as default datashader aggregation for points and mean for shapes

@timtreis
timtreis merged commit bc2db2c into mainOct 23, 2024
@timtreis
timtreis deleted the feature/296-datashader-canvas-size branch October 23, 2024 22:16
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugSomething isn't workingpoints 🧮Anything related to Pointspriority: highshapes 🫧Anything related to Shapes

Projects

None yet

5 participants

@Sonja-Stockhaus@codecov-commenter@LucaMarconato@timtreis@melonora
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

datashader speedup and bugfixes - #309

Merged
timtreis merged 34 commits into
mainfrom
feature/296-datashader-canvas-size
Oct 23, 2024
Merged

datashader speedup and bugfixes#309
timtreis merged 34 commits into
mainfrom
feature/296-datashader-canvas-size

Conversation

@Sonja-Stockhaus

Copy link
Copy Markdown
Collaborator

This speeds everything up for me locally, but for the benchmark (#296), I see an effect (aka datashader faster than matplotlib) for e.g. 10k points/shapes etc.

@Sonja-StockhausSonja-Stockhaus linked an issue Jul 17, 2024 that may be closed by this pull request
@codecov-commenter

codecov-commenter commented Jul 17, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 83.43195% with 28 lines in your changes missing coverage. Please review.

Project coverage is 83.36%. Comparing base (80c6f77) to head (73568ec).

Files with missing linesPatch %Lines
src/spatialdata_plot/pl/render.py76.59%22 Missing ⚠️
src/spatialdata_plot/pl/utils.py91.78%6 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #309 +/- ##
==========================================
- Coverage 83.73% 83.36% -0.37% 
==========================================
Files 8 8 Lines 1543 1653 +110 ==========================================
+ Hits 1292 1378 +86 - Misses 251 275 +24 
Files with missing linesCoverage Δ
src/spatialdata_plot/pl/basic.py89.26% <ø> (ø)
src/spatialdata_plot/pl/render_params.py100.00% <100.00%> (ø)
src/spatialdata_plot/pl/utils.py77.48% <91.78%> (+1.11%)⬆️
src/spatialdata_plot/pl/render.py90.25% <76.59%> (-4.47%)⬇️

Comment threadsrc/spatialdata_plot/pl/render.py Outdated
trans = mtransforms.Affine2D(matrix=affine_trans)
trans_data = trans + ax.transData

rgba_image = np.transpose(rgba_image.data.compute(), (1, 2, 0)) # type: ignore[attr-defined]

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here (and in render_shapes), we access the image as numpy array from the SpatialImage. mypy doesn't believe that compute() exists...

@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as ready for review July 17, 2024 18:57
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment on lines +452 to +460

# compute canvas size in pixels close to the actual image size to speed up computation
plot_width = x_ext[1] - x_ext[0]
plot_height = y_ext[1] - y_ext[0]
plot_width_px = int(round(fig_params.fig.get_size_inches()[0] * fig_params.fig.dpi))
plot_height_px = int(round(fig_params.fig.get_size_inches()[1] * fig_params.fig.dpi))
factor = np.min([plot_width / plot_width_px, plot_height / plot_height_px])
plot_width = int(np.round(plot_width / factor))
plot_height = int(np.round(plot_height / factor))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd consider bundling this code in a private function since it's duplicate from above.

Comment threadsrc/spatialdata_plot/pl/render.py Outdated

rbga_image = np.transpose(ds_result.to_numpy().base, (0, 1, 2))
cax = ax.imshow(rbga_image, zorder=render_params.zorder, alpha=render_params.alpha)
# create SpatialImage to get it back to original size

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also this code is a duplicate, I'd consider it refactoring it into a private function.

@Sonja-StockhausSonja-Stockhaus linked an issue Jul 19, 2024 that may be closed by this pull request
@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as draft July 19, 2024 15:48
@Sonja-StockhausSonja-Stockhaus linked an issue Jul 30, 2024 that may be closed by this pull request
3 tasks
@Sonja-StockhausSonja-Stockhaus linked an issue Jul 31, 2024 that may be closed by this pull request
@LucaMarconato

LucaMarconato commented Aug 1, 2024

Copy link
Copy Markdown
Member

Thanks @Sonja-Stockhaus ! I have tried the PR on the Visium HD data and the speed up is significant! I switched back to using datashader instead of matplotlib in the notebook 😊

@LucaMarconato

LucaMarconato commented Aug 9, 2024

Copy link
Copy Markdown
Member

Sonja, I found a bug with this PR when the rasterized object needs to be aligned with the rest #291. The solution seems straightforward, I think one just needs to initialize the image element from datashader using the old coordinate transformations.

@timtreistimtreis self-assigned this Aug 14, 2024
@timtreis

Copy link
Copy Markdown
Member

Will look into it!

@timtreis
timtreis marked this pull request as ready for review August 14, 2024 23:59
@LucaMarconato

LucaMarconato commented Sep 27, 2024

Copy link
Copy Markdown
Member

Thanks for the update!

outline of polygons need to be implemented in datashader

This task here seems tricky. I would consider raising a warning saying that the outline is currently not supported and workin on this on a separate PR (with low priority).

@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

outline of polygons need to be implemented in datashader

This task here seems tricky. I would consider raising a warning saying that the outline is currently not supported and workin on this on a separate PR (with low priority).

If you use cvs.line instead of cvs.polygons you get only the outline, so you should be able to overlay the two. Depending on how fast we want to merge this PR, we can of course move that to a new one

@LucaMarconato

Copy link
Copy Markdown
Member

Ah ok, then it should be a fast addition, thanks for the update.

@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as ready for review October 2, 2024 07:20
@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

General problem of datashader so far: when you render elements, coloring them by a value and a color map, you wouldn't see a single element if all of them have the same value X. This is due to the scaling of the data for the colormap that happens in datashader (scaled_data = (data - span[0])/(span[1] - span[0])) which leads to all elements being assigned alpha=0.

Fix in this PR: internally, not the whole colormap is passed to datashader, but just the color given by cmap(0.0). It is used to color all elements. Still, a colorbar of the cmap is drawn with the range [X, X+1].

@LucaMarconato

Copy link
Copy Markdown
Member

Thanks for the explanation, I think the approach that you implemented is a good one!

@melonoramelonora left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Sonja-Stockhaus, thanks for the amazing work. I think it is very far already, but would like some minor changes here and there, mainly to shorten the code a bit and some refactorings to keep it more maintainable.

Comment threadsrc/spatialdata_plot/pl/basic.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated

@timtreistimtreis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as discussed

Comment threadsrc/spatialdata_plot/pl/render_params.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadCHANGELOG.md Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadtests/_images/Points_datashader_can_use_std_as_reduction.png
Comment threadtests/pl/test_render_shapes.py
Comment threadtests/pl/test_render_shapes.py
@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

As discussed with @timtreis, we now use sum as default datashader aggregation for points and mean for shapes

@timtreis
timtreis merged commit bc2db2c into mainOct 23, 2024
@timtreis
timtreis deleted the feature/296-datashader-canvas-size branch October 23, 2024 22:16
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugSomething isn't workingpoints 🧮Anything related to Pointspriority: highshapes 🫧Anything related to Shapes

Projects

None yet

5 participants

@Sonja-Stockhaus@codecov-commenter@LucaMarconato@timtreis@melonora
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

datashader speedup and bugfixes - #309

Merged
timtreis merged 34 commits into
mainfrom
feature/296-datashader-canvas-size
Oct 23, 2024
Merged

datashader speedup and bugfixes#309
timtreis merged 34 commits into
mainfrom
feature/296-datashader-canvas-size

Conversation

@Sonja-Stockhaus

Copy link
Copy Markdown
Collaborator

This speeds everything up for me locally, but for the benchmark (#296), I see an effect (aka datashader faster than matplotlib) for e.g. 10k points/shapes etc.

@Sonja-StockhausSonja-Stockhaus linked an issue Jul 17, 2024 that may be closed by this pull request
@codecov-commenter

codecov-commenter commented Jul 17, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 83.43195% with 28 lines in your changes missing coverage. Please review.

Project coverage is 83.36%. Comparing base (80c6f77) to head (73568ec).

Files with missing linesPatch %Lines
src/spatialdata_plot/pl/render.py76.59%22 Missing ⚠️
src/spatialdata_plot/pl/utils.py91.78%6 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #309 +/- ##
==========================================
- Coverage 83.73% 83.36% -0.37% 
==========================================
Files 8 8 Lines 1543 1653 +110 ==========================================
+ Hits 1292 1378 +86 - Misses 251 275 +24 
Files with missing linesCoverage Δ
src/spatialdata_plot/pl/basic.py89.26% <ø> (ø)
src/spatialdata_plot/pl/render_params.py100.00% <100.00%> (ø)
src/spatialdata_plot/pl/utils.py77.48% <91.78%> (+1.11%)⬆️
src/spatialdata_plot/pl/render.py90.25% <76.59%> (-4.47%)⬇️

Comment threadsrc/spatialdata_plot/pl/render.py Outdated
trans = mtransforms.Affine2D(matrix=affine_trans)
trans_data = trans + ax.transData

rgba_image = np.transpose(rgba_image.data.compute(), (1, 2, 0)) # type: ignore[attr-defined]

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here (and in render_shapes), we access the image as numpy array from the SpatialImage. mypy doesn't believe that compute() exists...

@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as ready for review July 17, 2024 18:57
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment on lines +452 to +460

# compute canvas size in pixels close to the actual image size to speed up computation
plot_width = x_ext[1] - x_ext[0]
plot_height = y_ext[1] - y_ext[0]
plot_width_px = int(round(fig_params.fig.get_size_inches()[0] * fig_params.fig.dpi))
plot_height_px = int(round(fig_params.fig.get_size_inches()[1] * fig_params.fig.dpi))
factor = np.min([plot_width / plot_width_px, plot_height / plot_height_px])
plot_width = int(np.round(plot_width / factor))
plot_height = int(np.round(plot_height / factor))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd consider bundling this code in a private function since it's duplicate from above.

Comment threadsrc/spatialdata_plot/pl/render.py Outdated

rbga_image = np.transpose(ds_result.to_numpy().base, (0, 1, 2))
cax = ax.imshow(rbga_image, zorder=render_params.zorder, alpha=render_params.alpha)
# create SpatialImage to get it back to original size

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also this code is a duplicate, I'd consider it refactoring it into a private function.

@Sonja-StockhausSonja-Stockhaus linked an issue Jul 19, 2024 that may be closed by this pull request
@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as draft July 19, 2024 15:48
@Sonja-StockhausSonja-Stockhaus linked an issue Jul 30, 2024 that may be closed by this pull request
3 tasks
@Sonja-StockhausSonja-Stockhaus linked an issue Jul 31, 2024 that may be closed by this pull request
@LucaMarconato

LucaMarconato commented Aug 1, 2024

Copy link
Copy Markdown
Member

Thanks @Sonja-Stockhaus ! I have tried the PR on the Visium HD data and the speed up is significant! I switched back to using datashader instead of matplotlib in the notebook 😊

@LucaMarconato

LucaMarconato commented Aug 9, 2024

Copy link
Copy Markdown
Member

Sonja, I found a bug with this PR when the rasterized object needs to be aligned with the rest #291. The solution seems straightforward, I think one just needs to initialize the image element from datashader using the old coordinate transformations.

@timtreistimtreis self-assigned this Aug 14, 2024
@timtreis

Copy link
Copy Markdown
Member

Will look into it!

@timtreis
timtreis marked this pull request as ready for review August 14, 2024 23:59
@LucaMarconato

LucaMarconato commented Sep 27, 2024

Copy link
Copy Markdown
Member

Thanks for the update!

outline of polygons need to be implemented in datashader

This task here seems tricky. I would consider raising a warning saying that the outline is currently not supported and workin on this on a separate PR (with low priority).

@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

outline of polygons need to be implemented in datashader

This task here seems tricky. I would consider raising a warning saying that the outline is currently not supported and workin on this on a separate PR (with low priority).

If you use cvs.line instead of cvs.polygons you get only the outline, so you should be able to overlay the two. Depending on how fast we want to merge this PR, we can of course move that to a new one

@LucaMarconato

Copy link
Copy Markdown
Member

Ah ok, then it should be a fast addition, thanks for the update.

@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as ready for review October 2, 2024 07:20
@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

General problem of datashader so far: when you render elements, coloring them by a value and a color map, you wouldn't see a single element if all of them have the same value X. This is due to the scaling of the data for the colormap that happens in datashader (scaled_data = (data - span[0])/(span[1] - span[0])) which leads to all elements being assigned alpha=0.

Fix in this PR: internally, not the whole colormap is passed to datashader, but just the color given by cmap(0.0). It is used to color all elements. Still, a colorbar of the cmap is drawn with the range [X, X+1].

@LucaMarconato

Copy link
Copy Markdown
Member

Thanks for the explanation, I think the approach that you implemented is a good one!

@melonoramelonora left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Sonja-Stockhaus, thanks for the amazing work. I think it is very far already, but would like some minor changes here and there, mainly to shorten the code a bit and some refactorings to keep it more maintainable.

Comment threadsrc/spatialdata_plot/pl/basic.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated

@timtreistimtreis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as discussed

Comment threadsrc/spatialdata_plot/pl/render_params.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadCHANGELOG.md Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadtests/_images/Points_datashader_can_use_std_as_reduction.png
Comment threadtests/pl/test_render_shapes.py
Comment threadtests/pl/test_render_shapes.py
@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

As discussed with @timtreis, we now use sum as default datashader aggregation for points and mean for shapes

@timtreis
timtreis merged commit bc2db2c into mainOct 23, 2024
@timtreis
timtreis deleted the feature/296-datashader-canvas-size branch October 23, 2024 22:16
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugSomething isn't workingpoints 🧮Anything related to Pointspriority: highshapes 🫧Anything related to Shapes

Projects

None yet

5 participants

@Sonja-Stockhaus@codecov-commenter@LucaMarconato@timtreis@melonora
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

datashader speedup and bugfixes - #309

Merged
timtreis merged 34 commits into
mainfrom
feature/296-datashader-canvas-size
Oct 23, 2024
Merged

datashader speedup and bugfixes#309
timtreis merged 34 commits into
mainfrom
feature/296-datashader-canvas-size

Conversation

@Sonja-Stockhaus

Copy link
Copy Markdown
Collaborator

This speeds everything up for me locally, but for the benchmark (#296), I see an effect (aka datashader faster than matplotlib) for e.g. 10k points/shapes etc.

@Sonja-StockhausSonja-Stockhaus linked an issue Jul 17, 2024 that may be closed by this pull request
@codecov-commenter

codecov-commenter commented Jul 17, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 83.43195% with 28 lines in your changes missing coverage. Please review.

Project coverage is 83.36%. Comparing base (80c6f77) to head (73568ec).

Files with missing linesPatch %Lines
src/spatialdata_plot/pl/render.py76.59%22 Missing ⚠️
src/spatialdata_plot/pl/utils.py91.78%6 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #309 +/- ##
==========================================
- Coverage 83.73% 83.36% -0.37% 
==========================================
Files 8 8 Lines 1543 1653 +110 ==========================================
+ Hits 1292 1378 +86 - Misses 251 275 +24 
Files with missing linesCoverage Δ
src/spatialdata_plot/pl/basic.py89.26% <ø> (ø)
src/spatialdata_plot/pl/render_params.py100.00% <100.00%> (ø)
src/spatialdata_plot/pl/utils.py77.48% <91.78%> (+1.11%)⬆️
src/spatialdata_plot/pl/render.py90.25% <76.59%> (-4.47%)⬇️

Comment threadsrc/spatialdata_plot/pl/render.py Outdated
trans = mtransforms.Affine2D(matrix=affine_trans)
trans_data = trans + ax.transData

rgba_image = np.transpose(rgba_image.data.compute(), (1, 2, 0)) # type: ignore[attr-defined]

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here (and in render_shapes), we access the image as numpy array from the SpatialImage. mypy doesn't believe that compute() exists...

@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as ready for review July 17, 2024 18:57
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment on lines +452 to +460

# compute canvas size in pixels close to the actual image size to speed up computation
plot_width = x_ext[1] - x_ext[0]
plot_height = y_ext[1] - y_ext[0]
plot_width_px = int(round(fig_params.fig.get_size_inches()[0] * fig_params.fig.dpi))
plot_height_px = int(round(fig_params.fig.get_size_inches()[1] * fig_params.fig.dpi))
factor = np.min([plot_width / plot_width_px, plot_height / plot_height_px])
plot_width = int(np.round(plot_width / factor))
plot_height = int(np.round(plot_height / factor))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd consider bundling this code in a private function since it's duplicate from above.

Comment threadsrc/spatialdata_plot/pl/render.py Outdated

rbga_image = np.transpose(ds_result.to_numpy().base, (0, 1, 2))
cax = ax.imshow(rbga_image, zorder=render_params.zorder, alpha=render_params.alpha)
# create SpatialImage to get it back to original size

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also this code is a duplicate, I'd consider it refactoring it into a private function.

@Sonja-StockhausSonja-Stockhaus linked an issue Jul 19, 2024 that may be closed by this pull request
@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as draft July 19, 2024 15:48
@Sonja-StockhausSonja-Stockhaus linked an issue Jul 30, 2024 that may be closed by this pull request
3 tasks
@Sonja-StockhausSonja-Stockhaus linked an issue Jul 31, 2024 that may be closed by this pull request
@LucaMarconato

LucaMarconato commented Aug 1, 2024

Copy link
Copy Markdown
Member

Thanks @Sonja-Stockhaus ! I have tried the PR on the Visium HD data and the speed up is significant! I switched back to using datashader instead of matplotlib in the notebook 😊

@LucaMarconato

LucaMarconato commented Aug 9, 2024

Copy link
Copy Markdown
Member

Sonja, I found a bug with this PR when the rasterized object needs to be aligned with the rest #291. The solution seems straightforward, I think one just needs to initialize the image element from datashader using the old coordinate transformations.

@timtreistimtreis self-assigned this Aug 14, 2024
@timtreis

Copy link
Copy Markdown
Member

Will look into it!

@timtreis
timtreis marked this pull request as ready for review August 14, 2024 23:59
@LucaMarconato

LucaMarconato commented Sep 27, 2024

Copy link
Copy Markdown
Member

Thanks for the update!

outline of polygons need to be implemented in datashader

This task here seems tricky. I would consider raising a warning saying that the outline is currently not supported and workin on this on a separate PR (with low priority).

@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

outline of polygons need to be implemented in datashader

This task here seems tricky. I would consider raising a warning saying that the outline is currently not supported and workin on this on a separate PR (with low priority).

If you use cvs.line instead of cvs.polygons you get only the outline, so you should be able to overlay the two. Depending on how fast we want to merge this PR, we can of course move that to a new one

@LucaMarconato

Copy link
Copy Markdown
Member

Ah ok, then it should be a fast addition, thanks for the update.

@Sonja-Stockhaus
Sonja-Stockhaus marked this pull request as ready for review October 2, 2024 07:20
@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

General problem of datashader so far: when you render elements, coloring them by a value and a color map, you wouldn't see a single element if all of them have the same value X. This is due to the scaling of the data for the colormap that happens in datashader (scaled_data = (data - span[0])/(span[1] - span[0])) which leads to all elements being assigned alpha=0.

Fix in this PR: internally, not the whole colormap is passed to datashader, but just the color given by cmap(0.0). It is used to color all elements. Still, a colorbar of the cmap is drawn with the range [X, X+1].

@LucaMarconato

Copy link
Copy Markdown
Member

Thanks for the explanation, I think the approach that you implemented is a good one!

@melonoramelonora left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Sonja-Stockhaus, thanks for the amazing work. I think it is very far already, but would like some minor changes here and there, mainly to shorten the code a bit and some refactorings to keep it more maintainable.

Comment threadsrc/spatialdata_plot/pl/basic.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated
Comment threadsrc/spatialdata_plot/pl/utils.py Outdated

@timtreistimtreis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as discussed

Comment threadsrc/spatialdata_plot/pl/render_params.py Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadCHANGELOG.md Outdated
Comment threadsrc/spatialdata_plot/pl/render.py Outdated
Comment threadtests/_images/Points_datashader_can_use_std_as_reduction.png
Comment threadtests/pl/test_render_shapes.py
Comment threadtests/pl/test_render_shapes.py
@Sonja-Stockhaus

Copy link
Copy Markdown
CollaboratorAuthor

As discussed with @timtreis, we now use sum as default datashader aggregation for points and mean for shapes

@timtreis
timtreis merged commit bc2db2c into mainOct 23, 2024
@timtreis
timtreis deleted the feature/296-datashader-canvas-size branch October 23, 2024 22:16
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugSomething isn't workingpoints 🧮Anything related to Pointspriority: highshapes 🫧Anything related to Shapes

Projects

None yet

5 participants

@Sonja-Stockhaus@codecov-commenter@LucaMarconato@timtreis@melonora