GraphGt

Module provides basic Graph interface to the graph_tool library.

class Graph(name=None, n_vertices=None, edges=None, directed=None, vertex_coordinates=None, vertex_radii=None, edge_coordinates=None, edge_radii=None, edge_geometries=None, shape=None, vertex_labels=None, edge_labels=None, annotation=None, base=None, edge_geometry_type='graph')

Bases: AnnotatedGraph

Graph class to handle graph construction and analysis.

Note

This is a interface from ClearMap graphs to graph_tool.

add_edge(edge)

add_edge_property(name, source=None, dtype=None)

add_graph_property(name, source, dtype=None)

add_vertex(n_vertices=None, vertex=None)

add_vertex_property(name, source=None, dtype=None)

annotate_properties(annotation, vertex_properties=None, edge_properties=None, edge_geometry_properties=None)

axis_indices(axis=None, as_list=False)

copy()

define_edge_property(name, source, edge=None, dtype=None)

define_graph_property(name, source, dtype=None)

define_vertex_property(name, source, vertex=None, dtype=None)

edge(edge)

edge_annotation(edge=None)

edge_close_binary(label, steps=1)

edge_connectivity()

edge_coordinates(edge=None)

edge_dilate_binary(label, steps=1)

edge_erode_binary(label, steps=1)

edge_geometry(name='coordinates', edge=None, as_list=True, return_indices=False, reshape=True, ndim=None)

edge_geometry_from_edge_property(edge_property_name, edge_geometry_name=None)

edge_geometry_indices()

edge_geometry_lengths(name='coordinates')

edge_geometry_property(name)

edge_geometry_property_name(name='coordinates', prefix='edge_geometry')

edge_graph(return_edge_map=False)

edge_index(edge)

edge_indices()

edge_iterator()

edge_open_binary(label, steps=1)

edge_propagate(label, value, steps=1)

edge_property(name, edge=None, as_array=True)

edge_property_map(name)

edge_radii(edge=None)

edge_source_label(vertex_label, as_array=True)

edge_target_label(vertex_label, as_array=True)

edge_to_vertex_label(edge_label, method='max', as_array=True)

edge_to_vertex_label_or(edge_label)

expand_vertex_filter(vertex_filter, steps=1)

first_edge()

first_vertex()

graph_property(name)

graph_property_map(name)

has_edge_geometry(name='coordinates')

info()

is_edge_geometry_consistent(verbose=False)

label_components(return_vertex_counts=False)

largest_component(view=False)

load(filename)

remove_edge(edge)

remove_edge_geometry(name=None)

remove_edge_property(name)

remove_graph_property(name)

remove_isolated_edges()

remove_isolated_vertices()

remove_self_loops()

remove_vertex(vertex)

remove_vertex_property(name)

resize_edge_geometry()

save(filename)

set_edge_annotation(annotation, edge=None, dtype='int32')

set_edge_coordaintes(coordinates, edge=None)

set_edge_geometry(name, values, indices=None, edge=None)

set_edge_geometry_type(edge_geometry_type)

set_edge_property(name, source, edge=None)

set_edge_radii(radii, edge=None)

set_graph_property(name, source)

set_vertex_annotation(annotation, vertex=None, dtype='int32')

set_vertex_coordinate(vertex, coordinate)

set_vertex_coordinates(coordinates, vertex=None, dtype=<class 'float'>)

set_vertex_property(name, source, vertex=None)

set_vertex_radii(radii, vertex=None)

set_vertex_radius(vertex, radius)

sub_graph(vertex_filter=None, edge_filter=None, view=False)

sub_slice(slicing, view=False, coordinates=None)

sub_slice_edge_filter(slicing, coordinates=None)

sub_slice_vertex_filter(slicing, coordinates=None)

transform_properties(transformation, vertex_properties=None, edge_properties=None, edge_geometry_properties=None, verbose=False)

vertex(vertex)

vertex_annotation(vertex=None)

vertex_close_binary(label, steps=1)

vertex_coloring()

vertex_coordinates(vertex=None, axis=None)

vertex_degree(index)

vertex_degrees()

vertex_dilate_binary(label, steps=1)

vertex_edges(vertex)

vertex_edges_iterator(vertex)

vertex_erode_binary(label, steps=1)

vertex_in_degree(index)

vertex_in_degrees()

vertex_in_edges(vertex)

vertex_in_edges_iterator(vertex)

vertex_in_neighbours(index)

vertex_index(vertex)

vertex_indices()

vertex_iterator()

vertex_neighbours(index)

vertex_open_binary(label, steps=1)

vertex_out_degree(index)

vertex_out_degrees()

vertex_out_edges(vertex)

vertex_out_edges_iterator(vertex)

vertex_out_neighbours(index)

vertex_propagate(label, value, steps=1)

vertex_property(name, vertex=None, as_array=True)

vertex_property_map(name)

vertex_radii(vertex=None)

vertex_to_edge_label(vertex_label, method=None)

view(vertex_filter=None, edge_filter=None)

property base

property directed

property edge_geometry_properties

property edge_geometry_property_names

property edge_geometry_type

Type for storing edge properties

Returns

type‘graph’ or ‘edge’

‘graph’Stores edge coordinates in an graph property array and

start end indices in edges.

‘edge’Stores the edge coordinates in variable length vectors in

each edge.

property edge_properties

property edges

property graph_properties

property has_edge_coordinates

property has_edge_radii

property has_vertex_coordinates

property has_vertex_radii

property is_view

property n_edges

Number of edges in the graph.

property n_vertices

Number of vertices in the graph.

property ndim

property shape

The shape of the space in which the graph is embedded.

Returns

shapetuple of int

The shape of the graph space.

property vertex_properties

property vertices

dtype_to_gtype(dtype)

Convert a data type to a graph_tool data type.

edge_property_map_from_python(source, graph, dtype=None)

Create a edge property map from a python source.

edge_property_map_to_python(property_map, as_array=True)

Convert edge property map to a python array or list.

gtype_from_source(source, vectorize=True, graph_property=False)

Determines the graph_tool data type from a data source.

load(filename)

ndim_from_source(source)

Determines the dimension of a source appropiate for graph_tool.

ndim_to_gtype(ndim, gtype)

Convert a scalar gtype to a vector one if necessary.

pickler(stream, obj)

save(filename, graph)

set_edge_property_map(property_map, source)

Set values for edge property map.

set_vertex_property_map(property_map, source)

Set values for vertex property map.

unpickler(stream)

vertex_property_map_from_python(source, graph, dtype=None)

Create a vertex property map from a python source.

vertex_property_map_to_python(property_map, as_array=True)

Convert vertex property map to a python array or list.