src.report.classified_pcloud_report

Classes

ClassifiedPcloudReport(**kwargs)

class src.report.classified_pcloud_report.ClassifiedPcloudReport(**kwargs)
Author:

Alberto M. Esmoris Pena

Class to handle reports related to classified point clouds. See Report.

Variables:

  • X (np.ndarray) – The matrix of coordinates representing the point cloud.

  • y – The vector of expected classes.

  • yhat (np.ndarray) – The vector of point-wise predictions.

  • zhat (np.ndarray) – The matrix of point-wise softmax scores where the rows represent the points and the columns the classes. It can be None because it is a potential extra for the report but not essential to it.

  • class_names (list) – The name for each class.

Vartype:

np.ndarray

__init__(**kwargs)

Initialize an instance of ClassifiedPcloudReport.

Parameters:

kwargs – The key-word arguments.

Keyword Arguments:

  • X (np.ndarray) – The matrix of coordinates representing the point cloud.

  • y (np.ndarray) – The expected classes for each point in \(\pmb{X}\).

  • yhat (np.ndarray) – The vector of point-wise predictions.

  • zhat (np.ndarray) – The matrix of point-wise softmax (row-points, col-classes). It is OPTIONAL. When not given, it will not be considered in the report.

  • class_names (list) – The name for each class. If not given, they will be considered as C1, …, CN by default.

to_file(path, out_prefix=None)

Write the report (point cloud) to a file (LAS/LAZ).

Parameters:

  • path (str) – Path to the file where the report must be written.

  • out_prefix (str) – The output prefix to expand the path (OPTIONAL).

Returns:

Nothing, the output is written to a file.