Process Related Arrays and Objects¶

A process describes an operation aimed at creating, modifying, or formatting data, which are ultimately stored or referenced within a dataset. Processes have inputs and outputs and can be directly linked to a dataset or to another process.

A list of processes related to a particular group provides information on how the data was created, including an acquisition instrument configuration, specific hardware process, or software process.

The processes can be chained to create a particular data using a "processId" linking to the previous process in the chain.

classDiagram
   Processes --> "0..n" inputs
   Processes --> "0..n" outputs
   Processes --> "1" ProcessName
   classDef default fill:#fff,stroke:#000000,color:#000000

processes array¶

This array describes multiple processes.

Property	Type	Description
id `required`	integer	The unique process id in the JSON structure
implementation	string	The process implementation type, can be `Software` or `Hardware`
inputs	object	An inputs object describing the different inputs of the process
outputs	object	An outputs object describing the different outputs of the process
dataMappingId	integer	The unique Id of the referenced dataMappings array
One of the following `required` subobjects: ultrasonicConventional ultrasonicPhasedArray ultrasonicMatrixCapture totalFocusingMethod tfmBoxGates thickness gain

inputs object¶

Property	Type	Description
groupId `required`	integer	A valid group id in the JSON structure
processId `required`	integer	A valid process id in the JSON structure
outputIds	array	An array containing the specific outputs of the previously referenced process

outputs object¶

Property	Type	Description
id `required`	integer	The unique process output id of the specific process
datasetId	integer	A valid and unique dataset id for the group
parameters	object	A simple object storing the parameters related to the given ouput of the process