Skip to content

gradient_aware_harmonisation.plotting#

Helper functions

Functions:

Name Description
plotting

Plot the target, original and interpolated timeseries

plotting #

plotting(
    harmonisee_timeseries: Timeseries,
    target_timeseries: Timeseries,
    interpolated_timeseries: Timeseries,
    harmonisation_time: Union[int, float],
    convergence_time: Optional[Union[int, float]],
) -> None

Plot the target, original and interpolated timeseries

We expect these to have been computed with harmonise.

Parameters:

Name Type Description Default
harmonisee_timeseries Timeseries

Harmonisee timeseries (i.e. the timeseries we want to harmonise)

 required
target_timeseries Timeseries

Target timeseries (i.e. what we harmonise to)

 required
interpolated_timeseries Timeseries

Harmonised timeseries as returned by harmonise

 required
harmonisation_time Union[int, float]

Time point at which harmonisee should be matched to the target

 required
convergence_time Optional[Union[int, float]]

Time point at which the harmonised data should converge towards the prediced data.

 required
Source code in src/gradient_aware_harmonisation/plotting.py 
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
67
68
69
70
71
72
73
74
75
def plotting(
    harmonisee_timeseries: Timeseries,
    target_timeseries: Timeseries,
    interpolated_timeseries: Timeseries,
    harmonisation_time: Union[int, float],
    convergence_time: Optional[Union[int, float]],
) -> None:
    """
    Plot the target, original and interpolated timeseries

    We expect these to have been computed with
    [`harmonise`][gradient_aware_harmonisation.harmonise].

    Parameters
    ----------
    harmonisee_timeseries
        Harmonisee timeseries (i.e. the timeseries we want to harmonise)

    target_timeseries
        Target timeseries (i.e. what we harmonise to)

    interpolated_timeseries
        Harmonised timeseries as returned by
        [`harmonise`][gradient_aware_harmonisation.harmonise]

    harmonisation_time
        Time point at which harmonisee should be matched to the target

    convergence_time
        Time point at which the harmonised data
        should converge towards the prediced data.
    """
    try:
        import matplotlib.pyplot as plt
    except ImportError as exc:
        raise MissingOptionalDependencyError(
            "plotting", requirement="matplotlib"
        ) from exc

    plt.figure(figsize=(6, 3))
    plt.plot(
        harmonisee_timeseries.time_axis,
        harmonisee_timeseries.values,
        label="harmonisee",
        linestyle="--",
        color="black",
    )
    plt.plot(
        interpolated_timeseries.time_axis,
        interpolated_timeseries.values,
        label="harmonised",
    )
    plt.plot(
        target_timeseries.time_axis,
        target_timeseries.values,
        label="target",
        color="red",
    )
    plt.axvline(harmonisation_time, color="black", linestyle="dotted")
    if convergence_time is not None:
        plt.axvline(convergence_time, color="black", linestyle="dotted")
    plt.legend(handlelength=0.3, fontsize="small", frameon=False)
    plt.xlabel("time axis")
    plt.ylabel("value")
    plt.show()