iltpy.output

iltpy.output.plotting

iltpy.output.plotting.iltplot(iltdata, dim_ndim=None, transform_g=False, negative_g=False, transpose_residuals=False, scale_residuals=True)[source]

Generate plots from inverted iltdata.

Parameters

iltdataIltData

IltData instance after inversion.

dim_ndimndarray

Numpy array defining the second dimension

transform_gbool, default False

If True, the following transformation is applied to g in case of 2D data : g = np.sign(g) * np.sqrt(np.abs(g))

negative_gbool, default False

If True, the negative of g is plotted.

transpose_residualsbool, default False

If True, transpose of residuals are plotted.

iltpy.output.plotting.set_plot_param()[source]

iltpy.output.reporting

iltpy.output.reporting.iltreport(iltdata, filepath=None, save_arrays=False, level=0, parameters_to_file=False)[source]

Generates reports from an IltData instance

Parameters

iltdataIltData

An instance of IltData class.

filepathstr, optional

Path where the results should be saved. If None, results are saved in the current working directory, If no filename is specified in the path, a filename based on timestamp is generated. If there is no extension specified for the file in the filepath, .txt is used by default.

save_arraysbool, by default False

Whether to also output a file with numpy arrays in npz format.

levelint, optional

Controls the depth of saved data. Default is 0. - 0: Save attributes of type np.ndarray. - 1: Additionally, save lists containing only np.ndarray elements. - 2: Additionally, save sparse matrices (converted to dense arrays).