Creating Workflows

Creating a new workflow from scratch

Introduction

Workflows can be created and edited from editing view. Modules are assembled into a linear sequence that forms the workflow. Each module has its own independent set of parameters which can be configured by selecting that module from the workflow list. Images and objects created by modules are available to subsequent modules in the workflow, as are other items such as measurements, metadata and object relationships.

In this guide we will cover adding modules, setting the input file, configuring modules, configuring output Excel formats and setting parameters to be visible in processing view.

If you haven't already done so, at this point it's also worth looking at theexample workflows. These workflows include key modules used in the majority of analyses, each of which has accompanying notes, explaining its configuration.

Accessing editing view

• By default, MIA will open in processing view. To switch to editing view, select "View > Switch to editing view" from the MIA menu.
  • The layout of editing view is covered in the editing view guide.

Adding and arranging modules

• A list of available modules can be viewed by clicking the + button in the top-left corner of the MIA interface.
  • Modules are grouped into general categories and sub-categories.
  • To view a description of each module, hover the mouse over its name.
  • Full documentation of each module can be found in the Modules pages.
• Click a module to add it to current workflow.
  • If any modules in the current workflow are selected, the new module will be inserted immediately after them. Otherwise, it will be added to the bottom of the list.
• Modules can also be discovered and added using the module search feature.
  • Access search via either the menu bar ("View > Show module search") or by clicking "Search for module" in the available module list.
  • Search will always match modules based on the module name, but can optionally be set to also search in the module and/or parameter descriptions using the "Include module/parameter descriptions" checkboxes.
  • Detected modules need only match one search word; however, mandatory words can be specified using quotation marks.
  • Add detected modules to the current workflow using the + button to their right.
• Selected module(s) can be removed using the - button and moved up and down with the ? and ? buttons.
  • Modules can also be moved by dragging them to a new position in the workflow.

Selecting files to process

• Files or folders being processed are specified in the always-present Input controlmodule, which can be found above the current workflow.
• The "Input path" parameter specifies either a file or folder that the analysis will be run on.
  • The selected file only acts to provide a root path from which the analysis runs. The image at this location isn't automatically loaded into the MIA workspace, instead this is done by a variety of image loading modules (see Input/output modules).
  • This fine-grain control over image loading allows us to load sub-sets of image stacks (e.g. a single channel) and gives greater control of the images stored in memory at any given time.
  • A copy of the Load image module is automatically included with all new workflows.
• If a folder is selected, all files contained within (and within sub-folders) can be processed.
  • In this "batch" mode, only files matching specified filters will be processed.

Configuring modules

• View the parameters associated with a module by clicking its name in the current workflow.
  • Parameters are grouped into sections, divided by blue headers.
• Parameters can have many different types (e.g. text inputs, available objects or choices).
  • Generally, each parameter should only allow valid inputs. For example, object selectors will only show objects detected by preceding modules, but not those from subsequent modules.
• Specific parameters can be added to processing view by toggling the visibility button to the right of the parameter.
  • The icons indicates a visible (editable) parameter and one that will not be visible.
• It's also possible to allow modules to be disabled from processing view by selecting "Can be disabled" from the top of the parameter window.
  • When selected, a power icon ( or ) will be displayed next to the module name in processing view.
• Modules and parameters can be renamed by right-clicking on their name.

Configuring output results format