src.report.receptive_field_oversampling_report

Classes

ReceptiveFieldOversamplingReport(**kwargs)

class src.report.receptive_field_oversampling_report.ReceptiveFieldOversamplingReport(**kwargs)

Author:

Alberto M. Esmoris Pena

Class to handel reports related to receptive field oversampling. See Report.

Variables:

• X (list of np.ndarray) – The structure space matrix of the oversampled receptive field.

• Y (list of np.ndarray) – The structure space matrix for each receptive field, after the oversampling.

__init__(**kwargs)

Initialize an instance of ReceptiveFieldOversamplingReport.

Parameters:

kwargs – The key-word arguments.

Keyword Arguments:

• X (list np.ndarray) – The structure space matrices before the oversampling.

• Y (list of np.ndarray) – The structure space matrices after the oversampling.

• id (int or str or None) – See ReceptiveField.fit().

to_file(path, out_prefix=None)

Write the report (oversampled 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.