TemporalProperty
A view of a temporal property
Methods
| Method | Description |
|---|---|
at | Get the value of the property at a specified time. |
average | Compute the average of all property values. Alias for mean(). |
count | Count the number of properties. |
items | List update times and corresponding property values. |
max | Find the maximum property value and its associated time. |
mean | Compute the mean of all property values. Alias for mean(). |
median | Compute the median of all property values. |
min | Find the minimum property value and its associated time. |
ordered_dedupe | List of ordered deduplicated property values. |
sum | Compute the sum of all property values. |
unique | List of unique property values. |
value | Get the latest value of the property. |
values | Get the property values for each update. |
Properties
| Property | Description |
|---|---|
history | Returns a history object which contains time entries for when the property was updated. |
Method Details
at
Signature: at(t)
Get the value of the property at a specified time.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
t | TimeInput | - | time |
Returns
| Type | Description |
|---|---|
| PropValue, optional |
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.
max
Find the maximum property value and its associated time.
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.
min
Find the minimum property value and its associated time.
ordered_dedupe
Signature: ordered_dedupe(latest_time)
List of ordered deduplicated property values.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
latest_time | bool | - | Enable to check the latest time only. |
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 |
|---|---|
| PropValue, optional |
values
Get the property values for each update.
Returns
| Type | Description |
|---|---|
NumpyArray |
Property Details
history
Returns a history object which contains time entries for when the property was updated.
Returns
| Type | Description |
|---|---|
| History |