Skip to content

TemporalProperty #

Bases: object

A view of a temporal property

history property #

Returns a history object which contains time entries for when the property was updated.

Returns:

Type Description
History

__eq__(value) #

Return self==value.

__ge__(value) #

Return self>=value.

__gt__(value) #

Return self>value.

__iter__() #

Implement iter(self).

__le__(value) #

Return self<=value.

__lt__(value) #

Return self<value.

__ne__(value) #

Return self!=value.

__repr__() #

Return repr(self).

at(t) #

Get the value of the property at a specified time.

Parameters:

Name Type Description Default
t TimeInput

time

 required

Returns:

Type Description
Optional[PropValue]

average() #

Compute the average of all property values. Alias for mean().

Returns:

Type Description
PropValue

The average of each property values, or None if count is zero.

count() #

Count the number of properties.

Returns:

Type Description
int

The number of properties.

items() #

List update times and corresponding property values.

Returns:

Type Description
List[Tuple[EventTime, PropValue]]

max() #

Find the maximum property value and its associated time.

Returns:

Type Description
Tuple[EventTime, PropValue]

A tuple containing the time and the maximum property value.

mean() #

Compute the mean of all property values. Alias for mean().

Returns:

Type Description
PropValue

The mean of each property values, or None if count is zero.

median() #

Compute the median of all property values.

Returns:

Type Description
Tuple[EventTime, PropValue]

A tuple containing the time and the median property value, or None if empty

min() #

Find the minimum property value and its associated time.

Returns:

Type Description
Tuple[EventTime, PropValue]

A tuple containing the time and the minimum property value.

ordered_dedupe(latest_time) #

List of ordered deduplicated property values.

Parameters:

Name Type Description Default
latest_time bool

Enable to check the latest time only.

 required

Returns:

Type Description
List[Tuple[EventTime, PropValue]]

sum() #

Compute the sum of all property values.

Returns:

Type Description
PropValue

The sum of all property values.

unique() #

List of unique property values.

Returns:

Type Description
List[PropValue]

value() #

Get the latest value of the property.

Returns:

Type Description
Optional[PropValue]

values() #

Get the property values for each update.

Returns:

Type Description
NumpyArray