Modules

Workflow handling

Implement workflow handling outcome based on a variety of metrics (e.

Description

Implement workflow handling outcome based on a variety of metrics (e.g. object counts, image measurements, metadata values). Outcomes can include termination of the analysis and redirection of the active module to another part of the workflow. Redirection allows parts of the analysis to skipped.

Parameters

Parameter Description
Test mode Controls what condition is being tested:
  • "Image measurement" Numeric filter against a measurement (specified by "Image measurement") associated with an image from the workspace (specified by "Input image").
  • "Metadata numeric value" Numeric filter against a metadata value (specified by "Metadata value") associated with the workspace. Metadata values are stored as text, but this filter will attempt to parse any numeric values as numbers. Text comparison can be done using "Metadata text value" mode.
  • "Metadata text value" Text filter against a metadata value (specified by "Metadata value") associated with the workspace. This filter compares for exact text matches to a reference, specified by "Reference text value"
  • "File exists" Checks if a specified file exists on the accessible computer filesystem.
  • "File doesn't exist" Checks if a specified file doesn't exist on the accessible computer filesystem.
  • "Fixed value" Numeric filter against a fixed value.
  • "Object count" Numeric filter against the number of objects contained in an object collection stored in the workspace (specified by "Input objects").
Input image If testing against an image measurement ("Test mode" set to "Image measurement"), this is the image from which that measurement will be taken.
Input objects If testing against an object count ("Test mode" set to "Object count"), this is the object collection which will be counted.
Numeric filter mode Numeric comparison used to determine whether the test passes or fails. Choices are: Less than, Less than or equal to, Equal to, Greater than or equal to, Greater than, Not equal to.
Text filter mode Text comparison used to determine whether the test passes or fails. Choices are: Contains, Does not contain, Equal to, Not equal to.
Image measurement If testing against an image measurement ("Test mode" set to "Image measurement"), this is the measurement from the image (specified by "Input image") that will be tested.
Metadata value If testing against a metadata value (either text or numeric) associated with the active workspace ("Test mode" set to "Metadata text value"), this is the value that will be tested.
Reference numeric value If testing against a numeric value, this is the reference value against which it will be tested. What classes as a pass or fail is determined by the parameter "Numeric filter mode".
Reference text value If testing against a text value, this is the reference value against which it will be tested. What classes as a pass or fail is determined by the parameter "Text filter mode".
Fixed value If testing against a fixed numeric value ("Test mode" set to "Fixed value"), this is the value that will be tested.
Generic format Format for a generic filename. Plain text can be mixed with global variables or metadata values currently stored in the workspace. Global variables are specified using the "V{name}" notation, where "name" is the name of the variable to insert. Similarly, metadata values are specified with the "M{name}" notation.
Continuation mode Controls what happens if the termination/redirection condition is met:
  • "Redirect to module" The analysis workflow will skip to the module specified by the "Redirect module" parameter. Any modules between the present module and the target module will not be evaluated.
  • "Terminate" The analysis will stop evaluating any further modules.
Redirect module If the condition is met, the workflow will redirect to this module. In doing so, it will skip evaluation of any modules between the present module and this module.
Show redirect message Controls if a message should be displayed in the log if redirection occurs.
Redirect message Message to display if redirection occurs.
Message level Controls the logging level in which the message will be displayed. Warnings are enabled for users by default, but debug and message aren't.
Show termination warning
Export terminated workspaces Controls if the workspace should still be exported to the output Excel spreadsheet if termination occurs.
Remove images from workspace Controls if images should be completely removed from the workspace along with any associated measurements if termination occurs.
Remove objects from workspace Controls if objects should be completely removed from the workspace along with any associated measurements if termination occurs.