Skip to content

0.6 release notes #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open

0.6 release notes #158

wants to merge 18 commits into from

Conversation

finglis
Copy link
Contributor

@finglis finglis commented Jun 19, 2025

PR to update the 0.6 detailed release notes including updates to general docs sections greatly impacted by changes to features/UI related to:

  • QuPath Tour
  • Toolbar reorganisation (exceptions need to be made as its a very common pane)
  • Annotation names
  • Class pane
  • Measurement tables (exceptions also made as its a very common pane)
  • ImageJ + fiji running together - docs section, release notes section + images linked
  • ImageJ script runner - docs section, release notes + images linked
  • Multi-dimensional section?

@finglis
Copy link
Contributor Author

finglis commented Jun 19, 2025

Justification for the majority of "getting started" section images being updated is that they are mostly read by new users so its more important for the toolbar etc to represent what they also have on their screen. The screenshots themselves don't take long to do.

finglis added 2 commits June 19, 2025 16:55
Also includes deletions of unused images, changing from jpg/png where incorrect.
Images captured with system default as snapshot extension broke
:::{sidebar} Accurate cell detection
Good cell segmentation is really *essential* for accurate multiplexed analysis.
New and improved methods of segmenting cells in QuPath are being actively explored...
:::{sidebar} Precise cell detection
Copy link
Member

Choose a reason for hiding this comment

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

I don't see a reason to change this, I think 'Accurate' more accurately describes what is intended here - https://en.wikipedia.org/wiki/Accuracy_and_precision

@alanocallaghan
Copy link
Collaborator

alanocallaghan commented Jun 23, 2025

It feels like the release notes template shouldn't live on the main branch

Also, release notes needs to be in TOC


## 🚀 Major features

### New InstanSeg Segmentation
### Extension Manager/Wrangler
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would drop "wrangler"

@alanocallaghan
Copy link
Collaborator

I updated the lonely instanseg dark mode screenshot and removed the semi-useless one showing the progress bar

@petebankhead
Copy link
Member

@alanocallaghan Any reason not to make the screenshot JPEG? The PNG is big...

@alanocallaghan
Copy link
Collaborator

No, I'd have just used the default options in the screenshot tool

:class: shadow-image full-image

InstanSeg segmentation of nuclei in a fluorescent image
:::

***TODO*** Update images once InstanSeg page is complete (since images have been compressed)
### Major OMERO Extension Reset
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
### Major OMERO Extension Reset
### Major OMERO Extension Overhaul

:::

:::{figure} https://global.discourse-cdn.com/business4/uploads/imagej/optimized/3X/a/9/a970374cfd08ec4708364ca5b42807ceaaa24133_2_690x392.jpeg
### New InstanSeg Segmentation
Copy link
Collaborator

Choose a reason for hiding this comment

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

### New InstanSeg Segmentation Method

or

### New InstanSeg Extension

...?


### OME-Zarr images are now supported
The OMERO extension has been completely rewritten under the hood, improving it's flexibility and giving access to more features such as the ability to retrieve pixel values (including raw values) in the way that your server is set up.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The OMERO extension has been completely rewritten under the hood, improving it's flexibility and giving access to more features such as the ability to retrieve pixel values (including raw values) in the way that your server is set up.
The OMERO extension has been completely rewritten under the hood, improving its flexibility and giving access to more features.
It now allows you directly to retrieve raw pixel values using three different methods depending on how your extension and OMERO server are set up.

* **Got lots of things to select?** Quickly activate the selection tool by pressing 'S' when the main viewer is selected.
### OME-Zarr images are now supported 🎉

