src.report.regression_report

Classes

RegressionReport(**kwargs)

class src.report.regression_report.RegressionReport(**kwargs)
Author:

Alberto M. Esmoris Pena

Class to handle reports related to regressions. See Report. See also RegressionModel.

Variables:

  • X (np.ndarray) – The point cloud’s structure space, typically a matrix of 3D point-wise coordinates where the rows are the points and the columns the coordinates \((x, y, z)\).

  • header – The header for the output point cloud file.

  • quantities (dict) – The dictionary with the quantities from the point cloud.

  • errors (dict) – The dictionary with the errors for each case.

  • metrics (dict) – The dictionary with the metrics summarizing the regression evaluation for each estimation.

  • outers (dict) – The dictionary with the outer correlations summarizing the relationship between the errors and arbitrary point-wise features.

  • distribution (dict) – The QQ distribution where the reference and the predictions are represented through its percentiles, as a dictionary.

__init__(**kwargs)

Initialize an instance of RegressionReport.

Parameters:

kwargs – The key-word arguments defining the report’s attributes.

to_regression_eval_string()

Generate the string representing the report evaluating the regressions.

Returns:

String representing the report evaluating the regressions.

to_outer_correlation_string()

Generate the string representing the report about correlations between the errors and arbitrary point-wise features.

Returns:

String representing the report about outer correlations.

to_QQ_distribution_string()

Generate the string representing the report about the QQ distributions involving the references and the predictions.

Returns:

String representing the report about the QQ distributions.

to_file(regression_report_path, outer_report_path=None, distribution_report_path=None, regression_pcloud_path=None, out_prefix=None)

Write the regression report to files.

Parameters:
Returns:

Nothing, the output is written to files.

has_regression_eval_info()

Check whether the report contains information about the evaluation of the regressions.

Returns:

True if the report contains information about the evaluation of the regressions, False otherwise.

has_outer_correlation_info()

Check whether the report contains information about correlations with outer features, i.e., arbitrary point-wise features not necessarily involved in the error quantification.

Returns:

True if the report contains information about correlations with outer features, False otherwise.

has_QQ_distribution_info()

Check whether the report contains information about the QQ distribution (where the percentiles are the considered quantiles).

Returns:

True if the report contains information about the QQ distribution, False otherwise.