GetTimeSeriesLogInformation v1#

Warning

GetTimeSeriesLogInformation is deprecated (on 2025-11-21) and has no replacement.

Summary#

Get information from a TimeSeriesProperty log.

See Also#

AddSampleLogMultiple

Properties#

Name

Direction

Type

Default

Description

InputWorkspace

InOut

MatrixWorkspace

Mandatory

Input EventWorkspace. Each spectrum corresponds to 1 pixel

OutputWorkspace

Output

MatrixWorkspace

Dummy

Name of the workspace of log delta T distribution.

InformationWorkspace

Output

TableWorkspace

Mandatory

Name of optional log statistic information output Tableworkspace.

LogName

Input

string

Log’s name to filter events.

TimeRangeOption

Input

string

Relative Time (second)

User defined time range (T0, Tf) is of absolute time (second). Allowed values: [‘Absolute Time (nano second)’, ‘Relative Time (second)’]

FilterStartTime

Input

number

Optional

Earliest time of the events to be selected. It can be absolute time (ns), relative time (second) or percentage.

FilterStopTime

Input

number

Optional

Latest time of the events to be selected. It can be absolute time (ns), relative time (second) or percentage.

TimeStepBinResolution

Input

number

0.0001

Time resolution (second) for time stamp delta T disibution.

IgnoreNegativeTimeInterval

Input

boolean

False

If true, then the time interval with negative number will be neglected in doing statistic.

Description#

Get information from a TimeSeriesProperty log.

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.

Example - Get Information Using Run Object (Recommended)

w=Load('CNCS_7860')

speed5_stats = w.run().getStatistics("Speed5")
print("duration {:.3f}".format(speed5_stats.duration))
print("minimum {:.3f}".format(speed5_stats.minimum))
print("maximum {:.3f}".format(speed5_stats.maximum))
print("mean {:.3f}".format(speed5_stats.mean))
print("time_mean {:.3f}".format(speed5_stats.time_mean))

Output:

duration 171.702
minimum 299.800
maximum 300.000
mean 299.900
time_mean 299.888

Example - Get Information from One Log

w=Load('CNCS_7860')

result = GetTimeSeriesLogInformation(InputWorkspace=w,LogName='Speed5',InformationWorkspace='info')

for i in [0,5,6,7,8]:
   row = result[1].row(i)
   print("{Name}  {Value:.3f}".format(**row))

Output:

Items  4.000
Average(dT)  39.239
Max(dT)  53.984
Min(dT)  29.953
Sigma(dt)  10.543

Categories: AlgorithmIndex | Diffraction\Utility | Events\EventFiltering | Deprecated

Source#

C++ header: GetTimeSeriesLogInformation.h

C++ source: GetTimeSeriesLogInformation.cpp