HDF5_BLS_analyse.Analyse_general

class HDF5_BLS_analyse.Analyse_general(y, x=None)

Bases: Analyse_backend

This class is a class inherited from the Analyse_backend class used to store steps of analysis that are not specific to a particular type of spectrometer and that are not interesting to show in an algorithm. For example, the function to add a remarkable point to the data

__init__(y, x=None)

Initializes the class with the most basic attributes: the ordinates and abscissa of the data.

Parameters:

• y (array) – The array of ordinates of the data

• x (array, optional) – The array of abscissa of the data. If None, the abscissa is just the index of the points in ordinates.

Methods

__init__(y[, x])	Initializes the class with the most basic attributes: the ordinates and abscissa of the data.
set_x_y(x, y)	Sets the x and y values of the data
silent_clear_points()	Clears the list of points and the list of windows.
silent_create_algorithm([algorithm_name, ...])	Creates a new JSON algorithm with the given name, version, author and description.
silent_move_step(step, new_step)	Moves a step from one position to another in the _algorithm attribute.
silent_open_algorithm([filepath, algorithm_str])	Opens an existing JSON algorithm and stores it in the _algorithm attribute.
silent_remove_step([step])	Removes the step from the _history attribute of the class.
silent_return_string_algorithm()	Returns a string representation of the algorithm stored in the _algorithm attribute of the class.
silent_run_algorithm([step])	Runs the algorithm stored in the _algorithm attribute of the class up to the given step (included).
silent_save_algorithm([filepath, ...])	Saves the algorithm to a JSON file with or without the parameters used.

silent_clear_points()

Clears the list of points and the list of windows.

silent_return_string_algorithm()

Returns a string representation of the algorithm stored in the _algorithm attribute of the class.

Returns:

The string representation of the algorithm.

Return type:

str