Skip to content

Commit

Permalink
change all to american english
Browse files Browse the repository at this point in the history
  • Loading branch information
rettigl committed Jul 13, 2024
1 parent 8ddecd7 commit c5409b9
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 15 deletions.
2 changes: 0 additions & 2 deletions .cspell/custom-dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
allclose
ALLUSERSPROFILE
amperemeter
analyser
arange
archiver
argwhere
Expand All @@ -27,7 +26,6 @@ COLLECTIONCOLUMN
colorbar
COMPES
configpath
Croping
cropit
damatrix
dapolymatrix
Expand Down
10 changes: 5 additions & 5 deletions specsanalyzer/convert.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ def get_damatrix_from_calib2d(
work_function: float,
calib2d_dict: dict,
) -> tuple[float, np.ndarray, float, str, list[str]]:
"""This function estimates the best angular conversion coefficients for the current analyser
"""This function estimates the best angular conversion coefficients for the current analyzer
mode, starting from a dictionary containing the specs .calib2d database. A linear interpolation
is performed from the tabulated coefficients based on the retardation ratio value.
Args:
lens_mode (str): the lens mode string description
kinetic_energy (float): kinetic energy of the photoelectron
pass_energy (float): analyser pass energy
pass_energy (float): analyzer pass energy
work_function (float): work function settings
calib2d_dict (dict): dictionary containing the configuration parameters for angular
correction
Expand Down Expand Up @@ -245,7 +245,7 @@ def calculate_polynomial_coef_da(
Args:
da_matrix (np.ndarray): the matrix of interpolated da coefficients
kinetic_energy (float): photoelectron kinetic energy
pass_energy (float): analyser pass energy
pass_energy (float): analyzer pass energy
e_shift (np.ndarray): e shift parameter, defining the energy
range around the center for the polynomial fit of the da coefficients
Expand Down Expand Up @@ -386,8 +386,8 @@ def calculate_matrix_correction(
"""Calculate the angular and energy interpolation matrices for the correction function.
Args:
kinetic_energy (float): analyser set kinetic energy
pass_energy (float): analyser set pass energy
kinetic_energy (float): analyzer set kinetic energy
pass_energy (float): analyzer set pass energy
nx_pixels (int): number of image pixels (after binning) along the energy dispersing
direction
ny_pixels (int): number of image pixels (after binning) along the angle/spatially
Expand Down
12 changes: 6 additions & 6 deletions specsanalyzer/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,9 @@ def convert_image(
raw_img (np.ndarray): Raw image data, numpy 2d matrix
lens_mode (str): analyzer lens mode, check calib2d for a list of modes CamelCase naming
convention e.g. "WideAngleMode"
kinetic_energy (float): set analyser kinetic energy
pass_energy (float): set analyser pass energy
work_function (float): set analyser work function
kinetic_energy (float): set analyzer kinetic energy
pass_energy (float): set analyzer pass energy
work_function (float): set analyzer work function
conversion_parameters (dict, optional): dictionary of conversion parameters,
overwriting determination from calib2d file. Defaults to None.
Expand Down Expand Up @@ -371,9 +371,9 @@ def crop_tool(
raw_img (np.ndarray): Raw image data, numpy 2d matrix
lens_mode (str): analyzer lens mode, check calib2d for a list
of modes CamelCase naming convention e.g. "WideAngleMode"
kinetic_energy (float): set analyser kinetic energy
pass_energy (float): set analyser pass energy
work_function (float): set analyser work function
kinetic_energy (float): set analyzer kinetic energy
pass_energy (float): set analyzer pass energy
work_function (float): set analyzer work function
apply (bool, optional): Option to directly apply the pre-selected cropping parameters.
Defaults to False.
**kwds: Keyword parameters for the crop tool:
Expand Down
2 changes: 1 addition & 1 deletion specsscan/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ def load_scan(
return res_xarray

def crop_tool(self, scan: int = None, path: Path | str = "", **kwds):
"""Croping tool interface to crop_tool method of the SpecsAnalyzer class.
"""Cropping tool interface to crop_tool method of the SpecsAnalyzer class.
Args:
scan (int, optional): Scan number to load data from. Defaults to None.
Expand Down
2 changes: 1 addition & 1 deletion specsscan/helpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ def handle_meta(

kinetic_energy = df_lut["KineticEnergy"].to_numpy()
if len(set(kinetic_energy)) > 1 and scan_info["ScanType"] == "voltage":
energy_scan_mode = "fixed_analyser_transmission"
energy_scan_mode = "fixed_analyser_transmission" # spell-checker: word: analyser

metadata["scan_info"] = complete_dictionary(
metadata.get("scan_info", {}),
Expand Down

0 comments on commit c5409b9

Please sign in to comment.