src.report.receptive_fields_report

Classes

ReceptiveFieldsReport(**kwargs)

class src.report.receptive_fields_report.ReceptiveFieldsReport(**kwargs)
Author:

Alberto M. Esmoris Pena

Class to handle reports related to receptive fields. See Report.

Variables:

  • X_rf (np.ndarray) – The matrix of coordinates for each receptive field.

  • F_rf (np.ndarray) – The matrix of features for each receptive field.

  • zhat_rf (np.ndarray) – The softmax scores for the predictions on each receptive field.

  • yhat_rf (np.ndarray) – The predictions for each receptive field.

  • y_rf (np.ndarray or None) – The expected values for each receptive field (can be None).

  • class_names (list) – The names representing each class.

__init__(**kwargs)

Initialize an instance of ReceptiveFieldsReport.

Parameters:

kwargs – The key-word arguments.

Keyword Arguments:

  • X_rf (np.ndarray) – The matrix of coordinates for each receptive field.

  • F_rf (np.ndarray) – The matrix of features for each receptive field.

  • zhat_rf (np.ndarray) – The softmax scores for the predictions on each receptive field.

  • yhat_rf (np.ndarray) – The predictions for each receptive field.

  • y_rf (np.ndarray) – The expected values for each receptive field (OPTIONAL).

  • class_names (list) – The name representing each class (OPTIONAL). If not given, C0, …, CN will be used by default.

to_file(path, out_prefix=None)

Write the report (receptive fields as point clouds) to files (LAZ).

Parameters:

  • path (str) – Path to the directory where the reports must be written.

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

Returns:

Nothing, the output is written to a file.