shakemap.py 13.5 KB
Newer Older
1
2
3
4
5
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
"""
Implements the core shakemap class
"""
import h5py
import numpy as np
import warnings
from typing import Dict, Optional, Tuple, List
from openquake.hazardlib import const, imt
from openquake.hazardlib.contexts import ContextMaker
from shakyground2 import valid
from shakyground2.earthquake import Earthquake
from shakyground2.site_model import SiteModel
from shakyground2.synthetic_rupture_generator import FiniteRuptureSampler


class Shakemap(object):
    """
    The core class for calculating shakemaps. The general workflow contained within
    takes the input earthquake and site model in order to build the source, path and site
    context objects (i.e. containers that hold the data needed for the ground motion models).

    The contexts objects are built upon instantiation of the shakemap class to avoid
    recalculation if further shakemaps are needed.

    The Shakemap class also caches the information into an hdf5 binary object, if desired by
    the user. This means that the shakemap information for an earthquake ccould be retrieved at
    a later time without the need for recalculation.
    """

    def __init__(
        self,
        earthquake: Earthquake,
        site_model: SiteModel,
34
        ground_motion_model: List,
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
        tectonic_region: str,
        cache_file: Optional[str] = None,
        num_rupture_samples: int = 100,
        rdim: float = 0.0,
        synth_dist_weights: List = [0.25, 0.25, 0.25, 0.25],
        synthetic_rupture_max_site_distance: float = 200.0,
        synthetic_rupture_site_spacing: float = 0.05,
    ):
        """
        Args:
            earthquake:
                Earthquake as an instance of the :class:shakyground2.earthquake.Earthquake
            site_model:
                Target sites used for calculation of the ground motion values, as instances of
                :class:shakyground2.site_model.SiteModel
            ground_motion_model:
51
52
53
                Set of ground motion models and their respective weights as a list of tuples
                of (ID, GMM, Weight) where ID is the unique ID of the GMM and its associated
                weight
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
            tectonic_region:
                Tectonic region to which the earthquake is assigned
            cache_file:
                Path to the hdf5 file for caching the results. It does not need to exist
                but if the hdf5 file exists and contains an instance of the same event
                (according to the earthquake.id) then the user will be warned here and the
                existing shakemaps for that earthquake ID subsequently overwitten if the
                user persists to implement the shakemap.
            num_rupture_samples:
                In the likely case that no rupture surface is available for the earthquake,
                one will be generated by the :class:`shakyground2.synthetic_rupture_generator.
                FiniteRuptureSampler`. This controls the number of samples to be used
            rdim:
                Exponent of the distance-dependent site weighing adopted by the :class:
                `shakyground2.synthetic_rupture_generator.FiniteRuptureSampler`

            synth_dist_weights: Can adjust the weight assigned to the different distance
                                metrics used by the FiniteRuptureSampler
            synthetic_rupture max_site_distance: In the case that the target sites for the
                                                 FiniteRuptureSampler need to be built from the
                                                 bounding box, this defines the maximum
                                                 distances of the target sites to define the
                                                 bounding box
            synthetic_rupture_site_spacing: In the case that the target sites for the
                                            FiniteRuptureSampler need to be built from the
                                            bounding box, this defines the site spacing of the
                                            sites
        """
        self.earthquake = earthquake
        self.site_model = site_model
        self.tectonic_region = tectonic_region
        self.ground_motion_model = ground_motion_model
        self.num_rupture_samples = num_rupture_samples
        self.rdim = rdim
        self.synthetic_rupture_distance_weights = synth_dist_weights
        if cache_file:
            self.caching = True
            self.cache_file = cache_file
            # Check if the earthquake is cleady in the case and warn the user if so
            fle = h5py.File(self.cache_file, "a")
            if earthquake.id in list(fle):
                warnings.warn(
                    "Earthquake %s already in cache file %s - "
                    "Running the shakemaps will overwrite this"
                    % (self.earthquake.id, self.cache_file)
                )
            fle.close()
        else:
            self.caching = False
            self.cache_file = None
        self.rctx = None
        self.dctx = None
        self.sctx = None
        self.synth_rupture_max_site_dist = valid.positive_float(
            synthetic_rupture_max_site_distance, "Max. Synthetic Rupture Site Distance"
        )
        self.synth_rupture_site_spacing = valid.positive_float(
            synthetic_rupture_site_spacing, "Synthetic Rupture Site Spacing"
        )
        self._build_contexts()

    def _build_contexts(self):
        """
        Construct the rupture, site and distances contexts from the earthquake, site and
        ground motion models
        """
