CloneMDWorkspace v1

../_images/CloneMDWorkspace-v1_dlg.png

CloneMDWorkspace dialog.

Table of Contents

Summary

Clones (copies) an existing MDEventWorkspace or MDHistoWorkspace into a new one.

Properties

Name Direction Type Default Description
InputWorkspace Input IMDWorkspace Mandatory An input MDEventWorkspace/MDHistoWorkspace.
OutputWorkspace Output IMDWorkspace Mandatory Name of the output MDEventWorkspace/MDHistoWorkspace.
Filename Input string   If the input workspace is file-backed, specify a file to which to save the cloned workspace. If the workspace is file-backed but this parameter is NOT specified, then a new filename with ‘_clone’ appended is created next to the original file. No effect if the input workspace is NOT file-backed. Allowed extensions: [‘.nxs’]

Description

This algorithm will clones an existing MDEventWorkspace or MDHistoWorkspace into a new one.

If the InputWorkspace is a file-backed MDEventWorkspace, then the algorithm will copy the original file into a new one with the suffix ‘_clone’ added to its filename, in the same directory. Before the clone operation, the file back-end will be updated using SaveMD v2 with UpdateFileBackEnd=True. This may delay the operation.

If you wish to clone a file-backed MDEventWorkspace to an in-memory MDEventWorkspace, we recommend that you first call SaveMD v2 with UpdateFileBackEnd=True (if necessary), followed by a simple LoadMD call to the file in question.

Categories: Algorithms | MDAlgorithms\Utility\Workspaces | MDAlgorithms\Creation

Source

C++ source: CloneMDWorkspace.cpp (last modified: 2017-05-26)

C++ header: CloneMDWorkspace.h (last modified: 2016-06-14)