Skip to content

Commit

Permalink
Major update
Browse files Browse the repository at this point in the history
- Updated many aspects of the code for consistency.
- Cleaned up PES/ARPES model curve definitions and functions.
  • Loading branch information
c0deta1ker committed Jun 10, 2022
1 parent 7e95e2c commit 9b0bd9a
Show file tree
Hide file tree
Showing 189 changed files with 3,889 additions and 2,378 deletions.
2 changes: 1 addition & 1 deletion ADRESSTools_Basil/MATools_GreenHill_VNS/AlignEF.m
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
% values. The output EF is the determined EF positions in the input energy scale. Fail returns the indices
% of the scans where the alignment failed and EF was set to eWin.
% - Ver. 7 Mar 2020 (added vectorization of eWin)
disp('- EF alignment')
% disp('- EF alignment')

% parameters
% - dimensions
Expand Down
5 changes: 4 additions & 1 deletion ADRESSTools_Basil/MATools_GreenHill_VNS/ReadARPES.m
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,7 @@
% - hdf5 file
pos=strfind(Note,'Epass =');
ep=str2double(Note(pos+9:pos+12));
end
end



Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@
% doi: 10.1002/sia.4816.
%
% IN:
% - ke_dat: N x 1 vector of the input electron kinetic energy (for PES; KE = BE - PHI) [eV]
% - ke_dat: N×1 vector of the input electron kinetic energy (for PES; KE = BE - PHI) [eV]
% - rho: scalar of the density of the material (g/cc)
% - M: scalar of the atomic or molecular weight (in amu == g/mol)
% - Egap: scalar of the band gap energy (eV)
% - Z: scalar of the atomic mass number of the element (or average for compound) (Z)
%
% OUT:
% - imfp: N x 1 column vector of the electron IMFP values [Angstroms]
% - imfp: N×1 column vector of the electron IMFP values [Angstroms]

%% Default parameters (Parameters for Silicon)
if nargin < 5; Z = 14; end
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
% doi: 10.1002/sia.4816.
%
% IN:
% - ke_dat: N x 1 vector of the input electron kinetic energy (for PES; KE = BE - PHI) [eV]
% - ke_dat: N×1 vector of the input electron kinetic energy (for PES; KE = BE - PHI) [eV]
% - material: string of the material whose imfp is to be determined; e.g. "Si", "SiO2", "InAs", "Al2O3"...
%
% OUT:
% - imfp: N x 1 column vector of the electron IMFP values [Angstroms]
% - imfp: N×1 column vector of the electron IMFP values [Angstroms]

%% Default parameters (Parameters for Silicon)
if nargin < 2; material = "Si"; end
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@
% doi: 10.1002/sia.4816.
%
% IN:
% - ke_dat: N x 1 vector of the input electron kinetic energy (for PES; KE = BE - PHI) [eV]
% - ke_dat: N×1 vector of the input electron kinetic energy (for PES; KE = BE - PHI) [eV]
% - Z: scalar of the atomic mass number (Z) (or average for compounds)
%
% OUT:
% - imfp: N x 1 column vector of the electron IMFP values [Angstroms]
% - imfp: N×1 column vector of the electron IMFP values [Angstroms]

%% Default parameters (Parameters for Silicon)
if nargin < 2; Z = 14; end
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@
% [1] NIST Electron Inelastic-Mean-Free-Path Database: http://dx.doi.org/10.18434/T48C78.
%
% IN:
% - ke_dat: N x 1 vector of the input electron kinetic energy (for PES; KE = BE - PHI) [eV]
% - ke_dat: N×1 vector of the input electron kinetic energy (for PES; KE = BE - PHI) [eV]
% - element: char/string of the element; e.g. "H", "He", "Si", "In"...
%
% OUT:
% - imfp: N x 1 column vector of the electron IMFP values [Angstroms]
% - dimfp: N x 1 column vector of the IMFP uncertainties [Angstroms]
% - imfp: N×1 column vector of the electron IMFP values [Angstroms]
% - dimfp: N×1 column vector of the IMFP uncertainties [Angstroms]

