LoadMuonLog v1

../_images/LoadMuonLog-v1_dlg.png

LoadMuonLog dialog.

Summary

Load log data from within Muon Nexus files into a workspace.

Properties

Name Direction Type Default Description
Workspace InOut MatrixWorkspace Mandatory The name of the workspace to which the log data will be added.
Filename Input string Mandatory The filename (including its full or relative path) of the Muon Nexus file.

Description

The Algorithm is very similar to LoadLog v1, except that the source of the data is a Muon Nexus file.

Parent Algorithm

LoadMuonLog is also a child algorithm of LoadMuonNexus v2, i.e. it gets called whenever LoadMuonNexus is executed.

Usage

Note

To run these usage examples please first download the usage data, and add these to your path. In MantidPlot this is done using Manage User Directories.

Example - Loading Log Data into Dummy a Workspace:

# Create a dummy workspace and load in the log data from a file.
fake_emu_ws = CreateSampleWorkspace()
LoadMuonLog(fake_emu_ws, "MUSR00015189.nxs")

# Extract a property from the log.
time_series_prop = fake_emu_ws.run().getLogData("BEAMLOG_FREQ")

print "BEAMLOG_FREQ is a TimeSeriesProperty with %i entries." % time_series_prop.size()
print "The first entry is %f." % time_series_prop.firstValue()

Output:

BEAMLOG_FREQ is a TimeSeriesProperty with 10 entries.
The first entry is 50.000000.

Categories: Algorithms | DataHandling\Logs | Muon\DataHandling

Source

C++ source: LoadMuonLog.cpp

C++ header: LoadMuonLog.h