Skip to content

vanvalenlab/kiosk-imageJ-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DeepCell Kiosk Banner

Build Status Coverage Status License

The kiosk-imageJ-plugin is a ImageJ 1.x plugin for easily processing images with an existing DeepCell Kiosk from within ImageJ. The plugin is also compatible with ImageJ 2, FIJI, and QuPath.

Please see our introductory repo for an overview of the DeepCell ecosystem.

NOTE: Due to limitations with how images are passed between the different platforms, we cannot generate both types of segmentation predictions, so we defaulted to showing the whole-cell predictions. Either the website or a local installation can be used to generate both sets of predictions for an image.

How to install

  1. Download the latest JAR file.
  2. Open ImageJ.
  3. Navigate to Plugins > Install...
  4. Select the downloaded JAR file.
  5. Install it into the plugins folder.

How to Run the plugin

  1. Open an image in ImageJ.

image

  1. Navigate to Plugins > DeepCell Kiosk > Submit Active Image.

image

  1. If you're running one of our pretrained models, please make sure the settings all match the screenshot below. If you're running your own Kiosk, make sure to update the IP address for your custom instance.

image

  1. Select which model you wish to run ("mesmer" is the default). Please see our documentation for data requirements for the different model types.

image

  1. Click OK to run the job.
  2. Await your results! They should be automatically downloaded and opened.

How to draw outlines and add them to the ROI Manager with the segmented image in ImageJ

  1. Select the newly-generated segmented image.
  2. Navigate to Plugins > DeepCell Kiosk > Create Label Overlay
  3. Navigate to Image > Overlay > To ROI Manager. The results should populate in your ROI Manager and you can proceed with any downstream analysis.

QuPath Integration

QuPath supports ImageJ and this plugin can be used within the QuPath's internal ImageJ instance.

  1. Configure the QuPath's ImageJ plugin directory.
  2. Open the image to process in QuPath.
  3. Send the image to ImageJ (Extensions/ImageJ/Send region to ImageJ).
  4. Process the image normally.
  5. Only overlays and ROIs can be sent back to QuPath. Create an Overlay from the resulting label image (Plugins/DeepCell Kiosk/Create Label Overlay).
  6. Send the resulting overlay back to QuPath (Plugins/Send Overlay to QuPath).

For more advanced usage with QuPath, please see this groovy script from Pete Bankhead.