%% Default parameters (Parameters for Silicon)
if nargin < 2; element = []; end
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@
% doi:10.1002/sia.6598
%
% IN:
% - ke_dat: N x 1 vector of the input electron kinetic energy (for PES; KE = BE - PHI) [eV]
% - ke_dat: N×1 vector of the input electron kinetic energy (for PES; KE = BE - PHI) [eV]
% - rho: scalar of the density of the material (g/cc)
% - Nv: scalar of the number of valence electrons per atom (for an element)
% - M: scalar of the atomic or molecular weight (in amu == g/mol)
% - Egap: scalar of the band gap energy (eV)
%
% OUT:
% - imfp: N x 1 column vector of the electron IMFP values [Angstroms]
% - imfp: N×1 column vector of the electron IMFP values [Angstroms]

%% Default parameters (Parameters for Silicon)
if nargin < 5; Egap = 1.12000; end
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
% calculations, where the specific material parameters are used.
%
% IN:
% - ke_dat: N x 1 vector of the input electron kinetic energy (for PES; KE = BE - PHI) [eV]
% - ke_dat: N×1 vector of the input electron kinetic energy (for PES; KE = BE - PHI) [eV]
%
% OUT:
% - imfp: N x 1 column vector of the electron IMFP values [Angstroms]
% - imfp: N×1 column vector of the electron IMFP values [Angstroms]

%% - 1 - Determination of the IMFP using universal formula
% If the kinetic energy is negative, assume it is zero
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
% L849–L857. https://doi.org/10.1016/0167-2584(87)90829-2
%
% IN:
% - ke_dat: N x 1 vector of the input electron kinetic energy (for PES; KE = BE - PHI) [eV]
% - ke_dat: N×1 vector of the input electron kinetic energy (for PES; KE = HV - BE - PHI) [eV]
% - material: string of the material whose imfp is to be determined; e.g. "Si", "SiO2", "Al2O3"...
%
% OUT:
% - imfp: N x 1 column vector of the electron IMFP values [Angstroms]
% - imfp: N×1 column vector of the electron IMFP values [Angstroms]

%% Default parameters (Parameters for Silicon)
if nargin < 2; material = "Si"; end
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
% required input being the electron kinetic energy.
%
% IN:
% - ke_dat: N x 1 column vector of the input electron kinetic energy (for PES; KE = BE - PHI) [eV]
% - ke_dat: N×1 column vector of the input electron kinetic energy (for PES; KE = BE - PHI) [eV]
%
% OUT:
% - imfp: N x 1 column vector of the electron IMFP values [Angstroms]
% - imfp: N×1 column vector of the electron IMFP values [Angstroms]

%% - 1 - Determination of the IMFP using universal formula
% If the kinetic energy is negative, assume it is zero
Expand Down
Binary file not shown.
4 changes: 2 additions & 2 deletions ADRESSTools_Basil/MaterialsDatabase_PCC/get_eimfpd_props.m
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
% - element: char/string of the element; e.g. "H", "He", "Si", "In"...
%
% OUT:
% - ke_dat: N x M array of the N'th electron kinetic energies taken from M'th file.
% - imfp: N x M array of the N'th imfp taken from M'th file.
% - ke_dat: N×M array of the N'th electron kinetic energies taken from M'th file.
% - imfp: N×M array of the N'th imfp taken from M'th file.

%% Default parameters
if nargin < 1; element = []; end
Expand Down
6 changes: 3 additions & 3 deletions ADRESSTools_Basil/MaterialsDatabase_PCC/get_pixsad_props.m
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
% - hvi: photon energy value (or range [min, max]) over which the cross-section and asymmetries will be determined.
%
% OUT:
% - hv: 1xN vector (or table) of the interpolated / nearest photon energies to the input based on the data.
% - xsect: 1xN vector (or table) of the photoionisation cross-sections.
% - asymmetry: 1xN vector (or table) of the asymmetries.
% - hv: 1×N vector (or table) of the interpolated / nearest photon energies to the input based on the data.
% - xsect: 1×N vector (or table) of the photoionisation cross-sections.
% - asymmetry: 1×N vector (or table) of the asymmetries.
% NOTE: if any of the outputs are NaN, this means you are outside of the
% range of photon energies for the defined data.

Expand Down
Loading

0 comments on commit 9b0bd9a

Please sign in to comment.