BGlib.be.viz.be_viz_utils.visualize_sho_results

BGlib.be.viz.be_viz_utils.visualize_sho_results(h5_main, save_plots=True, show_plots=True, cmap=None, expt_type=None, meas_type=None, field_mode=None)[source]

Plots some loops, amplitude, phase maps for BE-Line and BEPS datasets.

Note: The file MUST contain SHO fit gusses at the very least

Parameters:

  • h5_main (HDF5 Dataset) – dataset to be plotted

  • save_plots ((Optional) Boolean) – Whether or not to save plots to files in the same directory as the h5 file

  • show_plots ((Optional) Boolean) – Whether or not to display the plots on the screen

  • cmap (String, or matplotlib.colors.LinearSegmentedColormap object (Optional)) – Requested color map

  • expt_type (str, Optional) – Type of data. This is an attribute written to the HDF5 file at the root level by either the translator or the acquisition software. Accepted values are: ‘BEPSData’, ‘BELineData’, ‘BERelaxData’, ‘cKPFMData’ Default - this function will attempt to extract this metadata from the HDF5 file

  • meas_type (str, Optional) –

    Type of measurement. Accepted values are:

    ’AC modulation mode with time reversal’ or ‘DC modulation mode’ This is an attribute embedded under the “Measurement” group with the following key: ‘VS_mode’. Default - this function will attempt to extract this metadata from the HDF5 file

  • field_mode (str, Optional) – Mode in which measurements were made. Accepted values are: ‘in and out-of-field’, This is an attribute at the “Measurement” group under the following key: ‘VS_measure_in_field_loops’. Default - this function will attempt to extract this metadata from the HDF5 file

Return type:

None