Skip to content

electron_corrector Module

This module defines the correction object used to apply a Garfield correction to a point cloud.

ElectronCorrector

Class which uses a BilinearInterpolator to correct the drift time of electrons

AT-TPC electric field correction for electron drift time

Parameters:

Name Type Description Default
interp BilinearInterpolator

The interpolator object

 required

Attributes:

Name Type Description
correction BilinearInterpolator

The interpolator object

Methods:

Name Description
ElectronCorrector

Construct the corrector
correct_point

Apply the correction to a point in a point cloud
Source code in src/spyral/correction/electron_corrector.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
class ElectronCorrector:
    """Class which uses a BilinearInterpolator to correct the drift time of electrons

    AT-TPC electric field correction for electron drift time

    Parameters
    ----------
    interp: BilinearInterpolator
        The interpolator object

    Attributes
    ----------
    correction: BilinearInterpolator
        The interpolator object

    Methods
    -------
    ElectronCorrector(interp: BilinearInterpolator)
        Construct the corrector
    correct_point(point: ndarray) -> ndarray
        Apply the correction to a point in a point cloud

    """

    def __init__(self, interp: BilinearInterpolator):
        self.correction: BilinearInterpolator = interp

    def correct_point(self, point: np.ndarray) -> np.ndarray:
        """Apply the correction to a point in a point cloud

        Parameters
        ----------
        point: ndarray
            The point to be corrected

        Returns
        -------
        ndarray
            The corrected point
        """
        # Correction returns [rho_cor, trans_cor, z_cor]
        corrected_point = np.zeros(len(point))
        corrected_point[3:] = point[3:]

        radius: float = np.linalg.norm(point[:2])  # type: ignore
        azimuthal: float = np.arctan2(point[1], point[0])

        correction = self.correction.interpolate(radius, point[2])

        z_correction = clamp(correction[2], 0.0, 1000.0)

        corrected_radius = np.sqrt(
            (radius + correction[0]) ** 2.0 + correction[1] ** 2.0
        )
        corrected_azim = azimuthal + np.arctan2(correction[1], (radius + correction[0]))

        corrected_point[0] = corrected_radius * np.cos(corrected_azim)
        corrected_point[1] = corrected_radius * np.sin(corrected_azim)
        corrected_point[2] = point[2] - z_correction

        return corrected_point

correct_point(point)

Apply the correction to a point in a point cloud

Parameters:

Name Type Description Default
point ndarray

The point to be corrected

 required

Returns:

Type Description
ndarray

The corrected point
Source code in src/spyral/correction/electron_corrector.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
def correct_point(self, point: np.ndarray) -> np.ndarray:
    """Apply the correction to a point in a point cloud

    Parameters
    ----------
    point: ndarray
        The point to be corrected

    Returns
    -------
    ndarray
        The corrected point
    """
    # Correction returns [rho_cor, trans_cor, z_cor]
    corrected_point = np.zeros(len(point))
    corrected_point[3:] = point[3:]

    radius: float = np.linalg.norm(point[:2])  # type: ignore
    azimuthal: float = np.arctan2(point[1], point[0])

    correction = self.correction.interpolate(radius, point[2])

    z_correction = clamp(correction[2], 0.0, 1000.0)

    corrected_radius = np.sqrt(
        (radius + correction[0]) ** 2.0 + correction[1] ** 2.0
    )
    corrected_azim = azimuthal + np.arctan2(correction[1], (radius + correction[0]))

    corrected_point[0] = corrected_radius * np.cos(corrected_azim)
    corrected_point[1] = corrected_radius * np.sin(corrected_azim)
    corrected_point[2] = point[2] - z_correction

    return corrected_point

create_electron_corrector(ecorr_path)

Create an ElectronCorrector

Parameters:

Name Type Description Default
ecorr_path Path

The path to the correction grid data

 required

Returns:

Type Description
ElectronCorrector

The corrector object
Source code in src/spyral/correction/electron_corrector.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
def create_electron_corrector(ecorr_path: Path) -> ElectronCorrector:
    """Create an ElectronCorrector

    Parameters
    ----------
    ecorr_path: pathlib.Path
        The path to the correction grid data

    Returns
    -------
    ElectronCorrector
        The corrector object

    """
    rho_bin_min = 0.0
    rho_bin_max = 275.0
    rho_bins = 276

    z_bin_min = 0.0
    z_bin_max = 1000.0
    z_bins = 1001

    grid: np.ndarray = np.load(ecorr_path)

    interpolator = BilinearInterpolator(
        rho_bin_min, rho_bin_max, rho_bins, z_bin_min, z_bin_max, z_bins, grid
    )
    return ElectronCorrector(interpolator)