Skip to content

CellProfiling/HPA_Convert_Sp8_To_OMETIF

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

61 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HPA: Convert Sp8-Tif to OME-Tif

FIJI plugin that allows to convert the ome.tif files exported from the 3D viewer in Leica's LASX (Confocal Microscope DMi8-Sp8 or Stellaris 8) to OME-Tif files suitable for the HPA LIMS. See release notes for more information.

Copyright

(c) 2022-2025, Jan N. Hansen

Contact: jan.hansen (at) scilifelab.se

Licenses

The plugin and the source code are published under the GNU General Public License v3.0.

Download

Download the latest plugin version here.

How to install?

Installing FIJI / ImageJ to your computer

FIJI is open-source, freely available software that can be downloaded here. To install ImageJ / FIJI, you only need to download the distribution of your choice and fitting to your Operating system and extract the software directory from the downloaded archive. The resulting folder can be placed anywhere on your computer (where you have read and write permissions).

On Mac OS, do not place the ImageJ / FIJI application into the Applications folder. Instead place it somewhere else than in the Applications folder, i.e. to the desktop or the documents directory. Thereby you can avoid a collision with a security feature by Mac OS, that might otherwise trigger software failures. If Mac OS does not allow you to launch FIJI by clicking the FIJI.app directory due to security concerns, run FIJI by right click (or holding option while clicking) to open more options for the file and click "open".

Installing the HPA_Convert_OPERA_To_LIMS-OMETIF FIJI plugin

  • Launch ImageJ and install the plugin by drag and drop of the downloaded .jar file into the ImageJ window (red marked region in the screenshot below):

  • Confirm the installation by pressing save in the upcoming dialog.

  • Next, FIJI requires to be restarted (close it and start it again).

  • You should now be able to start the plugin via the menu entry Plugins > Cell Profiling > Extend ome.tif from Sp8 to LIMS-like ome.tif (v...)

How to update the plugin to a newer version?

  • Download the .jar file from the latest software release (or the version release you want to change to) from the releases page in this repository.
  • Make sure ImageJ/FIJI is closed.
  • Find your ImageJ/FIJI repository and enter the plugins folder.

  • Delete the old version.
  • Paste the newly downloaded .jar file.
  • Start ImageJ/FIJI.
  • You should now be able to see that the menu entry Plugins > Cell Profiling > Extend ome.tif from Sp8 to LIMS-like ome.tif (v...) shows the new plugin version within the parantheses.

How to use?

  1. Make sure the plugin was installed
  2. Start the plugin through the FIJI menu: Plugins > Cell Profiling > Extend ome.tif from Sp8 to LIMS-like ome.tif (v...)
  3. Enter a file path for the output folder - Notes:
    1. All files for LIMS will be saved into this folder.
    2. This folder can also be selected on a mounted drive (e.g., the confocal server, from where LIMS imports images).
    3. IMPORTANT: Make sure to either (A) not name the folder already in a way that LIMS will start importing while you are still exporting files with this plugin (DO NOT name it "if") or (B) not have started acquisition yet (in this case it is ok to name it "if". This is important since otherwise you will likely get lots of LIMS errors or export errors.

  1. Click OK!
  2. A dialog pops up that asks you to list the folders you want to process.

  1. Select the folders you want to process

image

  1. Click 'Start processing'

image

  1. Now let the plugin run. It is normal that some messages are logged on the bottom.
    1. It is normal that there might be an additional window popping up with some cryptic messages. This is normal and comes from OME-TIF loading through BioFormats plugins.

  1. It is normal that there may be logging information on corrections in the OME XML data, such as the following messages for processing single-plane images:

  1. The only problem is if ERRORS appear, which will let the bar turn red at the end of the processing and the message says: "Could not process" - see under point 7.

  2. When the processing is done, the bar should turn green. If it is not green but red, you might have had processing errors.

    1. Example for successful processing: GREEN or ORANGE bar. The orange bar just indicates that there are some notifications. You can review those - they might be as specified in 6.i. and unless they are concering, all is good.

image

  1. Example for not-successfully processed images: The bar has turned red at the end of the processing and the message says: "Could not process" for certain files. If you cannot source the problem back to a wrong setting or export from Leica LASX, please submit an issue as follows: Click on the messages, press Control+A or Cmd+A to mark all messages, press Control+C or Cmd+C to copy all of the messages, submit with a notification explaining the issue to be submitted here to ask for feedback from the developer. Make sure to answer follow up questions from the developer.

image

  1. If processing was successful, you can proceed to LIMS upload: Copy the output folder to the folder from where LIMS imports files and rename it to the name that is required for LIMS import (if<4-digit plate number>)