e15190.neutron_wall.efficiency.ScinfulQmd

class e15190.neutron_wall.efficiency.ScinfulQmd

Functions

__init__()

calculate_efficiency(light_response[, bias])

Calculate the efficiency from the light response table.

get_efficiency_curve([from_raw_output, save_txt])

Returns the efficiency curve.

read_efficiency_curve(mode, energy_range)

Read in the efficiency curve from the "res00.out" files.

read_response(energy, mode)

Read in the light response table from "res00.out" file.

Properties

PATH_FMT

RESULT_PATH

__init__()
static get_efficiency_curve(from_raw_output=False, save_txt=False) → pandas.core.frame.DataFrame

Returns the efficiency curve.

Parameters
  • from_raw_output (bool, default False) – If True, the efficiency curve is calculated from the “res00.out” files. Otherwise, the efficiency curve is read from the file specified by RESULT_PATH.

  • save_txt (bool, default False) – If True, the efficiency curve is saved to the file specified by RESULT_PATH.

Returns

efficiency_curve – The efficiency curve, with columns ‘energy’, ‘efficiency’, and ‘mode’.

Return type

pandas.DataFrame

static read_response(energy: int, mode: Literal['scinful', 'qmd']) → pandas.core.frame.DataFrame

Read in the light response table from “res00.out” file.

Parameters
  • energy (int) – The energy of the incident neutron in MeV.

  • mode ({'scinful', 'qmd'}) – The mode of the simulation. Scinful is used for energies below 80 MeV, and QMD is used for energies above 80 MeV.

Returns

light_response – The light response table, with columns ‘light’, ‘resp’, and ‘err’.

Return type

pd.DataFrame

static calculate_efficiency(light_response: pandas.core.frame.DataFrame, bias: float = 3.0) → float

Calculate the efficiency from the light response table.

Parameters
  • light_response (pd.DataFrame) – The light response table, containing at least columns ‘light’ and ‘resp’.

  • bias (float, default 3.0) – The bias light output in MeVee. This serves as the lower bound of the integral.

Returns

efficiency – The detection efficiency.

Return type

float

static read_efficiency_curve(mode: Literal['scinful', 'qmd'], energy_range: Tuple[int, int]) → pandas.core.frame.DataFrame

Read in the efficiency curve from the “res00.out” files.

Parameters
  • mode ({'scinful', 'qmd'}) – The mode of the simulation.

  • energy_range (tuple of int) – The inclusive energy range of the incident neutron in MeV. Scinful mode offers a range from 1 to 300 MeV, and QMD mode offers a range from 131 to 300 MeV.

Returns

efficiency_curve – The efficiency curve, with columns ‘energy’ and ‘efficiency’.

Return type

pd.DataFrame