\(\renewcommand\AA{\unicode{x212B}}\)
LoadAndMerge v1¶
Enable screenshots using DOCS_SCREENSHOTS in CMake¶
Summary¶
Loads and merges multiple runs. Similar to Load, but uses MergeRuns instead of Plus for summing.
See Also¶
Properties¶
Name |
Direction |
Type |
Default |
Description |
|---|---|---|---|---|
Filename |
Input |
list of str lists |
Mandatory |
List of input files |
LoaderName |
InOut |
string |
Load |
The name of the specific loader. Generic Load by default. |
LoaderVersion |
InOut |
long |
-1 |
The version of the specific loader |
LoaderOptions |
Input |
Dictionary |
null |
Options for the specific loader |
MergeRunsOptions |
Input |
Dictionary |
null |
Options for merging the metadata |
OutputWorkspace |
Output |
Mandatory |
Output workspace or workspace group. |
|
OutputBehaviour |
Input |
string |
Group |
Whether to group the workspaces to a workspace group or to concatenate them to a single workspace. Allowed values: [‘Group’, ‘Concatenate’] |
SampleLogAsXAxis |
Input |
string |
Sample log to be put as x-axis when concatenating; will use linear indices if left blank. |
Description¶
This algorithm loads multiple runs conforming the rules in MultipleFileProperty.
When listing is requested, the output is a WorkspaceGroup, containing items for each run.
When summing is requested, it is performed pair-wise in-situ with MergeRuns.
By doing this, the metadata (SampleLogs) are also merged governed by the rules specified in the Instrument Parameter File (IPF)
as explained in MergeRuns.
This rules can be overridden by the MergeRunsOptions input.
Specific loader can be given by the LoaderName and LoaderVersion.
If left as defaults, the algorithm will automatically find out the corresponding specific loader, deducing from the first run in the list.
It will set the name and the version of the suitable loader found as output properties in LoaderName and LoaderVersion.
The input runs must be loadable by the same specific loader, the files can not be mixed.
If the Output is hidden, i.e. the name starts with __, all the workspaces (intermediate and final) produced by this algorithm will also be hidden,
but stored in the AnalysisDataService in any case.
Usage¶
Note
To run these usage examples please first download the usage data, and add these to your path. In Mantid this is done using Manage User Directories.
out = LoadAndMerge(Filename='170257+170258,170300+170302')
print('out is a WorkspaceGroup, containing {0} workspaces'.format(out.getNumberOfEntries()))
print('the first item is the merged output of the runs 170257 and 170258 with the name {0}'.format(out.getItem(0).getName()))
print('the second item is the merged output of the runs 170300 and 170302 with the name {0}'.format(out.getItem(1).getName()))
Output¶
out is a WorkspaceGroup, containing 2 workspaces
the first item is the merged output of the runs 170257 and 170258 with the name 170257_170258
the second item is the merged output of the runs 170300 and 170302 with the name 170300_170302
Source¶
Python: LoadAndMerge.py