Run
This a python binding to the C++ class Mantid::API::Run.
-
class mantid.api.Run
-
__init__()
Raises an exception
This class cannot be instantiated from Python
-
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 None if it does not exist
- get( (object)self, (object)key) -> object :
- Returns the value pointed to by the key or the default value given
-
getGoniometer((Run)self) → Goniometer :
Get the oriented lattice for this sample
-
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.
-
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.
-
getProtonCharge((Run)self) → float :
Return the total good proton charge for the run
-
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.
