- Guide
- Imaging
- Image analysis templates
Image Analysis Templates
A template is a tuned pipeline kept under a name, with its own versions and its own sign-off, so a lab can agree on one way of measuring and reach for it again.
Saving a Template
Once you have tuned an image analysis until it finds what you meant, Save as template, in the Template menu on the Pipeline heading, keeps that way of measuring under a name, so next week's plate is measured the same way. It works once a run has produced results.
It also waits for a run whenever you have changed a setting since the last one, so a template always holds settings whose results you have seen.
Give it a name, and a description saying when to reach for it and on what kind of image.
The Template Library
Templates in the Analysis tab's header opens the library, and so does Browse templates in the Template menu of an open image analysis. Search the library by name, description, or who saved it. Each row shows the number of steps it holds, how many results were built from it, and who saved it.
To take a template to another project or another lab, open it and choose Export from the ⋯ menu in its header, and bring one in by dropping its file on the drop zone above the list. Image Analysis Pipeline Files covers both, and what the file holds.
Opening a template shows what it holds and what has come of it, across three tabs.
- Details opens on its Description, then lists its Steps in the order they run, its Controls, and its Versions, with Apply template at the foot.
- Connections maps what the template is connected to. Every image analysis built from it appears here, and clicking through to one opens it.
- Activity holds comments and sign-off alongside the template's own history, so a lab can agree on a standard way of measuring there. A template someone approved says so on its row back in the library.
The line to each result shows the template version it was built on, such as applied to · v2, and results group by that version. A line to a result made from an earlier version is amber, and hovering it says which version the template is at now. Its numbers stay as the steps that ran at the time computed them, and you decide whether to run the newer version.
From any item on the map you can re-center on it and keep going, which is how you get from a template to the images an analysis read.
Click the description to change it, or Add a description… on a template that has none. Enter saves, Shift+Enter starts a new line, and Esc cancels. Members who can only view the project read it without editing.
Versions
Versions lists every version the template has had, newest first, with who published each one and when. The newest is marked Current.
Each version names the settings it changed from the one before, such as Smallest object or Channels, and version 1 reads First version. A version that added or removed a step reads Steps, and a template imported from a file reads Imported from and the file's name. Renaming a template or editing its description adds no version.
See what changed on any version after the first opens a comparison of it against the version before. It reads like the comparison described under Comparing With a Newer Version.
Seeing Which Version You're On
An image analysis started from a template names it under the Pipeline heading, as "From" the template's name and the version it was built from. Once you change a setting, a second line counts the settings that differ from that version and names them, with an Update template link beside them. Until you run the changed settings, the link reads Run these settings to update the template instead. A template that has since been deleted reads From a template no longer in this project.
A run of one image among several is a preview, and the analysis's run history leaves it out. Once this image analysis has runs in that history, run the changed settings with Run on all to update the template.
When a teammate has published a newer version since, the line turns amber and says which version is available. It offers no Update template link then, because publishing your settings would replace their version with ones built on the older one.
An image analysis started from a template another team shared adds that team to the line, as in shared by Imaging Core. The line still counts the settings you changed. It offers no Update template or See what changed, because the template and its versions belong to the owning team. Save as template keeps your settings as a template of your own.
Comparing With a Newer Version
See what changed on that line opens a comparison in place of the results, laid out like a note's version comparison. It opens on this image analysis against the newest version.
Changes lists the steps in the order they run. A step that differs shows its changed settings, old value then new, and a step one side added or removed is marked + or − at its place in the pipeline. A setting you changed since the image analysis was built is marked Your change, because using the newer version replaces it.
Side by side shows both sides' steps in full. Pick any kept version on either side from the two lists at the start of the bar above the comparison.
Use version appears while the first list shows this image analysis. It loads the version in the second list and records it as the version this image analysis is built from. Nothing runs. The results on screen stay until you run again, and the workspace says they came from the earlier settings. Close goes back to the results as they were.
Publishing Your Changes
The Template menu has Update template too. It opens a dialog box naming the version your settings would become, with What changes listing the settings that differ from the template, Steps among them when you added or removed one.
Update template in the dialog box publishes them as that version, and marks this image analysis as built from it. Everything built from earlier versions keeps the settings and results it has.
If a teammate publishes a version while the dialog box is open, Update template stops and says so. Close it and open Update template again to compare your settings with theirs. A rename or a Controls edit that meets a teammate's newer save stops the same way, and opening the template again shows theirs.
Applying a Template
Apply template takes you to the images, and so does picking a template on the start screen of New analysis (see Starting From a Shared Template). Name the result, set whether it is Shared or Private, pick the collections or individual images to run it over, and Start analysis opens a new image analysis with the template's steps and settings already in place.
Applied from the Template menu inside an image analysis, the new image analysis starts on that analysis's images, so there is nothing to pick. Name it, set Project or Private, and press Start analysis. Choose other images opens the collections instead. The image analysis you started from stays as it was.
Once you have picked, the dialog box reports how many of those images the template runs on, and names each one it cannot with what that image is missing. A flattened JPEG has no separate channels to give a template that reads two, and a LIF can hold fewer channels than the template reads.
A template that filters objects by their size in µm² needs each image's scale, so an image without one is named as well. Set its scale and the template runs on it. You can still run a template over a mixed set, and the images it skips are named before it starts. The new image analysis can be tuned further from there, and it records which template and which version it came from.
Controls
A control check records what a control image should measure. A template holds it in its Controls card. On a template with no range yet, the card reads Set a control range, and Add a range opens the rows. Members who can only view the project see the card once a range is set.
An image analysis has it as a step, added from Add step under Aggregate as Check controls, sitting last in the pipeline. Open the step to reach its ranges.
Setting a Range
Each row reads as a sentence. Pick a condition your images are labeled with, such as blank, choose how the range is bounded, and give the number or numbers it takes.
| Bound | Numbers it takes | Reads as |
|---|---|---|
| between | Two | 0 to 3, both ends included |
| at least | One | 500 or more |
| more than | One | Above 500 |
| at most | One | 3 or less |
| less than | One | Below 3 |
A positive control that should clear 500 with no ceiling is written at least 500, so a plate that measures 4000 passes.
A pipeline that measures several things per image is checked on the first of them, so an area coverage control is a range of Area covered written as a fraction, such as 0 to 0.05 for up to 5%.
Where the run on screen already covered that condition, the row has a button offering the lowest and highest its images measured, which fills the boxes when you press it. Those numbers come from this run, so read them before you take them.
Outside that, flag as on the control's last line sets how loudly a miss reports, as Note, Warning or Error. A control never changes a number and never stops a run, so the severity sets how hard the miss is to walk past.
What a Miss Reports
Every run that covers one of those images checks it, and a blank well that counts 40 is named in Checks with the number it reached, and shows in Accept run above the choices, so you read the verdict before your name goes on the run. The run keeps the numbers it measured either way.
Open the step against a finished run and it lists that run's control images below the ranges, one row each with the image, its condition, what it measured, what was expected, and whether it passed.
Labeling Control Images
A control keys on the condition label on its images, so label them first. Label images opens the grid the comparison uses, covering that analysis's own images, from the ⋯ menu at the top of an analysis and from the control step itself.
Each condition the step offers says how many images have it, so a label you do not recognize is one you can count before you write a range for it.
An image inside a multi-image file, such as a series in a LIF, can have no label. An analysis whose images are all series therefore has no Label images on that menu, and nothing for a control to key on.
Sharing and Deleting
Templates are shared with everyone on the project. Anyone on the project can open the library, read a template and its versions, and join the discussion. Saving, updating, renaming, sharing, applying, and deleting stay with members who can edit.
Delete template moves a template to the trash with its versions, where it can be restored for 30 days. Everything built from it keeps the steps it ran and the results they produced.
Sharing a Template With Other Teams
An imaging core that settles on one way of counting can share that template with the labs it serves. Each lab applies it to its own images, and a lab that needs a version of its own makes a copy.
Other teams can be added once your team has joined an organization. The template's creator and the project lead can share it.
- Open the template from the library and choose Share from the ⋯ menu in its header.
- Under Other teams, press Add beside a team to share with that team, or beside a unit of your organization to share with every team under it.
- Press Done. Changes save as you make them.
Each team you add gets Can view, which lets its members open the template, apply it and make their own copy. Your template changes only when your project changes it.
A template you share reads Shared outside on its row in the library. Removing a team from the dialog box ends its access.
Templates From Other Teams
Templates other teams share with yours are listed in the library under From other teams, below your own under This project. Each heading counts its rows, and each shared row names the owning team and the unit it was shared with. Search covers both lists.
A shared template opens read-only, under a View only banner that names the owning team. It shows the template at that team's current version, with the following.
- its Description, its Steps and its control ranges
- Export in the ⋯ menu, which writes that version as a pipeline file
- Apply template and Make a copy, for members who can edit
Its earlier versions, the results built from it, its comments and its sign-off stay with the owning team.
Applying a Shared Template
Apply template works as it does for one of your own, described under Applying a Template. New analysis offers shared templates on its start screen too.
The new image analysis is yours. It holds the steps and settings the template had when you applied it, and it records the template, its version and the team it came from. When the owning team publishes a newer version, your image analysis and its results stay as they are.
Making a Copy
Make a copy, in the open template's header, puts the template in your project as your own, with the steps and settings of the version you were reading. The copy starts at version 1 and is yours to rename, edit, publish and share. Later changes to the original show on the original, under From other teams.
Tip: Ask your AI assistant for a project's templates and it can run one for you on a set of images, then show you the numbers before anything is saved. It reads the same settings and versions as the library, so it can list what changed between two versions, and when you ask it can save an image analysis as a template or publish its settings as the next version. See Connect Your AI Assistant.