visualisation Namespace Reference

Functions
	get_representative_loops (pandas.DataFrame dgm, R, filt)
	Get representative of each homology class in dimension 1.
	get_0_and_1_cycles (loop, filt)
	Get the vertices and edges of a loop.
	loop_composition (verts, filt, points, atom_types)
	Get the composition of a given representative.
	generate_visulisation_df (pandas.DataFrame dgm, R, filt, points, atom_types)
	generate the pandas.DataFrame containing the information about the points so we can display it
	get_neighbour_cells (pandas.DataFrame points, list cycle_vertices, filt)
	Get the neighbouring cells of a given cycle.
	generate_display (pandas.DataFrame points, pandas.DataFrame dgm, int id, filt, neighbours=False)
	Display a representative of a cycle.

Function Documentation

generate_display()

visualisation.generate_display	(	pandas.DataFrame	points,
		pandas.DataFrame	dgm,
		int	id,
			filt,
			neighbours = False )

Display a representative of a cycle.

Parameters

points	pandas.DataFrame of the atoms
dgm	pandas.DataFrame of the representatives of cycles
id	int corresponding to the id of the cycle you want to visualise

Returns

fig plotly.express figure displaying the ring

generate_visulisation_df()

visualisation.generate_visulisation_df	(	pandas.DataFrame	dgm,
			R,
			filt,
			points,
			atom_types )

generate the pandas.DataFrame containing the information about the points so we can display it

Parameters

dgm	pandas.DataFrame of the diagram, with columns birth, death, birth simplex, death simplex, cycle rep

get_0_and_1_cycles()

visualisation.get_0_and_1_cycles	(		loop,
			filt )

Get the vertices and edges of a loop.

Parameters

loop	list containing the ids of the edges in the loop
filt	oineus filtration

Returns

verts, edges lists of vertices and edges in the loop

get_neighbour_cells()

visualisation.get_neighbour_cells	(	pandas.DataFrame	points,
		list	cycle_vertices,
			filt )

Get the neighbouring cells of a given cycle.

Parameters

points	pandas.DataFrame of the points (atoms) in the structure
cycle_vertices	list of the vertices in the cycle
filt	oineus filtration

Returns

neighbour_0_cells, neighbour_1_cells, neighbour_2_cells lists of neighbouring 0, 1 and 2-cells

get_representative_loops()

visualisation.get_representative_loops	(	pandas.DataFrame	dgm,
			R,
			filt )

Get representative of each homology class in dimension 1.

Parameters

dgm	pandas.DataFrame containing the diagram and the birth and death simplex id
filt	oineus filtration

Returns

dgm pandas.DataFrame with new column cycle rep

loop_composition()

visualisation.loop_composition	(		verts,
			filt,
			points,
			atom_types )

Get the composition of a given representative.

Parameters

loop	list containing the ids of the edges in the loop
points	pandas.DataFrame of the points (atoms) in the structure
atom_types	list of the atom types we are considering (restricting to)

Returns

comp dictionary listing the number of atoms of each type in the loop