120
121
122
        cmaker = ContextMaker(
            self.tectonic_region, [gmm[1] for gmm in self.ground_motion_model]
        )
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

        if not self.earthquake.rupture:
            # Use the finite rupture sampler to generate the rupture and corresponding
            # distances from the available information
            self.earthquake._rupture = FiniteRuptureSampler().get_finite_rupture(
                self.num_rupture_samples,
                self.earthquake,
                rdim=self.rdim,
                weights=self.synthetic_rupture_distance_weights,
                maximum_site_distance=self.synth_rupture_max_site_dist,
                site_spacing=self.synth_rupture_site_spacing,
            )[0]
        # For the sites and rupture context we can use the context maker to get all of the
        # source, site and rupture distances
        self.rctx, self.sctx, self.dctx = cmaker.make_contexts(
            self.site_model.get_site_collection(), self.earthquake.rupture
        )

    def _cache_contexts(self, grp: h5py.Group):
        """
        If caching the shakemaps, then this stores the context information to the file
        """
        # Add the contexts to the group object
        ctxt = grp.create_group("contexts")
        rup_ctxt = ctxt.create_group("rupture")
        dist_ctxt = ctxt.create_group("distances")
149
        for gmm in [gmm[1] for gmm in self.ground_motion_model]:
150
151
152
153
154
155
156
157
158
            for rup_attr in gmm.REQUIRES_RUPTURE_PARAMETERS:
                if rup_attr not in rup_ctxt.attrs:
                    rup_ctxt.attrs[rup_attr] = getattr(self.rctx, rup_attr)
            for attr in gmm.REQUIRES_DISTANCES:
                if attr not in list(dist_ctxt):
                    distance = getattr(self.dctx, attr)
                    dist_dset = dist_ctxt.create_dataset(attr, distance.shape, dtype="f")
                    dist_dset[:] = distance
        site_ctxt = ctxt.create_dataset(
159
160
161
            "sites",
            self.site_model.site_array.shape,
            dtype=self.site_model.site_array.dtype,
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
        )
        site_ctxt[:] = self.site_model.site_array
        if self.site_model.bbox_properties:
            # If the site model has bounding box properties then store these
            # as attributes
            site_ctxt.attrs["has_bbox"] = True
            site_ctxt.attrs["llon"] = self.site_model.bbox_properties["bbox"][0]
            site_ctxt.attrs["llat"] = self.site_model.bbox_properties["bbox"][1]
            site_ctxt.attrs["ulon"] = self.site_model.bbox_properties["bbox"][2]
            site_ctxt.attrs["ulat"] = self.site_model.bbox_properties["bbox"][3]
            site_ctxt.attrs["spcx"] = self.site_model.bbox_properties["spcx"]
            site_ctxt.attrs["spcy"] = self.site_model.bbox_properties["spcy"]
            site_ctxt.attrs["ncol"] = self.site_model.bbox_properties["ncol"]
            site_ctxt.attrs["nrow"] = self.site_model.bbox_properties["nrow"]
        else:
            site_ctxt.attrs["has_bbox"] = False
        return

    def get_shakemap(
        self, intensity_measure_types: List
    ) -> Tuple[np.ndarray, np.ndarray, Dict]:
        """
        Main function to constructs the shakemaps for the specified intensity measures,
        caching the information to hdf5 if requested

        Args:
            intensity_measure_types: List of intensity measures for which the shakemaps will
                                     be calculated

        Returns:
            aggregated_means: The mean of the ground motions from the different ground motion
                              models weighted by the assigned input weights
            aggregated_stddevs: The total standard deviation of the ground motions from the
                                different ground motion models weighted by the assigned
                                input weights
            shakemaps: Dictionary of individual shakemaps for each ground motion model
        """
        shakemaps = {}
        shakemap_dtypes = np.dtype(
            [
                (intensity_measure_type, np.float64)
                for intensity_measure_type in intensity_measure_types
            ]
        )
        if self.caching:
            # If caching, open (or create) the file and cache the contexts
            fle = h5py.File(self.cache_file, "r+")
            if self.earthquake.id in list(fle):
                del fle[self.earthquake.id]
            fle_eq = fle.create_group(self.earthquake.id)
            self._cache_contexts(fle_eq)

        # Pre-allocate the aggregated shakemaps with zeros
        aggregated_means = np.zeros(self.site_model.shape, dtype=shakemap_dtypes)
        aggregated_stddevs = np.zeros(self.site_model.shape, dtype=shakemap_dtypes)
