core

Subpackages

• ansi2html
  • converter
  • style
  • util

• collection
• color_palette
• commonImport
• graphs
• interfaceDevice
• linkDataGraph
• myjson
• options
• tools

Package Contents

getPath_workspace()

obj_to_json(theObj)

Extract the json dictionary from the object. The data saved are automatically detected, using typehints. ex: x: int=5 will be saved, x=5 won’t.

json_to_obj(json_dict)

Convenience class to create object from dictionary. Only works if CLASS_TAG is valid :param json_dict: dictionary loaded from a json file. :raise TypeError: if class can not be found :raise KeyError: if CLASS_TAG not present in dictionary

json_to_obj_safe(json_dict, cls)

Safe class to create object from dictionary. :param json_dict: dictionary loaded from a json file :param cls: class object to instantiate with dictionary

encode_str_json(theStr)

decode_str_json(theStr)

indentParagraph(text_in, indent_level=1)

rgetattr(obj, attr)

Recursively get an attribute from object. Extends getattr method

Parameters:

• obj – object
• attr – attribute to get

Returns:

applyEquation(objectIn, s)

Apply literal expression based on an object

Parameters:

• objectIn – Object
• s – literal expression. Float variables taken from the object are written between {}, int between []. Example: s=”{x}+{y}*2” if x and y are attributes of objectIn.

Returns:

value (float)

printIfShown(theStr, show_type=SHOW_DEBUG, isToPrint=True, appendTypeName=True)

SHOW_WARNING = 0

class DataStruct_Interface

get_info(self)

Get simple string describing the datastructure

set_info(self, info)

Set simple string describing the datastructure

__str__(self)

class AutosaveStruct(dataStruct, filename='', change_filename_if_exists=True)

Structure that provides automated save of DataStructures

__str__(self)

get_filename(self)

Get set filename

set_filename(self, filename, change_filename_if_exists)

Parameters:

• filename – Filename to set
• change_filename_if_exists – If already exists, create a new filename

stop_autosave(self)

Stop autosave

start_autosave(self, timer_autosave)

Start autosave

save(self, safe_save=True)

Save

get_datastruct(self)

Return :class:’~DataStruct_Interface’

class ListDataStruct

Bases: optimeed.core.collection.DataStruct_Interface

_INFO_STR = info

_DATA_STR = data

save(self, filename)

Save data using json format. The data to be saved are automatically detected, see obj_to_json()

add_data(self, data_in)

Add a data to the list

get_data(self)

Get full list of datas

set_data(self, theData)

Set full list of datas

set_data_at_index(self, data_in, index)

Replace data at specific index

set_attribute_data(self, the_attribute, the_value)

Set attribute to all data

set_attribute_equation(self, attribute_name, equation_str)

Advanced method to set the value of attribute_name from equation_str

Parameters:

• attribute_name – string (name of the attribute to set)
• equation_str – formatted equation, check applyEquation()

Returns:

get_list_attributes(self, attributeName)

Get the value of attributeName of all the data in the Collection

Parameters:attributeName – string (name of the attribute to get) Returns:list

delete_points_at_indices(self, indices)

Delete several elements from the Collection

Parameters:indices – list of indices to delete

export_xls(self, excelFilename, excelsheet='Sheet1', mode='w')

Export the collection to excel. It only exports the direct attributes.

Parameters:

• excelFilename – filename of the excel
• excelsheet – name of the sheet
• mode – ‘w’ to erase existing file, ‘a’ to append sheetname to existing file

merge(self, collection)

Merge a collection with the current collection

Parameters:collection – Collection to merge

class text_format

PURPLE = 

CYAN = 

DARKCYAN = 

BLUE = 

GREEN = 

YELLOW = 

WHITE = 

RED = 

BOLD = 

UNDERLINE = 

END = 

software_version()

find_and_replace(begin_char, end_char, theStr, replace_function)

create_unique_dirname(dirname)

applyEquation(objectIn, s)

Apply literal expression based on an object

Parameters:

• objectIn – Object
• s – literal expression. Float variables taken from the object are written between {}, int between []. Example: s=”{x}+{y}*2” if x and y are attributes of objectIn.

Returns:

value (float)

arithmeticEval(s)

isNonePrintMessage(theObject, theMessage, show_type=SHOW_INFO)

getPath_workspace()

getLineInfo(lvl=1)

