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

Run

This is a Python binding to the C++ class Mantid::API::Run.

class mantid.api.Run

addProperty((Run)self, (str)name, (object)value, (bool)replace) → None :

Adds a property with the given name and value. If replace=True then an existing property is overwritten

addProperty( (Run)self, (str)name, (object)value, (str)units, (bool)replace) -> None :

Adds a property with the given name, value and unit. If replace=True then an existing property is overwritten

endTime((Run)self) → DateAndTime :

Return the total ending time of the run.

get((object)self, (object)key, (object)default) → object :

Returns the value pointed to by the key or the default value given.

get( (object)self, (object)key) -> object :

Returns the value pointed to by the key or None if it does not exist.

getGoniometer((Run)self[, (int)index=0]) → Goniometer :

Return Goniometer object associated with this run by index, default first goniometer.

getLogData((Run)self, (str)name) → Property :

Returns the named log. Use ‘.value’ to return the value. The same as getProperty.

getLogData( (Run)self) -> std_vector_property :

Return the list of logs for this run. The same as getProperties.

getNumGoniometers((Run)self) → int :

Return the number of goniometer objects associated with this run.

getProperties((Run)self) → std_vector_property :

Return the list of run properties managed by this object.

getProperty((Run)self, (str)name) → Property :

Returns the named property (log value). Use ‘.value’ to return the value.

getPropertyAsSingleValue((Run)self, (str)name) → float :

Return a log as a single float value. Time series values are averaged.

getPropertyAsSingleValueWithTimeAveragedMean((Run)self, (str)name) → float :

Returns a log as a single float value. Calculated using time-averaged mean.

getProtonCharge((Run)self) → float :

Return the total good proton charge for the run

getStatistics((Run)self, (str)name) → TimeSeriesPropertyStatistics :

Returns the all of the statistics about the obect

getTimeAveragedStd((Run)self, (str)name) → float :

Returns the time averaged standard deviation

getTimeAveragedValue((Run)self, (str)name) → float :

Returns the time averaged value of a log

getTimeROI((Run)self) → TimeROI :

Return the time regoin of interest

hasProperty((Run)self, (str)name) → bool :

Returns True if the given log value is contained within the run

integrateProtonCharge((Run)self[, (str)logname='proton_charge']) → None :

Set the total good proton charge for the run, from the proton charge log

keys((Run)self) → list :

Returns the names of the properties as list

setStartAndEndTime((Run)self, (DateAndTime)start, (DateAndTime)end) → None :

Set the start and end time of the run

startTime((Run)self) → DateAndTime :

Return the total starting time of the run.