It's now possible to open and work with OME-Zarr images in QuPath! OME-Zarr was developed by the OME team in collaboration with many individuals and institutes with the goal to provide a more efficient and scalable format for large images. To get started using this file type in QuPath, drag and drop an OME-Zarr image into the main window or use the 'Open' dialog to select an OME-Zarr image. Alternatively, you can also export to OME-Zarr format.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
It's now possible to open and work with OME-Zarr images in QuPath! OME-Zarr was developed by the OME team in collaboration with many individuals and institutes with the goal to provide a more efficient and scalable format for large images. To get started using this file type in QuPath, drag and drop an OME-Zarr image into the main window or use the 'Open' dialog to select an OME-Zarr image. Alternatively, you can also export to OME-Zarr format.
It's now possible to open and work with OME-Zarr images in QuPath!
OME-Zarr was developed by the OME team in collaboration with many individuals and institutes, with the goal to provide a more efficient and scalable format for large images.
To get started using this file type in QuPath, drag and drop an OME-Zarr image into the main window or use the 'Open' dialog to select an OME-Zarr image.
Alternatively, you can also export to OME-Zarr format.


### Viewing Annotation Names
To learn more about OME-Zarr check out [this paper](https://link.springer.com/article/10.1007/s00418-023-02209-1) and how to export in QuPath [here](../advanced/exporting_images.html).
Copy link
Collaborator

Choose a reason for hiding this comment

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

don't use [here] links

### Selection mode refresh
Following on from the QuPath tour, you may of notice the toolbar is looking a little different from before.
One new button has been added which allows for quick viewing of connections between objects (if you have any).
Viewer related tools such as "show scalebar", "show grid" and "show input display" have been combined into a dropdown button so that these less frequently used tools aren't always on screen, making the toolbar less busy.
Copy link
Collaborator

@alanocallaghan alanocallaghan Jun 23, 2025

Choose a reason for hiding this comment

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

Suggested change
Viewer related tools such as "show scalebar", "show grid" and "show input display" have been combined into a dropdown button so that these less frequently used tools aren't always on screen, making the toolbar less busy.
Viewer related tools such as "Show scalebar", "Show grid" and "Show input display" have been combined into a dropdown button so that these less frequently used tools aren't always on screen, making the toolbar less busy.

These should also be guilabel if they're in the docs (although presumably not on image.sc)

I would be inclined to use backticks eg Show scalebar as it at least makes it visually distinct, but idk if that's suitable for GUI text


### Selection mode refresh
Following on from the QuPath tour, you may of notice the toolbar is looking a little different from before.
One new button has been added which allows for quick viewing of connections between objects (if you have any).
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think "(if you have any)" is redundant and a bit ambiguous? Could be objects or connections


***TODO***: Add images of log scaling once general doc update is complete
Lastly, the selection mode can now be quickly accessed by using the 'S' key when the main viewer is selected.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Lastly, the selection mode can now be quickly accessed by using the 'S' key when the main viewer is selected.
Lastly, selection mode can now be quickly accessed by using the 'S' key when the main viewer is selected.

@alanocallaghan
Copy link
Collaborator

Sections should all be "Title Case" or "Sentence case" but not a mix (I prefer "Sentence case" for titles anyway...)


:::{Figure} https://github.com/user-attachments/assets/12d7060b-35bc-40ca-89a3-f837c5417dbf
:class: mid-image
Navigating through time series and z-stacks now features a refreshed visual design, aimed at making it easier to explore your images. Additionally, for those looking to get a general overview of the z-stack, a maximum intensity projection overlay can now be displayed on top of the image. To learn more about this, check out the [multidimensional image documentation](../advanced/multidimensional_images.md).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Navigating through time series and z-stacks now features a refreshed visual design, aimed at making it easier to explore your images. Additionally, for those looking to get a general overview of the z-stack, a maximum intensity projection overlay can now be displayed on top of the image. To learn more about this, check out the [multidimensional image documentation](../advanced/multidimensional_images.md).
Navigating through time series and z-stacks now features a refreshed visual design, aimed at making it easier to explore your images.
Additionally, for those looking to get a general overview of a z-stack, you can now display an overlay using various projections (e.g., maximum or mean intensity projection).
To learn more about this, check out the [multidimensional image documentation](../advanced/multidimensional_images.md).


## 🐛 Bugs fixed
For those of you who use ImageJs macro language, this also can be used within QuPath. Although an existing QuPath feature, the ImageJ script runner has had a visual update and some under-the-hood improvements. To learn more about how to use this feature, check out the [ImageJ script runner documentation](../advanced/imagej.md#running-macros--scripts).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
For those of you who use ImageJs macro language, this also can be used within QuPath. Although an existing QuPath feature, the ImageJ script runner has had a visual update and some under-the-hood improvements. To learn more about how to use this feature, check out the [ImageJ script runner documentation](../advanced/imagej.md#running-macros--scripts).
For those of you who use ImageJs macro language, good news!
QuPath 0.6.0 features a new and improved ImageJ script runner.
Now you have much more control over how data is sent to and received from ImageJ, as well as the ability to run both groovy scripts and ImageJ macros.
The legacy ImageJ macro runner is still around if you need it, though.
To learn more about how to use this feature, check out the [ImageJ script runner documentation](../advanced/imagej.md#running-macros--scripts).

### OME.tiff exporting 8 bit
When using the Tile exporter to export an OME.tiff image, the image previously went through a RGB check that resulted in the images wrongly being converted to 8-bit.
It now exports in the correct bit depth of the original image.
### QuPath and fiji built together
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
### QuPath and fiji built together
### QuPath and Fiji built together


## 👩‍💻 Scripting and API changes
!I may not be the best person to hype this up
Copy link
Collaborator

@alanocallaghan alanocallaghan Jun 23, 2025

Choose a reason for hiding this comment

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

Suggested change
!I may not be the best person to hype this up
While QuPath has long had ImageJ support, this was somewhat limited in only running in "original ImageJ mode", meaning there was limited support for Fiji plugins and no access to ImageJ2's new features.
Building QuPath and Fiji together unlocks some of these powerful new features and many extra plugins!
You can find out more on [Building from source](https://qupath.readthedocs.io/en/latest/docs/reference/building.html#building-with-fiji).

TMA cores now by default are assigned a specific class when created, keeping them further distinguished from other annotations types.
The default color for this class is now lighter to make it easier to see for both brightfield and fluorescent images.
If a core is missing from the grid then it will be displayed the same color as the other cores but with more transparency.
Viewing the names of annotations has been tweaked to make it easier to see which label relates to which annotation, particularly when annotations are small or overlap with others. The label is now consistently displayed at the top of the annotation and better adjusts to objective changes.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Viewing the names of annotations has been tweaked to make it easier to see which label relates to which annotation, particularly when annotations are small or overlap with others. The label is now consistently displayed at the top of the annotation and better adjusts to objective changes.
Viewing the names of annotations has been tweaked to make it easier to see which label relates to which annotation, particularly when annotations are small or overlap with others.
The label is now consistently displayed at the top of the annotation and better adjusts to magnification changes.

:::{figure} https://global.discourse-cdn.com/business4/uploads/imagej/optimized/3X/a/9/a970374cfd08ec4708364ca5b42807ceaaa24133_2_690x392.jpeg
### New InstanSeg Segmentation

It's here!!! The award winning [InstanSeg](https://github.com/qupath/qupath-extension-instanseg) segmentation method from Thibaut Goldsborough you can now do so in QuPath via the InstanSeg extension. This extension provides a greatly improved accuracy in segmentation of cells for both brightfield and fluorescent images. It also gets increasingly speedy with GPU support. Learn more about InstanSeg and how to use it in QuPath [here](../deep/instanseg.md).
Copy link
Collaborator

@alanocallaghan alanocallaghan Jun 23, 2025

Choose a reason for hiding this comment

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

Suggested change
It's here!!! The award winning [InstanSeg](https://github.com/qupath/qupath-extension-instanseg) segmentation method from Thibaut Goldsborough you can now do so in QuPath via the InstanSeg extension. This extension provides a greatly improved accuracy in segmentation of cells for both brightfield and fluorescent images. It also gets increasingly speedy with GPU support. Learn more about InstanSeg and how to use it in QuPath [here](../deep/instanseg.md).
The award winning [InstanSeg](https://github.com/instanseg/instanseg) segmentation method from Thibaut Goldsborough can be used in QuPath via the [InstanSeg extension](https://github.com/qupath/qupath-extension-instanseg).
This extension provides greatly improved accuracy in segmentation of cells for both brightfield and fluorescent images.
It also gets increasingly speedy with GPU support.
Learn more about InstanSeg and how to use it in QuPath on [its page in the docs](../deep/instanseg.md).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants