graphs

Module Contents

Classes

class Data(x: list, y: list, x_label='', y_label='', legend='', is_scattered=False, transfo_x=lambda selfData, x: x, transfo_y=lambda selfData, y: y, xlim=None, ylim=None, permutations=None, sort_output=False, color=None, alpha=255, symbol='o', symbolsize=8, fillsymbol=True, outlinesymbol=1.8, linestyle='-', width=2, meta=None)

This class is used to store informations necessary to plot a 2D graph. It has to be combined with a gui to be useful (ex. pyqtgraph)

set_kwargs(kwargs)

Set a kwarg after creation of the class

set_data(x: list, y: list)

Overwrites current datapoints with new set

set_meta(meta)

Set associated ‘Z’ data

get_x()

Get x coordinates of datapoints

get_symbolsize()

Get size of the symbols

symbol_isfilled()

Check if symbols has to be filled or not

get_symbolOutline()

Get color factor of outline of symbols

get_length_data()

Get number of points

get_xlim()

Get x limits of viewbox

get_ylim()

Get y limits of viewbox

get_y()

Get y coordinates of datapoints

get_meta()

Get associated ‘Z’ data

get_color()

Get color of the line, without transformation

get_color_alpha()

Get color of the line. Return r, g, b in 0, 255 scale

get_alpha()

Get opacity

get_width()

Get width of the line

get_number_of_points()

Get number of points

get_plot_data()

Call this method to get the x and y coordinates of the points that have to be displayed. => After transformation, and after permutations.

Returns:x (list), y (list)

get_plot_meta(x, y)

Call this method to get the z coordinates of the points that been displayed. => After transformation, and after permutations.

Returns:z (list)

get_permutations(x=None)

Return the transformation ‘permutation’: xplot[i] = xdata[permutation[i]]

get_invert_permutations()

Return the inverse of permutations: xdata[i] = xplot[revert[i]]

get_dataIndex_from_graphIndex(index_graph_point)

From an index given in graph, recovers the index of the data.

Parameters:index_graph_point – Index in the graph Returns:index of the data

get_dataIndices_from_graphIndices(index_graph_point_list)

Same as get_dataIndex_from_graphIndex but with a list in entry. Can (?) improve performances for huge dataset.

Parameters:index_graph_point_list – List of Index in the graph Returns:List of index of the data

get_graphIndex_from_dataIndex(index_data)

From an index given in the data, recovers the index of the graph.

Parameters:index_data – Index in the data Returns:index of the graph

get_graphIndices_from_dataIndices(index_data_list)

Same as get_graphIndex_from_dataIndex but with a list in entry. Can (?) improve performances for huge dataset.

Parameters:index_data_list – List of Index in the data Returns:List of index of the graph

set_permutations(permutations)

Set permutations between datapoints of the trace

Parameters:permutations – list of indices to plot (example: [0, 2, 1] means that the first point will be plotted, then the third, then the second one)

get_x_label()

Get x label of the trace

get_y_label()

Get y label of the trace

get_legend()

Get name of the trace

get_symbol()

Get symbol

add_point(x, y)

Add point(s) to trace (inputs can be list or numeral)

delete_point(index_point)

Delete a point from the datapoints

isScattered()

Check if plot is scatteded

set_indices_points_to_plot(indices)

Set indices points to plot

get_indices_points_to_plot()

Get indices points to plot

get_linestyle()

Get linestyle

__str__()

Return str(self).

export_str()

Method to save the points constituting the trace

set_color(theColor)

Set trace color

set_legend(theLegend)

Set legend

class Graph

Simple graph container that contains several traces

add_trace(data)

Add a trace to the graph

Parameters:data – Data Returns:id of the created trace

remove_trace(idTrace)

Delete a trace from the graph

Parameters:idTrace – id of the trace to delete

get_trace(idTrace) → Data

Get data object of idTrace

Parameters:idTrace – id of the trace to get Returns:Data

get_all_traces()

Get all the traces id of the graph

get_all_traces_ids()

Get all the traces id of the graph :return: list of id graphs

export_str()

class Graphs

Contains several Graph

updateChildren()

add_trace_firstGraph(data, updateChildren=True)

Same as add_trace, but only if graphs has only one id :param data: :param updateChildren: :return:

add_trace(idGraph, data, updateChildren=True)

Add a trace to the graph

Parameters:

• idGraph – id of the graph
• data – Data
• updateChildren – Automatically calls callback functions

Returns:

id of the created trace

remove_trace(idGraph, idTrace, updateChildren=True)

Remove the trace from the graph

Parameters:

• idGraph – id of the graph
• idTrace – id of the trace to remove
• updateChildren – Automatically calls callback functions

get_first_graph()

Get id of the first graph

Returns:id of the first graph

get_graph(idGraph)

Get graph object at idgraph

Parameters:idGraph – id of the graph to get Returns:Graph

get_all_graphs_ids()

Get all ids of the graphs

Returns:list of id graphs

get_all_graphs()

Get all graphs. Return dict {id: Graph}

add_graph(updateChildren=True)

Add a new graph

Returns:id of the created graph

remove_graph(idGraph)

Delete a graph

Parameters:idGraph – id of the graph to delete

add_update_method(childObject)

Add a callback each time a graph is modified.

Parameters:childObject – method without arguments

export_str()

Export all the graphs in text

Returns:str

merge(otherGraphs)

reset()

is_empty()