Gridded Hazard

Queries for retrieving gridded hazard objects.

Attributes:

Name	Type	Description
mGH		alias for the GriddedHazard model

get_gridded_hazard(hazard_model_ids, location_grid_ids, vs30s, imts, aggs, poes)

Query the GriddedHazard table

Parameters:

Name	Type	Description	Default
hazard_model_ids	Iterable[str]	ids Hazard model	required
location_grid_ids	Iterable[str]	ids for the location grids	required
vs30s	Iterable[float]	vs30 values eg [400, 500]	required
imts	Iterable[str]	imt (IntensityMeasureType) values e.g ['PGA', 'SA(0.5)']	required
aggs	Iterable[str]	aggregation values e.g. ['mean']	required
poes	Iterable[float]		required

Source code in toshi_hazard_store/query/gridded_hazard_query.py

def get_gridded_hazard(
    hazard_model_ids: Iterable[str],
    location_grid_ids: Iterable[str],
    vs30s: Iterable[float],
    imts: Iterable[str],
    aggs: Iterable[str],
    poes: Iterable[float],
) -> Iterator[mGH]:
    """Query the GriddedHazard table

    Parameters:
        hazard_model_ids: ids Hazard model
        location_grid_ids: ids for the location grids
        vs30s: vs30 values eg [400, 500]
        imts: imt (IntensityMeasureType) values e.g ['PGA', 'SA(0.5)']
        aggs: aggregation values e.g. ['mean']
        poes:
    Yields:
        GriddedHazard objects
    """

    # partition_key = f"{obj.hazard_model_id}"

    def build_condition_expr(hazard_model_id, location_grid_id, vs30, imt, agg, poe):
        """Build filter condition."""
        condition_expr = (
            (mGH.hazard_model_id == hazard_model_id)
            & (mGH.location_grid_id == location_grid_id)
            & (mGH.vs30 == vs30)
            & (mGH.imt == imt)
            & (mGH.agg == agg)
            & (mGH.poe == poe)
        )
        return condition_expr

    total_hits = 0
    for hazard_model_id, grid_id, vs30, imt, agg, poe in itertools.product(
        hazard_model_ids, location_grid_ids, vs30s, imts, aggs, poes
    ):

        sort_key_first_val = f"{hazard_model_id}:{grid_id}:{vs30}:{imt}:{agg}:{poe}"
        condition_expr = build_condition_expr(hazard_model_id, grid_id, vs30, imt, agg, poe)

        log.debug(f'sort_key_first_val {sort_key_first_val}')
        log.debug(f'condition_expr {condition_expr}')

        qry = mGH.query(hazard_model_id, mGH.sort_key == sort_key_first_val, filter_condition=condition_expr)

        log.debug(f"get_gridded_hazard: qry {qry}")
        for hit in qry:
            total_hits += 1
            yield (hit)

    log.info('Total %s hits' % total_hits)

get_one_gridded_hazard(hazard_model_id, location_grid_id, vs30, imt, agg, poe)

Query the GriddedHazard table for a single item

Parameters:

Name	Type	Description	Default
hazard_model_id	str	id for the required Hazard model	required
location_grid_id	str	id for the location grid	required
vs30	float	the vs30 value	required
imt	str		required
agg	str		required
poe	float		required

Yields:

Type	Description
mGH	GriddedHazard objects (one or none)

Source code in toshi_hazard_store/query/gridded_hazard_query.py

def get_one_gridded_hazard(
    hazard_model_id: str,
    location_grid_id: str,
    vs30: float,
    imt: str,
    agg: str,
    poe: float,
) -> Iterator[mGH]:
    """Query the GriddedHazard table for a single item

    Parameters:
        hazard_model_id: id for the required Hazard model
        location_grid_id: id for the location grid
        vs30: the vs30 value
        imt:
        agg:
        poe:

    Yields:
        GriddedHazard objects (one or none)
    """

    qry = mGH.query(hazard_model_id, mGH.sort_key == f'{hazard_model_id}:{location_grid_id}:{vs30}:{imt}:{agg}:{poe}')
    log.debug(f"get_gridded_hazard: qry {qry}")
    for hit in qry:
        yield (hit)