printIfShown(theStr, show_type=SHOW_DEBUG, isToPrint=True, appendTypeName=True)

universalPath(thePath)

add_suffix_to_path(thePath, suffix)

get_object_attrs(obj)

cart2pol(x, y)

pol2cart(rho, phi)

partition(array, begin, end)

quicksort(array)

rsetattr(obj, attr, val)

rgetattr(obj, attr)

Recursively get an attribute from object. Extends getattr method

Parameters:

• obj – object
• attr – attribute to get

Returns:

indentParagraph(text_in, indent_level=1)

dist(p, q)

Return the Euclidean distance between points p and q. :param p: [x, y] :param q: [x, y] :return: distance (float)

sparse_subset(points, r)

Returns a maximal list of elements of points such that no pairs of points in the result have distance less than r. :param points: list of tuples (x,y) :param r: distance :return: corresponding subset (list), indices of the subset (list)

integrate(x, y)

Performs Integral(x[0] to x[-1]) of y dx

Parameters:

• x – x axis coordinates (list)
• y – y axis coordinates (list)

Returns:

integral value

my_fourier(x, y, n, L)

Fourier analys

Parameters:

• x – x axis coordinates
• y – y axis coordinates
• n – number of considered harmonic
• L – half-period length

Returns:

a and b coefficients (y = a*cos(x) + b*sin(y))

linspace(start, stop, npoints)

truncate(theStr, truncsize)

str_all_attr(theObject, max_recursion_level)

get_2D_pareto(xList, yList, max_X=True, max_Y=True)

get_ND_pareto(objectives_list, are_maxobjectives_list=None)

Return the N-D pareto front

Parameters:

• objectives_list – list of list of objectives: example [[0,1], [1,1], [2,2]]
• are_maxobjectives_list – for each objective, tells if they are to be maximized or not: example [True, False]. Default: False

Returns:

extracted_pareto, indices: list of [x, y, …] points forming the pareto front, and list of the indices of these points from the base list.

derivate(t, y)

class fast_LUT_interpolation(independent_variables, dependent_variables)

Class designed for fast interpolation in look-up table when successive searchs are called often. Otherwise use griddata

interpolate(self, point, fill_value=np.nan)

Perform the interpolation :param point: coordinates to interpolate (tuple or list of tuples for multipoints) :param fill_value: value to put if extrapolated. :return: coordinates

delete_indices_from_list(indices, theList)

Delete elements from list at indices :param indices: list :param theList: list

SHOW_WARNING = 0

SHOW_INFO = 1

SHOW_ERROR = 2

SHOW_DEBUG = 3

SHOW_CURRENT

printIfShown(theStr, show_type=SHOW_DEBUG, isToPrint=True, appendTypeName=True)

SHOW_WARNING = 0

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, symbol='o', symbolsize=8, fillsymbol=True, outlinesymbol=1.8, linestyle='-', width=2)

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_data(self, x: list, y: list)

Overwrites current datapoints with new set

get_x(self)

Get x coordinates of datapoints

get_symbolsize(self)

Get size of the symbols

symbol_isfilled(self)

Check if symbols has to be filled or not

get_symbolOutline(self)

Get color factor of outline of symbols

get_length_data(self)

Get number of points

get_xlim(self)

Get x limits of viewbox

get_ylim(self)

Get y limits of viewbox

get_y(self)

Get y coordinates of datapoints

get_color(self)

Get color of the line

get_width(self)

Get width of the line

get_number_of_points(self)

Get number of points

get_plot_data(self)

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_permutations(self)

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

get_invert_permutations(self)

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

