FloatFilteredTimeSeriesProperty

This is a Python binding to the C++ class Mantid::Kernel::FilteredTimeSeriesProperty.

bases: mantid.kernel.FloatTimeSeriesProperty

class mantid.kernel.FloatFilteredTimeSeriesProperty((object)self, (FloatTimeSeriesProperty)source, (BoolTimeSeriesProperty)filter)
EMPTY_DBL = 8.988465674311579e+307
EMPTY_INT = 2147483647
EMPTY_LONG = 9223372036854775807
__init__((object)self, (FloatTimeSeriesProperty)source, (BoolTimeSeriesProperty)filter) → None :

Constructor

addValue((FloatTimeSeriesProperty)self, (DateAndTime)time, (float)value) → None

addValue( (FloatTimeSeriesProperty)self, (str)time, (float)value) -> None

addValue( (FloatTimeSeriesProperty)self, (object)time, (float)value) -> None

allowedValues

A list of allowed values

clear((FloatTimeSeriesProperty)self) → None
direction

Input, Output, InOut or Unknown. See the Direction class

documentation

The property’s doc string

dtype((FloatTimeSeriesProperty)self) → str
filterByTime((FloatTimeSeriesProperty)self, (DateAndTime)start, (DateAndTime)stop) → None
firstTime((FloatTimeSeriesProperty)self) → DateAndTime :

returns mantid.kernel.DateAndTime

firstValue((FloatTimeSeriesProperty)self) → float
getDefault

Get the default value as a string

getGroup

Return the ‘group’ of the property, that is, the header in the algorithm’s list of properties.

getStatistics((FloatTimeSeriesProperty)self) → TimeSeriesPropertyStatistics :

returns mantid.kernel.TimeSeriesPropertyStatistics

isDefault

Is the property set at the default value

isValid

An empty string if the property is valid, otherwise it contains an error message.

lastTime((FloatTimeSeriesProperty)self) → DateAndTime :

returns mantid.kernel.DateAndTime

lastValue((FloatTimeSeriesProperty)self) → float
name

The name of the property

nthTime((FloatTimeSeriesProperty)self, (int)index) → DateAndTime :

returns mantid.kernel.DateAndTime

nthValue((FloatTimeSeriesProperty)self, (int)index) → float
settings

Return the object managing this property’s settings

size((FloatTimeSeriesProperty)self) → int
timeAverageValue((FloatTimeSeriesProperty)self) → float
times
type

Returns a string identifier for the type

unfiltered((FloatFilteredTimeSeriesProperty)self) → FloatTimeSeriesProperty :

Returns a time series containing the unfiltered data

units

The units attached to this property

value
valueAsPrettyStr((Property)arg1[, (int)maxLength=0[, (bool)collapseLists=True]]) → str :

The value of the property as a formatted string. If maxLength is defined then the output may not contain the full contents of the property. The maxLength and collapseLists arguments do not work for all property types

valueAsStr

The value of the property as a string. For some property types, e.g. Workspaces, it is useful to be able to refer to the string value directly

valueAsString((FloatTimeSeriesProperty)self) → str