\(\renewcommand\AA{\unicode{x212B}}\)
A TimeSeriesProperty is a specialised mantid.kernel.Property
class that holds time/value pairs. It offers a selection of statistics
through it’s Python interface which you can use in your scripts.
Specific classes that implement this are:
mantid.kernel.BoolTimeSeriesProperty
mantid.kernel.FloatTimeSeriesProperty
mantid.kernel.Int32TimeSeriesProperty
mantid.kernel.Int64TimeSeriesProperty
mantid.kernel.StringTimeSeriesProperty
To get hold of a time series property, you need to get the handle to the object from the mantid.api.Run
object.
To get the mantid.kernel.TimeSeriesPropertyStatistics
object,
you then call getStatistics()
on the property.
This allows you to access the following attributes:
filterWith()
¶Handling boundary condition
Definition: log_t0
, log_tf
, filter_t0
, filter_tf
filter_t0
< log_t0`, then the log is extended to filter_t0
filter_t0
> log_t0
, all logs before first occurrence of False in filter are in the prohibited region.It is to say that the first entry of a log starts from the first occurrence of TRUE value.
filter_tf
> log_tf
, and filter_tf
is false, the (virtual) filtered log is extended by all filter entries beyond log_tf
;filter_tf
< log_tf`, and last filter entry is false, then all entries of the log after filter_tf
are in the disallowed region;nthInterval(n)
¶Return the nth interval
nthValue(n)
¶Return the value of nth interval.