source_modelling.scripts.plot_rakes

 1"""Plot a sample of rake values across a multi-segment rupture."""
 2
 3from pathlib import Path
 4from typing import Annotated, Optional
 5
 6import numpy as np
 7import typer
 8
 9from pygmt_helper import plotting
10from source_modelling import srf
11
12app = typer.Typer()
13
14
15@app.command(help="Plot a sample of rake values across a multi-segment rupture.")
16def plot_rakes(
17    srf_ffp: Annotated[
18        Path, typer.Argument(help="Path to SRF file to plot.", exists=True)
19    ],
20    output_ffp: Annotated[
21        Path, typer.Argument(help="Output plot image.", dir_okay=False)
22    ],
23    dpi: Annotated[
24        float, typer.Option(help="Plot output DPI (higher is better).")
25    ] = 300,
26    title: Annotated[Optional[str], typer.Option(help="Plot title to use.")] = None,
27    sample_size: Annotated[
28        int, typer.Option(help="Number of points to sample for rake.")
29    ] = 200,
30    vector_length: Annotated[
31        float, typer.Option(help="Length of rake vectors (cm).")
32    ] = 0.2,
33    seed: Annotated[
34        Optional[int], typer.Option(help="Random seed to sample rakes with")
35    ] = None,
36) -> None:
37    """Plot an SRF file and output a PNG file.
38
39    Parameters
40    ----------
41    srf_ffp : Path
42        Path to the SRF file.
43    output_ffp : Path
44        Path of the output plot image.
45    dpi : float, default 300
46        Plot output DPI (higher is better).
47    title : Optional[str], default None
48        Plot title to use.
49    sample_size : int, default 200
50        Number of points to sample for rake.
51    vector_length : float, default 0.2cm
52        Length of rake vectors (cm).
53    """
54    srf_data = srf.read_srf(srf_ffp)
55    region = (
56        srf_data.points["lon"].min() - 0.5,
57        srf_data.points["lon"].max() + 0.5,
58        srf_data.points["lat"].min() - 0.25,
59        srf_data.points["lat"].max() + 0.25,
60    )
61
62    fig = plotting.gen_region_fig(title, region=region, map_data=None)
63    i = 0
64
65    np.random.seed(seed)
66    vectors = srf_data.points[["lon", "lat", "rake"]].sample(sample_size)
67    vectors["rake"] = (vectors["rake"] + 90) % 360
68    vectors["length"] = vector_length
69
70    fig.plot(
71        data=vectors.values.tolist(), style="v0.1c+e+a30", pen="0.2p", fill="black"
72    )
73    for _, segment in srf_data.header.iterrows():
74        nstk = int(segment["nstk"])
75        ndip = int(segment["ndip"])
76        point_count = nstk * ndip
77        segment_points = srf_data.points.iloc[i : i + point_count]
78        corners = segment_points.iloc[[0, nstk - 1, -1, (ndip - 1) * nstk]]
79        fig.plot(
80            x=corners["lon"].iloc[list(range(len(corners))) + [0]].to_list(),
81            y=corners["lat"].iloc[list(range(len(corners))) + [0]].to_list(),
82            pen="0.5p,black,-",
83        )
84
85        i += point_count
86
87    fig.savefig(
88        output_ffp,
89        dpi=dpi,
90        anti_alias=True,
91    )
92
93
94if __name__ == "__main__":
95    app()