get_dataIndex_from_graphIndex(self, 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(self, 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(self, 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(self, 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(self, 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(self)

Get x label of the trace

get_y_label(self)

Get y label of the trace

get_legend(self)

Get name of the trace

get_symbol(self)

Get symbol

add_point(self, x, y)

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

delete_point(self, index_point)

Delete a point from the datapoints

is_scattered(self)

Delete a point from the datapoints

set_indices_points_to_plot(self, indices)

Set indices points to plot

get_indices_points_to_plot(self)

Get indices points to plot

get_linestyle(self)

Get linestyle

__str__(self)

export_str(self)

Method to save the points constituting the trace

class Graph

Simple graph container that contains several traces

add_trace(self, data)

Add a trace to the graph

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

remove_trace(self, idTrace)

Delete a trace from the graph

Parameters:idTrace – id of the trace to delete

get_trace(self, idTrace)

Get data object of idTrace

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

get_all_traces(self)

Get all the traces id of the graph

export_str(self)

class Graphs

Contains several Graph

updateChildren(self)

add_trace_firstGraph(self, data, updateChildren=True)

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

add_trace(self, 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(self, 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(self)

Get id of the first graph

Returns:id of the first graph

get_graph(self, idGraph)

Get graph object at idgraph

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

get_all_graphs_ids(self)

Get all ids of the graphs

Returns:list of id graphs

get_all_graphs(self)

Get all graphs. Return dict {id: Graph}

add_graph(self, updateChildren=True)

Add a new graph

Returns:id of the created graph

remove_graph(self, idGraph)

Delete a graph

Parameters:idGraph – id of the graph to delete

add_update_method(self, childObject)

Add a callback each time a graph is modified.

Parameters:childObject – method without arguments

export_str(self)

Export all the graphs in text

Returns:str

merge(self, otherGraphs)

reset(self)

SHOW_WARNING = 0

SHOW_INFO = 1

SHOW_ERROR = 2

SHOW_DEBUG = 3

SHOW_CURRENT

class InterfaceDevice

Interface class that represents a device. Hidden feature: variables that need to be saved must be type-hinted: e.g.: x: int. See obj_to_json() for more info

assign(self, machine_to_assign, resetAttribute=False)

Copy the attribute values of machine_to_assign to self. The references are not lost.

Parameters:

• machine_to_assign – InterfaceDevice
• resetAttribute –

class HowToPlotGraph(attribute_x, attribute_y, kwargs_graph=None, excluded=None)

exclude_col(self, id_col)

Add id_col to exclude from the graph

__str__(self)

class CollectionInfo(theCollection, kwargs, theID)

get_collection(self)

get_kwargs(self)

get_id(self)

class LinkDataGraph

class _collection_linker

add_link(self, idSlave, idMaster)

get_collection_master(self, idToGet)

is_slave(self, idToCheck)

set_same_master(self, idExistingSlave, idOtherSlave)

Parameters:

• idExistingSlave – id collection of the existing slave
• idOtherSlave – id collection of the new slave that has to be linked to an existing master

add_collection(self, theCollection, kwargs=None)

add_graph(self, howToPlotGraph)

createGraphs(self)

get_howToPlotGraph(self, idGraph)

get_collectionInfo(self, idCollectionInfo)

create_trace(self, collectionInfo, howToPlotGraph, idGraph)

get_all_id_graphs(self)

get_all_traces_id_graph(self, idGraph)

update_graphs(self)

is_slave(self, idGraph, idTrace)

get_idCollection_from_graph(self, idGraph, idTrace, getMaster=True)

From indices in the graph, get index of corresponding collection

get_collection_from_graph(self, idGraph, idTrace, getMaster=True)

From indices in the graph, get corresponding collection

get_dataObject_from_graph(self, idGraph, idTrace, idPoint)

get_dataObjects_from_graph(self, idGraph, idTrace, idPoint_list)

remove_element_from_graph(self, idGraph, idTrace, idPoint, deleteFromMaster=False)

Remove element from the graph, or the master collection

remove_elements_from_trace(self, idGraph, idTrace, idPoints, deleteFromMaster=False)

Performances optimisation when compared to LinkDataGraph.remove_element_from_graph()

link_collection_to_graph_collection(self, id_collection_graph, id_collection_master)

Link data :param id_collection_graph: :param id_collection_master: :return:

remove_trace(self, idGraph, idTrace)

get_graph_and_trace_from_collection(self, idCollection)

Reverse search: from a collection, get the associated graph

get_mappingData_graph(self, idGraph)

get_mappingData_trace(self, idGraph, idTrace)

class text_format

PURPLE = 

CYAN = 

DARKCYAN = 

BLUE = 

GREEN = 

YELLOW = 

WHITE = 

RED = 

BOLD = 

UNDERLINE = 

END = 

class Options

get_name(self, idOption)

get_value(self, idOption)

add_option(self, idOption, name, value)

set_option(self, idOption, value)

copy(self)

set_self(self, the_options)

__str__(self)

class Option_class

get_optionValue(self, optionId)

set_optionValue(self, optionId, value)

get_all_options(self)

set_all_options(self, options)

add_option(self, idOption, name, value)