Navigation

  • index
  • modules |
  • Data Analysis for E15190-E14030 documentation »
  • e15190.neutron_wall.pulse_shape_discrimination.Gallery

e15190.neutron_wall.pulse_shape_discrimination.Gallery¶

class e15190.neutron_wall.pulse_shape_discrimination.Gallery¶

Functions

__init__()

draw_centroid_as_func_of_position(psd_obj[, ax])

Draw centroid as a function of position.

draw_cfast_total(psd_obj, side[, cut, ax])

Draw centered-fast v.s.

draw_figure_of_merits(psd_obj[, cut, ax])

Draw figure of merit as functions of light_GM and position.

draw_ppsd1d(psd_obj[, cut, ax])

Draw one-dimensional histogram of PPSD.

draw_ppsd2d(psd_obj[, cut, ax])

Draw two-dimensional PPSD histogram.

draw_ppsd_as_func_of_lightGM(psd_obj[, cut, ax])

Draw PPSD as a function of light_GM (geometric mean)

draw_ppsd_as_func_of_position(psd_obj[, cut, ax])

Draw PPSD as a function of position.

draw_vpsd2d(psd_obj[, cut, ax])

Draw two-dimensional VPSD plot.

save_as_png(psd_obj[, path, cut, show_plot, ...])

Save a diagnostic plot to the gallery as a PNG file.

set_style()

__init__()¶
static save_as_png(psd_obj, path=None, cut='light_GM > 3', show_plot=False, save=True)¶

Save a diagnostic plot to the gallery as a PNG file.

Parameters
  • path (str or pathlib.Path, default None) – The path to save the plot. If None, the plot is saved to the default database.

  • cut (str, default 'light_GM > 3') – The cut to apply to the data when plotting. All panels in the figure will apply this cut, and potentially other cuts, joined by logical AND, except for the panel that draws the PPSD as a function of light GM.

  • show_plot (bool, default False) – If True, the plot will be shown in run time, i.e. the command plt.show() will be called.

  • save (bool, default True) – If True, the plot will be saved to the database. False option is useful when users are using this function to inspect the plot without saving.

static draw_cfast_total(psd_obj, side, cut=None, ax=None)¶

Draw centered-fast v.s. total.

Centered-fast, or cfast, is defined as the residual of fast w.r.t. to the center line.

Parameters
  • psd_obj (PulseShapeDiscriminator instance) – The PSD object to draw.

  • side (str) – The side of the bar, either ‘L’ or ‘R’.

  • cut (str, default None) – The cut to apply to the data to be plotted. This has nothing to do with the actual data used for analysis.

  • ax (matplotlib.axes.Axes) – Default None, and plt.gca() is used.

static draw_vpsd2d(psd_obj, cut=None, ax=None)¶

Draw two-dimensional VPSD plot.

Parameters
  • psd_obj (PulseShapeDiscriminator instance) – The PSD object to draw.

  • cut (str, default None) – The cut to apply to the data to be plotted. This has nothing to do with the actual data used for analysis.

  • ax (matplotlib.axes.Axes, default None) – Default None, and plt.gca() is used.

static draw_centroid_as_func_of_position(psd_obj, ax=None)¶

Draw centroid as a function of position.

“Centroid curve” refers to the trajectory of centroids in the 2D VPSD plot when we vary the hit position. In this function, we will be plotting four curves in total - two for neutron and two for gamma. For each particle, one curve is plotting VPSD-L and the another is plotting VPSD-R.

Parameters
  • psd_obj (PulseShapeDiscriminator instance) – The PSD object to draw.

  • ax (matplotlib.axes.Axes, default None) – Default None, and plt.gca() is used.

static draw_ppsd2d(psd_obj, cut=None, ax=None)¶

Draw two-dimensional PPSD histogram.

The x-axis is the PPSD value, and the y-axis is the perpendicular-PPSD value.

Parameters
  • psd_obj (PulseShapeDiscriminator instance) – The PSD object to draw.

  • cut (str, default None) – The cut to apply to the PSD object.

  • ax (matplotlib.axes.Axes, default None) – Default None, and plt.gca() is used.

static draw_ppsd_as_func_of_lightGM(psd_obj, cut=None, ax=None)¶

Draw PPSD as a function of light_GM (geometric mean)

This plot can give us a sense of how well can we trust the PPSD at low light_GM. The lower the light_GM value, the harder to separate neutrons and gammas.

Parameters
  • psd_obj (PulseShapeDiscriminator instance) – The PSD object to draw.

  • cut (str, default None) – The cut to apply to the PSD object. It is suggested to use some low threshold, e.g. light_GM > 1, so that we can inspect the relation as low as 1 MeVee; the default threshold for data analysis, however, is empirically established to be at least 3 MeVee or above.

  • ax (matplotlib.axes.Axes, default None) – Default None, and plt.gca() is used.

static draw_ppsd_as_func_of_position(psd_obj, cut=None, ax=None)¶

Draw PPSD as a function of position.

Parameters
  • psd_obj (PulseShapeDiscriminator instance) – The PSD object to draw.

  • cut (str, default None) – The cut to apply to the PSD object.

  • ax (matplotlib.axes.Axes, default None) – Default None, and plt.gca() is used.

static draw_ppsd1d(psd_obj, cut=None, ax=None)¶

Draw one-dimensional histogram of PPSD.

Parameters
  • psd_obj (PulseShapeDiscriminator instance) – The PSD object to draw.

  • cut (str, default None) – The cut to apply to the PSD object.

  • ax (matplotlib.axes.Axes, default None) – Default None, and plt.gca() is used.

static draw_figure_of_merits(psd_obj, cut=None, ax=None)¶

Draw figure of merit as functions of light_GM and position.

Parameters
  • psd_obj (PulseShapeDiscriminator instance) – The PSD object to draw.

  • cut (str, default None) – The common cut to apply to the PSD object. Additional cuts are added when constructing each F.O.M. point: -3 < ppsd < 4 and -1 < ppsd_perp < 1.

  • ax (matplotlib.axes.Axes, default None) – Default None, and plt.gca() is used.

Quick search

Navigation

  • index
  • modules |
  • Data Analysis for E15190-E14030 documentation »
  • e15190.neutron_wall.pulse_shape_discrimination.Gallery
© Copyright 2018-2023, MSU/FRIB HiRA group. Created using Sphinx 4.2.0.