Node#
- class Node#
Bases:
objectA node (or node) in the graph.
Methods:
after(start)Create a view of the Node including all events after start (exclusive).
at(time)Create a view of the Node including all events at time.
before(end)Create a view of the Node including all events before end (exclusive).
Return a view of Node containing only the default edge layer :returns: The layered view :rtype: Node
degree()Get the degree of this node (i.e., the number of edges that are incident to it).
exclude_layer(name)Return a view of Node containing all layers except the excluded name Errors if any of the layers do not exist.
exclude_layers(names)Return a view of Node containing all layers except the excluded names Errors if any of the layers do not exist.
exclude_valid_layer(name)Return a view of Node containing all layers except the excluded name :param name: layer name that is excluded for the new view :type name: str
exclude_valid_layers(names)Return a view of Node containing all layers except the excluded names :param names: list of layer names that are excluded for the new view :type names: list[str]
expanding(step)Creates a WindowSet with the given step size using an expanding window.
filter_edges(filter)Return a filtered view that only includes edges that satisfy the filter
filter_exploded_edges(filter)Return a filtered view that only includes exploded edges that satisfy the filter
filter_nodes(filter)Return a filtered view that only includes nodes that satisfy the filter
has_layer(name)Check if Node has the layer "name"
history()Returns the history of a node, including node additions and changes made to node.
Returns the history of a node, including node additions and changes made to node.
Get the in-degree of this node (i.e., the number of edges that are incident to it from other nodes).
Check if the node is active, i.e., it's history is not empty
latest()Create a view of the Node including all events at the latest time.
layer(name)Return a view of Node containing the layer "name" Errors if the layer does not exist
layers(names)Return a view of Node containing all layers names Errors if any of the layers do not exist.
Get the out-degree of this node (i.e., the number of edges that are incident to it from this node).
rolling(window[, step])Creates a WindowSet with the given window size and optional step using a rolling window.
shrink_end(end)Set the end of the window to the smaller of end and self.end()
shrink_start(start)Set the start of the window to the larger of start and self.start()
shrink_window(start, end)Shrink both the start and end of the window (same as calling shrink_start followed by shrink_end but more efficient)
snapshot_at(time)Create a view of the Node including all events that have not been explicitly deleted at time.
Create a view of the Node including all events that have not been explicitly deleted at the latest time.
valid_layers(names)Return a view of Node containing all layers names Any layers that do not exist are ignored
window(start, end)Create a view of the Node including all events between start (inclusive) and end (exclusive)
Attributes:
Returns the earliest datetime that the node exists.
Returns the earliest time that the node exists.
Get the edges that are incident to this node.
Gets the latest time that this Node is valid.
Gets the latest datetime that this Node is valid
Returns the id of the node.
Get the edges that point into this node.
Get the neighbours of this node that point into this node.
Returns the latest datetime that the node exists.
Returns the latest time that the node exists.
Returns the name of the node.
Get the neighbours of this node.
Returns the type of node
Get the edges that point out of this node.
Get the neighbours of this node that point out of this node.
The properties of the node
Gets the start time for rolling and expanding windows for this Node
Gets the earliest datetime that this Node is valid
Get the window size (difference between start and end) for this Node
- after(start)#
Create a view of the Node including all events after start (exclusive).
- at(time)#
Create a view of the Node including all events at time.
- before(end)#
Create a view of the Node including all events before end (exclusive).
- default_layer()#
Return a view of Node containing only the default edge layer :returns: The layered view :rtype: Node
- degree()#
Get the degree of this node (i.e., the number of edges that are incident to it).
- Returns:
The degree of this node.
- Return type:
- earliest_date_time#
Returns the earliest datetime that the node exists.
- Returns:
The earliest datetime that the node exists as a Datetime.
- Return type:
- earliest_time#
Returns the earliest time that the node exists.
- Returns:
The earliest time that the node exists as an integer.
- Return type:
- edges#
Get the edges that are incident to this node.
- Returns:
The incident edges.
- Return type:
- end#
Gets the latest time that this Node is valid.
- end_date_time#
Gets the latest datetime that this Node is valid
- exclude_layer(name)#
Return a view of Node containing all layers except the excluded name Errors if any of the layers do not exist.
- exclude_layers(names)#
Return a view of Node containing all layers except the excluded names Errors if any of the layers do not exist.
- exclude_valid_layer(name)#
Return a view of Node containing all layers except the excluded name :param name: layer name that is excluded for the new view :type name: str
- Returns:
The layered view
- Return type:
- exclude_valid_layers(names)#
Return a view of Node containing all layers except the excluded names :param names: list of layer names that are excluded for the new view :type names: list[str]
- Returns:
The layered view
- Return type:
- expanding(step)#
Creates a WindowSet with the given step size using an expanding window.
An expanding window is a window that grows by step size at each iteration.
- filter_edges(filter)#
Return a filtered view that only includes edges that satisfy the filter
- Parameters:
filter (PropertyFilter) – The filter to apply to the edge properties. Construct a filter using Prop.
- Returns:
The filtered view
- Return type:
- filter_exploded_edges(filter)#
Return a filtered view that only includes exploded edges that satisfy the filter
- Parameters:
filter (PropertyFilter) – The filter to apply to the exploded edge properties. Construct a filter using Prop.
- Returns:
The filtered view
- Return type:
- filter_nodes(filter)#
Return a filtered view that only includes nodes that satisfy the filter
- Parameters:
filter (PropertyFilter) – The filter to apply to the node properties. Construct a filter using Prop.
- Returns:
The filtered view
- Return type:
- has_layer(name)#
Check if Node has the layer “name”
- history()#
Returns the history of a node, including node additions and changes made to node.
- history_date_time()#
Returns the history of a node, including node additions and changes made to node.
- id#
Returns the id of the node. This is a unique identifier for the node.
- in_degree()#
Get the in-degree of this node (i.e., the number of edges that are incident to it from other nodes).
- Returns:
The in-degree of this node.
- Return type:
- in_neighbours#
Get the neighbours of this node that point into this node.
- Returns:
The in-neighbours.
- Return type:
- latest_date_time#
Returns the latest datetime that the node exists.
- Returns:
The latest datetime that the node exists as a Datetime.
- Return type:
- latest_time#
Returns the latest time that the node exists.
- Returns:
The latest time that the node exists as an integer.
- Return type:
- layer(name)#
Return a view of Node containing the layer “name” Errors if the layer does not exist
- layers(names)#
Return a view of Node containing all layers names Errors if any of the layers do not exist.
- neighbours#
Get the neighbours of this node.
- Returns:
The neighbours (both inbound and outbound).
- Return type:
- node_type#
Returns the type of node
- out_degree()#
Get the out-degree of this node (i.e., the number of edges that are incident to it from this node).
- Returns:
The out-degree of this node.
- Return type:
- out_edges#
Get the edges that point out of this node.
- Returns:
The outbound edges.
- Return type:
- out_neighbours#
Get the neighbours of this node that point out of this node.
- Returns:
The out-neighbours.
- Return type:
- properties#
The properties of the node
- Returns:
A list of properties.
- Return type:
- rolling(window, step=None)#
Creates a WindowSet with the given window size and optional step using a rolling window.
A rolling window is a window that moves forward by step size at each iteration.
- shrink_end(end)#
Set the end of the window to the smaller of end and self.end()
- shrink_start(start)#
Set the start of the window to the larger of start and self.start()
- shrink_window(start, end)#
Shrink both the start and end of the window (same as calling shrink_start followed by shrink_end but more efficient)
- snapshot_at(time)#
Create a view of the Node including all events that have not been explicitly deleted at time.
This is equivalent to before(time + 1) for Graph and at(time) for PersistentGraph
- snapshot_latest()#
Create a view of the Node including all events that have not been explicitly deleted at the latest time.
This is equivalent to a no-op for Graph and latest() for PersistentGraph
- Return type:
- start#
Gets the start time for rolling and expanding windows for this Node
- start_date_time#
Gets the earliest datetime that this Node is valid
- valid_layers(names)#
Return a view of Node containing all layers names Any layers that do not exist are ignored
- window(start, end)#
Create a view of the Node including all events between start (inclusive) and end (exclusive)