model package

Define the electron emission models.

class ChungEverhart(parameters_values: dict[str, Any] | None = None)

Bases: Model

Define the Chung and Everhart model, defined in [CE74].

__init__(parameters_values: dict[str, Any] | None = None) → None

Instantiate the object.

Parameters:

parameters_values – Contains name of parameters and associated value. If provided, will override the default values set in initial`_parameters.

_abc_impl = <_abc._abc_data object>
considers_energy: bool = True
emission_data_types: list[Literal['Emission Yield', 'Emission Energy', 'Emission Angle']] = ['Emission Energy']
find_optimal_parameters(data_matrix: DataMatrix, **kwargs) → None

Fit model parameters on measurements.

get_data(population: Literal['SE', 'EBE', 'IBE', 'all'], emission_data_type: Literal['Emission Yield', 'Emission Energy', 'Emission Angle'], energy: ndarray[tuple[Any, ...], dtype[float64]], theta: ndarray[tuple[Any, ...], dtype[float64]], *args, **kwargs) → DataFrame | None

Return desired data according to current model.

Will return a dataframe only if the SEs energy distribution is asked.

initial_parameters: dict[str, dict[str, str | float | bool]] = {'W_f': {'description': 'Material work function.', 'lower_bound': 0.0, 'markdown': 'W_f', 'unit': 'eV', 'value': 8.0}, 'norm': {'description': 'Distribution re-normalization constant.', 'lower_bound': 0.0, 'markdown': 'k', 'unit': '1', 'value': 1.0}}
is_3d: bool = False
is_dielectrics_compatible: bool = False
model_config: ModelConfig = ModelConfig(emission_yield_files=(), emission_energy_files=('all',), emission_angle_files=())
populations: list[Literal['SE', 'EBE', 'IBE', 'all']] = ['SE']
class Sombrin(parameters_values: dict[str, Any] | None = None)

Bases: Model

Define the Sombrin model, defined in [Som93].

We use the implementation from [FBHP16].

property E: float

Return the E parameter in Sombrin model. Not incident energy.

__init__(parameters_values: dict[str, Any] | None = None) → None

Instantiate the object.

Parameters:

parameters_values – Contains name of parameters and associated value. If provided, will override the default values set in initial_parameters.

_abc_impl = <_abc._abc_data object>
considers_energy: bool = True
emission_data_types: list[Literal['Emission Yield', 'Emission Energy', 'Emission Angle']] = ['Emission Yield']
evaluate(data_matrix: DataMatrix) → dict[str, float]

Evaluate the quality of the model using Fil criterions.

Fil criterions [FBHP16, FBHP20] are adapted to TEEY models.

find_optimal_parameters(data_matrix: DataMatrix, **kwargs) → None

Extract main TEEY curve parameters from measure.

get_data(population: Literal['SE', 'EBE', 'IBE', 'all'], emission_data_type: Literal['Emission Yield', 'Emission Energy', 'Emission Angle'], energy: ndarray[tuple[Any, ...], dtype[float64]], theta: ndarray[tuple[Any, ...], dtype[float64]], *args, **kwargs) → DataFrame | None

Return desired data according to current model.

Will return a dataframe only if the TEEY is asked.

initial_parameters: dict[str, dict[str, str | float | bool]] = {'E_c1': {'description': 'First crossover energy. Must be provided instead of E_0 for SPARK3D Vaughan.', 'lower_bound': 0.0, 'markdown': 'E_{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}}
is_3d: bool = False
is_dielectrics_compatible: bool = False
model_config: ModelConfig = ModelConfig(emission_yield_files=('all',), emission_energy_files=(), emission_angle_files=())
populations: list[Literal['SE', 'EBE', 'IBE', 'all']] = ['all']
set_parameter_value(name: str, value: Any) → None

Set E to None before updating the parameter.

class Vaughan(implementation: Literal['original', 'CST', 'SPARK3D'] = 'original', parameters_values: dict[str, Any] | None = None)

Bases: Model

Define the classic Vaughan model.

_E_0_matching(*, E_c1: float) → float

Fit E_0 to retrieve E_c1 (SPARK3D)

__init__(implementation: Literal['original', 'CST', 'SPARK3D'] = 'original', parameters_values: dict[str, Any] | None = None) → None

Instantiate the object.

Note

Parameter values set by implementation have priority over values given in parameters_values.

Parameters:

  • implementation – Modifies certain presets to match different interpretations of the model by calling preset_implementation(). These parameter modifications have precedence over the ones set in parameters_values.

  • parameters_values – Contains name of parameters and associated value. If provided, will override the default values set in initial_parameters.

_abc_impl = <_abc._abc_data object>
considers_energy: bool = True
emission_data_types: list[Literal['Emission Yield', 'Emission Energy', 'Emission Angle']] = ['Emission Yield']
evaluate(data_matrix: DataMatrix) → dict[str, float]

Evaluate the quality of the model using Fil criterions.

Fil criterions [FBHP16, FBHP20] are adapted to TEEY models.

find_e_0() → None

Find E_0 with error handling.

find_optimal_parameters(data_matrix: DataMatrix, **kwargs) → None

Match with position of first crossover and maximum.

get_data(population: Literal['SE', 'EBE', 'IBE', 'all'], emission_data_type: Literal['Emission Yield', 'Emission Energy', 'Emission Angle'], energy: ndarray[tuple[Any, ...], dtype[float64]], theta: ndarray[tuple[Any, ...], dtype[float64]], *args, **kwargs) → DataFrame | None

Return desired data according to current model.

Will return a dataframe only if the TEEY is asked.

Todo

This method could be so much simpler and efficient.

initial_parameters: dict[str, dict[str, str | float | bool]] = {'E_0': {'description': 'Threshold energy. By default, locked to :math:`12.5\\mathrm{\\,eV}`. If unlocked, will be fitted to retrieve :math:`E_{c,\\,1}`.', 'is_locked': True, 'markdown': 'E_0', 'unit': 'eV', 'value': 12.5}, 'E_c1': {'description': 'First crossover energy. Must be provided instead of E_0 for SPARK3D Vaughan.', 'is_locked': False, 'markdown': 'E_{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': 0.0}, 'delta_E_transition': {'description': 'Energy over which we switch from :math:`\\sigma_\\mathrm{low}` to actual Vaughan TEEY. Useful for smoothing the transition. Currently not implemented.', 'is_locked': True, 'markdown': '\\Delta E_{tr}', 'unit': 'eV', 'value': 1.0}, 'k_s': {'description': 'Roughness factor (:math:`\\sigma_\\mathrm{max}`).  Locked by default, but could be used for more precise fits.', 'is_locked': True, 'lower_bound': 0.0, 'markdown': 'k_s', 'unit': '1', 'upper_bound': 2.0, 'value': 1.0}, 'k_se': {'description': 'Roughness factor (:math:`E_\\mathrm{max}`).  Locked by default, but could be used for more precise fits.', 'is_locked': True, 'lower_bound': 0.0, 'markdown': 'k_{se}', 'unit': '1', 'upper_bound': 2.0, 'value': 1.0}, 'teey_low': {'description': 'TEEY below :math:`E_0`.', 'is_locked': True, 'lower_bound': 0.0, 'markdown': '\\sigma_\\mathrm{low}', 'unit': '1', 'value': 0.5}, 'teey_max': {'description': 'Maximum TEEY, directly taken from the measurement.', 'lower_bound': 0.0, 'markdown': '\\sigma_\\mathrm{max}', 'unit': '1', 'value': 0.0}}
is_3d: bool = True
is_dielectrics_compatible: bool = False
model_config: ModelConfig = ModelConfig(emission_yield_files=('all',), emission_energy_files=(), emission_angle_files=())
populations: list[Literal['SE', 'EBE', 'IBE', 'all']] = ['all']
preset_implementation(implementation: Literal['original', 'CST', 'SPARK3D']) → None

Update some parameters to reproduce a specific implementation.

Vaughan CST:

  • \(\sigma_\mathrm{low}\) is set to 0.

Vaughan SPARK3D:

  • \(\sigma_\mathrm{low}\) is set to 0.

  • \(E_0\) is unlocked, so that it will be fitted to match \(E_{c,\,1}\).

  • Below \(10\) \(\mathrm{eV}\), TEEY is 0.

Submodules