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

RenameLog v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Rename a TimeSeries log in a given Workspace.

See Also

RemoveLogs, DeleteLog

Properties

Name

Direction

Type

Default

Description

Workspace

InOut

MatrixWorkspace

Mandatory

Workspace to have logs merged

OriginalLogName

Input

string

Mandatory

Log’s original name.

NewLogName

Input

string

Mandatory

Log’s new name.

Description

Rename a specified sample log of type TimeSeriesProperty in a given Workspace.

Usage

Example - Rename a sample log:

import os

nxsfilename = "HYS_11092_event.nxs"
wsname = "HYS_11092_event"

Load(Filename = nxsfilename,
    OutputWorkspace = wsname,
    MetaDataOnly = True,
    LoadLogs = True)

RenameLog(Workspace=wsname, OriginalLogName='a1b', NewLogName='A1B_New')

Output:

Categories: AlgorithmIndex | DataHandling\Logs

Source

C++ header: RenameLog.h

C++ source: RenameLog.cpp