217
218
        for gmm_id, gmm, weight in self.ground_motion_model:
            shakemaps[gmm_id] = {
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
                "weight": weight,
                "mean": np.zeros(self.site_model.shape, dtype=shakemap_dtypes),
                "stddev": np.zeros(self.site_model.shape, dtype=shakemap_dtypes),
            }
            for intensity_measure_type in intensity_measure_types:
                input_imt = imt.from_string(intensity_measure_type)
                try:
                    mean, [stddev] = gmm.get_mean_and_stddevs(
                        self.sctx, self.rctx, self.dctx, input_imt, [const.StdDev.TOTAL]
                    )
                except KeyError:
                    warnings.warn(
                        "Ground motion model %s not defined for intensity "
                        "measure type %s" % (str(gmm), intensity_measure_type)
                    )
                    continue
                aggregated_means[intensity_measure_type] += weight * mean
                aggregated_stddevs[intensity_measure_type] += weight * stddev
237
238
                shakemaps[gmm_id]["mean"][intensity_measure_type] = mean
                shakemaps[gmm_id]["stddev"][intensity_measure_type] = stddev
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
        if self.caching:
            self._cache_shakemap(
                fle_eq, shakemaps, aggregated_means, aggregated_stddevs, shakemap_dtypes
            )
            fle.close()
        return aggregated_means, aggregated_stddevs, shakemaps

    def _cache_shakemap(
        self,
        fle: h5py.Group,
        shakemaps: Dict,
        aggregated_means: np.ndarray,
        aggregated_stddevs: np.ndarray,
        shakemap_dtypes: np.dtype,
    ):
        """
        If caching is required then the shakemaps are written to the hdf5 file

        Args:
            fle: HDF5 group object to store the shakemaps
            shakemaps: Dictionary of individual shakemaps for each ground motion model
            aggregated_means: The mean of the ground motions from the different ground motion
                              models weighted by the assigned input weights
            aggregated_stddevs: The total standard deviation of the ground motions from the
                                different ground motion models weighted by the assigned
                                input weights
            shakemap_dtypes: IMT-dependent data type of the shakemaps
        """
        shakemap_grp = fle.create_group("shakemaps")
268
269
270
        for gmm_id in shakemaps:
            gmm_grp = shakemap_grp.create_group(gmm_id)
            gmm_grp.attrs["weight"] = shakemaps[gmm_id]["weight"]
271
            mean_dset = gmm_grp.create_dataset(
272
                "mean", shakemaps[gmm_id]["mean"].shape, dtype=shakemap_dtypes
273
            )
274
            mean_dset[:] = shakemaps[gmm_id]["mean"]
275
            stddev_dset = gmm_grp.create_dataset(
276
                "stddev", shakemaps[gmm_id]["stddev"].shape, dtype=shakemap_dtypes
277
            )
278
            stddev_dset[:] = shakemaps[gmm_id]["stddev"]
279
280
281
282
283
284
285
286
287
288
        # Store the agregated results
        aggregated_grp = fle.create_group("aggregated")
        aggregated_mean_dset = aggregated_grp.create_dataset(
            "mean", aggregated_means.shape, shakemap_dtypes
        )
        aggregated_mean_dset[:] = aggregated_means
        aggregated_stddev_dset = aggregated_grp.create_dataset(
            "stddev", aggregated_stddevs.shape, shakemap_dtypes
        )
        aggregated_stddev_dset[:] = aggregated_stddevs