Wiki

Clone wiki

WADQC / Manual Input

Manual Input (concept)

Most modules are automatically executed by the processor whenever a suitable dataset is found by the selector. In some cases however the module requires additional manual input before the analysis should be started.
Example: An EARL SUV validation measurement for PET-CT requires the input of residual dose of the empty syringe. This is not always known at the moment of performing the scan and/or there's no suitable dicom field to put this information into. Solution: Make use of a "manual input" selector (property can be set when creating/modifying a selector). For these selectors, the processor will wait until manual input is provided by the user before starting the module.

Selector

[Screenshot]

Activate the "manual input" option.

Module Config

The module config should contain a section "manual_input" containing the parameters that should be entered manually:

{
    "cfgformat": "20180910", 
    "actions": {
    },
    "𝐦𝐚𝐧𝐮𝐚𝐥_𝐢𝐧𝐩𝐮𝐭": {
    },
    "info": {
    },
    "comments": {
    }
}

Each sub-entry is of the form:

    "manual_input: {
                "𝐩𝐚𝐫𝐚𝐦𝐞𝐭𝐞𝐫_𝐧𝐚𝐦𝐞": {
                    "𝐝𝐞𝐬𝐜": "𝐟𝐮𝐥𝐥 𝐝𝐞𝐬𝐜𝐫𝐢𝐩𝐭𝐢𝐨𝐧 𝐡𝐞𝐫𝐞",
                    "𝐭𝐲𝐩𝐞": "𝐟𝐥𝐨𝐚𝐭",
                    "𝐯𝐚𝐥" : "𝟏.𝟎𝟐",
                    "𝐫𝐞𝐪𝐮𝐢𝐫𝐞𝐝" : "𝐭𝐫𝐮𝐞"
                },
                {
                    ...
                }
    }

Above parameter will render as follows on the input form:

[picture here]

Note: when the manual_input section is not present, the selector/process will be treated as normal (no intermediate status "waiting for input").

  • parameter_name: will be used as label for the input field (spaces or special characters are not allowed!!)
  • desc: full description that will be shown to the right of the input field [optional]
  • type: data type, used for validating the input. Supported types: float, string, bool, date, datetime
  • val: initialization value of the form input [string, optional]

    • float: e.g. 1.02 or 1.02e-3 (use point as decimal separator)
    • bool: "false" or "true"
    • date/datetime: ignored, initialized to current date(time)

    Dicom-tags are supported as well (only for types float, string, date). These have to be of the form (aaaa,bbbb) or (0xaaaa,0xbbbb).

  • required: specify whether input is obligatory ["false" or "true"; optional, default "false"]

Input page

The manual input parameters can be found in the main menu of waddashboard, under "Manual Input". After submitting the information, the process will be started automatically.

Updated