sombrin module
Create the Sombrin model, to compute TEEY.
It is very precise on the first crossover energy, but does not take the incident angle into account.
Model parameters
Parameter |
Name |
Unit |
Initial |
Description |
|---|---|---|---|---|
\(E_\mathrm{max}\) |
E_max |
\(\mathrm{eV}\) |
\(1.0\) |
Energy at maximum TEEY. |
\(\sigma_\mathrm{max}\) |
teey_max |
\(\mathrm{1}\) |
\(0.0\) |
Maximum TEEY, directly taken from the measurement. |
\(E_{\mathrm{c,\,1}}\) |
E_c1 |
\(\mathrm{eV}\) |
\(0.0\) |
First crossover energy. |
- class Sombrin(parameters_values=None)
Bases:
ModelDefine the Sombrin model, defined in [Som93].
We use the implementation from [FBHP16].
Instantiate the object.
- Parameters:
parameters_values (
dict[str,Any] |None, default:None) – Contains name of parameters and associated value. If provided, will override the default values set ininitial_parameters.
-
emission_data_types:
list[Literal['Emission Yield','Emission Energy','Emission Angle']] = ['Emission Yield']
-
model_config:
ModelConfig= ModelConfig(emission_yield_files=('all',), emission_energy_files=(), emission_angle_files=())
-
initial_parameters:
dict[str,dict[str,str|float|bool]] = {'E_c1': {'description': 'First crossover energy.', 'lower_bound': 0.0, 'markdown': 'E_{\\mathrm{c,\\,1}}', 'unit': 'eV', 'value': 0.0}, 'E_max': {'description': 'Energy at maximum TEEY.', 'lower_bound': 0.0, 'markdown': 'E_\\mathrm{max}', 'unit': 'eV', 'value': 1.0}, 'teey_max': {'description': 'Maximum TEEY, directly taken from the measurement.', 'lower_bound': 0.0, 'markdown': '\\sigma_\\mathrm{max}', 'unit': '1', 'value': 0.0}}
-
parameters:
SombrinParameters A
TypedDictspecific to everymodel.Model. Keys are parameters names, values areParameter.
- get_data(population, emission_data_type, energy, theta, *args, **kwargs)
Return desired data according to current model.
Will return a dataframe only if the TEEY is asked.