Top


Introduction

OMERO.mtools is a suite of MATLAB-based tools which allow you to perform common image analysis tasks on images stored in an OMERO.server. OMERO.mtools has its own GUI and only requires an installation of the MATLAB Compiler Runtime (MCR) to run.

A link to a video of a demonstration of the workflows can be found in the Other resources section at the bottom of the page.


Setup

  1. Download the appropriate OMERO.mtools for your operating system from:

    https://downloads.openmicroscopy.org/mtools/1.3.1/

    If you are using Windows, it is recommended to also download the MCR for Windows.


    ../images/workflowsMtoolsDownload.jpg

  2. Install OMERO.mtools and MCR if you do not have a Matlab installation.


    Windows:

    It is recommended that you download the MCR from the downloads page above, and install it before running the OMERO.mtools installer to speed up the installation.


    ../images/workflowsMtoolsMCRInstall.jpg


    Note

    The OMERO.mtools installer will automatically download the Matlab Compiler Runtime (MCR) from Mathworks and install it, but slow server speeds makes this painful, hence the recommendation to install it separately first.


    Unzip the OMERO.mtools download and double-click on it, and follow the prompts to install.

    Click Login.


    ../images/workflowsMtoolsInstallWindows.jpg


  3. Mac OSX:

    Unzip the OMERO.mtools download and double-click on it, and follow the prompts to install.

    On Mac OS X, the MCR is bundled with OMERO.mtools, so no separate installation is needed.


    ../images/workflowsMtoolsInstallMac.jpg


    Note

    If you have a Matlab installation and wish to use that, download and install the source code from Github: https://github.com/mporter-gre/mtools


  4. In Windows click on the Start button and select All Programmes > OMEROmtools.

    In Mac in the Applications folder double click on OMEROmtools > application > OMEROmtools.app.


    ../images/workflowsMtoolsOpen.jpg

  5. Enter your OMERO User name, Password and Server name.

    Click on the appropriate button to select the desired function.


    ../images/workflowsMtoolsCredentials.jpg

  6. Following are illustrations of two of the functionalities covered by OMERO.mtools.




Note

Images have to be organized in the Project-Dataset hierarchy to be accessed via OMERO.mtools. Datasets not in a Project or orphaned Images cannot be accessed via OMERO.mtools.


Box It


Box It draws ROIs around structures through all of the planes in the Z-stack for use in subsequent analysis.


  1. Click on the Box It button to start.


    ../images/workflowsMtoolsBoxIt.jpg

  2. Select the OMERO group you wish to access data from.

    Click OK.


    ../images/workflowsMtoolsGroup.jpg


  3. Select Open Image... from the File menu.


    ../images/workflowsMtoolsOpenImage.jpg

  4. From the drop-down menus in the Image Chooser, select the project, dataset and image you wish to open.

    Click OK.


    ../images/workflowsMtoolsImageChooser.jpg


  5. Click on the ROI drawing tool to draw an ROI around a structure.

    The first ROI drawn triggers the download of the data, which may take a minute or two.

    The dotted line should be drawn generously round the structure as it will resize automatically to minimally fit the structure.


    ../images/workflowsMtoolsDrawROI.jpg


  6. Click on the Selection tool to select an ROI, the selected ROI is green.

    If necessary, an ROI can be deleted by selecting it and clicking the Delete button.


    ../images/workflowsMtoolsSelectROI.jpg


  7. Select File > Save ROIs to save the ROIs to the OMERO server.

    Use the Next Image and Previous Image buttons to move to the other images in the dataset and repeat Step 5 to draw ROIs on other images in the Dataset.


    ../images/workflowsMtoolsSaveROIs.jpg


Intensity Measure


Intensity Measure can be used to measure the signal from objects identified within ROIs, as well as background intensities around these objects. ROIs can be drawn using Box It or any other OMERO method.


  1. Click on the Intensity Measure button to start.

    https://www.openmicroscopy.org/omero/downloads


    ../images/workflowsMtoolsIntensityMeasure.jpg

  2. Select the OMERO group you wish to access data from.

    Click OK.


    ../images/workflowsMtoolsGroup.jpg


  3. From the File menu select the Choose Datasets.


    ../images/workflowsMtoolsOpenIM.jpg


  4. Select the Project containing the data from the Projects drop-down menu.

    Select the required Datasets from the Datasets list box.

    Click on the + button between the list boxes to add the required dataset.

    Click OK.


    ../images/workflowsMtoolsSelectIM.jpg


  5. Select the Image for analysis from the Select Image drop-down menu.

    Select the channel to be analysed from the drop-down menu in the Segment section.

    Use the slider to change the threshold for segmentation, if needed.


    ../images/workflowsMtoolsAnalyseIMTop.jpg


  6. Check the required channels in the Measure directly (measure signal within the ROIs) and Measure around (measure background around the ROIs) checkbox lists.

    Check the Use checkbox and enter the number of pixels for the annulus and pixel gap values in the text boxes.

    Select the Save mask to server checkbox.

    Click OK.


    ../images/workflowsMtoolsAnalyseIMBottom.jpg


  7. Follow the prompts to save the results as .csv files.

    The results include intensity values and related statistics for all the Images within the dataset that contain ROIs.


    ../images/workflowsMtoolsResults.jpg


  8. Other resources


    A video of this workflow can be seen at:

    OMEROmtools.mp4




    All Tutorial Material is available on line at: help.openmicroscopy.org

    The Main OME website is at: www.openmicroscopy.org