Skip to content

NodeStateIntervals #

Bases: object

__eq__(value) #

Return self==value.

__ge__(value) #

Return self>=value.

__getitem__(key) #

Return self[key].

__gt__(value) #

Return self>value.

__iter__() #

Implement iter(self).

__le__(value) #

Return self<=value.

__len__() #

Return len(self).

__lt__(value) #

Return self<value.

__ne__(value) #

Return self!=value.

__repr__() #

Return repr(self).

get(node, default=None) #

Get value for node

Parameters:

Name Type Description Default
node NodeInput

the node

 required
default Optional[Intervals]

the default value. Defaults to None.

 None

Returns:

Type Description
Optional[Intervals]

the value for the node or the default value

items() #

Iterate over items

Returns:

Type Description
Iterator[Tuple[Node, Intervals]]

Iterator over items

max() #

Calculate the maximum interval in milliseconds for each node.

Returns:

Type Description
NodeStateOptionI64

A NodeState with the computed maximum interval between consecutive timestamps for each node. The maximum is None if there is fewer than 1 interval.

mean() #

Calculate the mean interval in milliseconds for each node.

Returns:

Type Description
NodeStateOptionF64

A NodeState with the computed mean interval between consecutive timestamps for each node. The mean is None if there is fewer than 1 interval.

median() #

Calculate the median interval in milliseconds for each node.

Returns:

Type Description
NodeStateOptionI64

A NodeState with the computed median interval between consecutive timestamps for each node. The median is None if there is fewer than 1 interval.

min() #

Calculate the minimum interval in milliseconds for each node.

Returns:

Type Description
NodeStateOptionI64

A NodeState with the computed minimum interval between consecutive timestamps for each node. The minimum is None if there is fewer than 1 interval.

nodes() #

Iterate over nodes

Returns:

Type Description
Nodes

The nodes

sorted_by_id() #

Sort results by node id

Returns:

Type Description
NodeStateIntervals

The sorted node state

to_df() #

Convert results to pandas DataFrame

The DataFrame has two columns, "node" with the node ids and "value" with the corresponding values.

Returns:

Type Description
DataFrame

the pandas DataFrame

to_list() #

Collect all intervals in milliseconds into a list for each node.

Returns:

Type Description
list[list[int]]

List of intervals in milliseconds for each node.

values() #

Iterate over values

Returns:

Type Description
Iterator[Intervals]

Iterator over values