LaPDOverview

class bapsflib.lapd._hdf.lapdoverview.LaPDOverview(hdf_obj: bapsflib.lapd._hdf.file.File)

Bases: bapsflib._hdf.utils.hdfoverview.HDFOverview

Reports an overview of the LaPD HDF5 file mapping.

Parameters

hdf_obj (File) – HDF5 file object

Methods Summary

control_discovery()

Prints a discovery report of the Control devices.

digitizer_discovery()

Prints a discovery report of the Digitizer devices.

msi_discovery()

Prints a discovery report of the MSI devices.

print()

Print full Overview Report.

report_control_configs(control)

Prints to screen information about the passed control device configuration(s).

report_controls([name])

Prints to screen a detailed report of detected control devices and their configuration(s).

report_details()

Prints a detailed report of all detected MSI diagnostics, digitizers, and control devices.

report_digitizer_configs(digi)

Prints to screen information about the passed digitizer configuration(s).

report_digitizers([name])

Prints to screen a report of detected digitizers and their configurations.

report_discovery()

Prints a discovery (brief) report of all detected MSI diagnostics, digitizers, and control devices.

report_general()

Prints general HDF5 file info.

report_msi([name])

Prints to screen a report of detected MSI diagnostics and their configurations.

report_msi_configs(msi)

Print to screan information about the passed MSI configuration.

save([filename])

Saves the HDF5 overview to a text file.

unknowns_discovery()

Prints a discovery report of the Unknown devices.

Methods Documentation

control_discovery()

Prints a discovery report of the Control devices.

digitizer_discovery()

Prints a discovery report of the Digitizer devices.

msi_discovery()

Prints a discovery report of the MSI devices.

print()

Print full Overview Report.

static report_control_configs(control: bapsflib._hdf.maps.controls.templates.HDFMapControlTemplate)

Prints to screen information about the passed control device configuration(s).

Parameters

control – a control device mapping object

report_controls(name=None)

Prints to screen a detailed report of detected control devices and their configuration(s).

Parameters

name (str) – name of control device. If None or name is not among controls, then all control devices are printed.

report_details()

Prints a detailed report of all detected MSI diagnostics, digitizers, and control devices.

static report_digitizer_configs(digi: bapsflib._hdf.maps.digitizers.templates.HDFMapDigiTemplate)

Prints to screen information about the passed digitizer configuration(s).

Parameters

digi – a digitizer mapping object

report_digitizers(name=None)

Prints to screen a report of detected digitizers and their configurations.

Parameters

name (str) – name of digitizer. If None or name is not among digitizers, then all digitizers are printed.

report_discovery()

Prints a discovery (brief) report of all detected MSI diagnostics, digitizers, and control devices.

report_general()

Prints general HDF5 file info.

report_msi(name=None)

Prints to screen a report of detected MSI diagnostics and their configurations.

Parameters

name (str) – name of MSI diagnostic. If None or name is not among MSI diagnostics, then all MSI diagnostics are printed.

static report_msi_configs(msi: bapsflib._hdf.maps.msi.templates.HDFMapMSITemplate)

Print to screan information about the passed MSI configuration.

Parameters

msi – a MSI mapping object

save(filename='')

Saves the HDF5 overview to a text file.

Parameters

filename (str) – name of text file to save the overview report generated by print().

unknowns_discovery()

Prints a discovery report of the Unknown devices.