Skip to content

container_functions

average_polarised_scans(*scans)

Find unique polarisations and average each scan at that polarisation Spectra are only separated by polarisation, all spectra with the same polarisation are averaged together.

pol1, pol2 = average_polarised_scans(*scans)

Parameters:

Name Type Description Default
scans SpectraContainer

list of SpectraContainer objects

 ()

Returns:

Type Description
tuple[SpectraContainerAverage, SpectraContainerAverage | None]

pol1, (pol2|None) SpectraContainer objects for opposite polarisations
Source code in mmg_toolbox/xas/container_functions.py 
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
def average_polarised_scans(*scans: SpectraContainer) -> tuple[SpectraContainerAverage, SpectraContainerAverage | None]:
    """
    Find unique polarisations and average each scan at that polarisation
    Spectra are only separated by polarisation, all spectra with the same polarisation
    are averaged together.

        pol1, pol2 = average_polarised_scans(*scans)

    :param scans: list of SpectraContainer objects
    :return: pol1, (pol2|None) SpectraContainer objects for opposite polarisations
    """
    pols = opposite_polarisations(scans[0].metadata.pol, scans[0].metadata.pol_angle)
    pol_scans = [
        [scan for scan in scans if check_polarisation(scan.metadata.pol) == pol]
        for pol in pols
    ]

    # average spectra containers
    av_scans = [
        average_scans(*_scans)
        for _scans in pol_scans
    ]

    # rename containers
    for pol, scan, pol_scan_list in zip(pols, av_scans, pol_scans):
        scan.name = pol
        scan.parents = pol_scan_list
        for spectra in scan.spectra.values():
            spectra.process_label += f"_{pol}"
    if len(pol_scans) == 1:
        return av_scans[0], None
    return av_scans[0], av_scans[1]

average_scans(*scans)

Average spectra within a set of scans

av_scan = average_scans(scan1, scan2, scan3)

Equivalent to: av_scan = sum([scan2, scan3], scan1)

Parameters:

Name Type Description Default
scans SpectraContainer

list of SpectraContainer objects

 ()

Returns:

Type Description
SpectraContainerAverage

SpectraContainer object containing averaged spectra
Source code in mmg_toolbox/xas/container_functions.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
def average_scans(*scans: SpectraContainer) -> SpectraContainerAverage:
    """
    Average spectra within a set of scans

        av_scan = average_scans(scan1, scan2, scan3)

    Equivalent to: av_scan = sum([scan2, scan3], scan1)

    :param scans: list of SpectraContainer objects
    :return: SpectraContainer object containing averaged spectra
    """
    return SpectraContainerAverage(*scans)

pair_scans(*scans)

Find the polarisation pair of each spectra from the list of spectra

[(pol1, pol2), (pol3, pol4)] = pair_scans(*scans)

Scans are paired against their opposite polarisation or the opposite magnetic field, whichever comes first.

Parameters:

Name Type Description Default
scans SpectraContainer

list of SpectraContainer objects

 ()

Returns:

Type Description
list[tuple[SpectraContainer, SpectraContainer]]

list((pol1, pol2)) SpectraContainer objects for opposite polarisations
Source code in mmg_toolbox/xas/container_functions.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
def pair_scans(*scans: SpectraContainer) -> list[tuple[SpectraContainer, SpectraContainer]]:
    """
    Find the polarisation pair of each spectra from the list of spectra

        [(pol1, pol2), (pol3, pol4)] = pair_scans(*scans)

    Scans are paired against their opposite polarisation or the opposite magnetic field,
    whichever comes first.

    :param scans: list of SpectraContainer objects
    :return: list((pol1, pol2)) SpectraContainer objects for opposite polarisations
    """
    pairs: list[tuple[SpectraContainer, SpectraContainer]] = []
    scans = list(scans)
    for n, scan in enumerate(scans):
        pol, op_pol = opposite_polarisations(scan.metadata.pol, scan.metadata.pol_angle)
        field = scan.metadata.mag_field
        for m, next_scan in enumerate(scans[n + 1:]):
            if next_scan.metadata.pol == op_pol or abs(next_scan.metadata.mag_field + field) < 0.01:
                pairs.append((scan, scans.pop(n + m + 1)))
                break
    return pairs

polarised_pairs(*scans)

Find the polarisation pair of each spectra from the list of spectra

[(pol1, pol2), (pol3, pol4)] = polarised_pairs(*scans)

Parameters:

Name Type Description Default
scans SpectraContainer

list of SpectraContainer objects

 ()

Returns:

Type Description
list[tuple[SpectraContainer, SpectraContainer]]

list((pol1, pol2)) SpectraContainer objects for opposite polarisations
Source code in mmg_toolbox/xas/container_functions.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def polarised_pairs(*scans: SpectraContainer) -> list[tuple[SpectraContainer, SpectraContainer]]:
    """
    Find the polarisation pair of each spectra from the list of spectra

        [(pol1, pol2), (pol3, pol4)] = polarised_pairs(*scans)

    :param scans: list of SpectraContainer objects
    :return: list((pol1, pol2)) SpectraContainer objects for opposite polarisations
    """
    pol1, pol2 = opposite_polarisations(scans[0].metadata.pol, scans[0].metadata.pol_angle)
    pol1_scans, pol2_scans = [
        [scan for scan in scans if check_polarisation(scan.metadata.pol) == pol]
        for pol in (pol1, pol2)
    ]
    return list((p1, p2) for p1, p2 in zip(pol1_scans, pol2_scans))