\(\renewcommand\AA{\unicode{x212B}}\)

RemoveInstrumentGeometry v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Removes instrument geometry records from a given workspace.

Properties

Name

Direction

Type

Default

Description

InputWorkspace

Input

Workspace

Mandatory

An input workspace.

OutputWorkspace

Output

Workspace

Mandatory

An output workspace.

MDExperimentInfoNumbers

Input

int list

For MD workspaces, the ExperimentInfo indices to have the instrument removed.If empty, the instrument will be removed from all ExperimentInfo objects.The parameter is ignored for any other workspace type.

Description

Remove Instrument Geometry from workspace.

Usage

Example - RemoveInstrumentGeometry

# create some workspace with an instrument
ws = CreateSampleWorkspace()
print("Instrument Geometry exists:  {}".format(ws.getInstrument().nelements() > 0))

# delete instrument geometry
ws = RemoveInstrumentGeometry(ws)
print("Instrument Geometry is empty:  {}".format(ws.getInstrument().nelements() == 0))

Output:

Instrument Geometry exists:  True
Instrument Geometry is empty:  True

Categories: AlgorithmIndex | Utility\Workspaces

Source

C++ header: RemoveInstrumentGeometry.h

C++ source: RemoveInstrumentGeometry.cpp