GatherWorkspaces dialog.
Table of Contents
Stitches together the input workspaces provided by each of the processes into a single workspace.
| Name | Direction | Type | Default | Description |
|---|---|---|---|---|
| InputWorkspace | Input | MatrixWorkspace | Mandatory | |
| OutputWorkspace | Output | MatrixWorkspace | ||
| PreserveEvents | Input | boolean | False | Keep the output workspace as an EventWorkspace, if the input has events (default). If false, then the workspace gets converted to a Workspace2D histogram. |
| AccumulationMethod | Input | string | Append | Method to use for accumulating each chunk from mpi processorss. - Add: the processed chunk will be summed to the previous output (default). - Append: the spectra of the chunk will be appended to the output workspace, increasing its size. |
GatherWorkspaces is only availble for MPI builds. It stitches together the input workspaces provided by each of the processes into a single workspace in the root process. The spectra in the output workspace will be ordered by the rank of the input processes. It is up to the caller to ensure this results in the required ordering. Furthermore, there are all sorts of things that ought to be consistent for this algorithm to make sense (e.g. the instrument). The general philosophy, though, is to leave the responsibility for this to the user and only check the vital things (i.e. that the number of bins is consistent).
Categories: Algorithms | MPI