MHCXGraph.core.subgraphs.extract_subgraph_from_point

MHCXGraph.core.subgraphs.extract_subgraph_from_point(g: Graph, centre_point: ndarray | tuple[float, float, float], radius: float, filter_dataframe: bool = True, update_coords: bool = True, recompute_distmat: bool = False, inverse: bool = False, return_node_list: bool = False) → Graph | list[str] | None

Select nodes within a sphere.

Parameters:

• g (nx.Graph) – Input graph.

• centre_point (array-like of shape (3,)) – Sphere center.

• radius (float) – Sphere radius.

• filter_dataframe – See extract_subgraph_from_node_list().

• update_coords – See extract_subgraph_from_node_list().

• recompute_distmat – See extract_subgraph_from_node_list().

• inverse – See extract_subgraph_from_node_list().

• return_node_list – See extract_subgraph_from_node_list().

Returns:

Subgraph or node list.

Return type:

nx.Graph or list of str