flood.calculate_hazard

methods.flood.calculate_hazard(
    hazard,
    reference,
    ground_flht,
    ground_elevtn=0,
    method='mean',
)

Calculate the hazard value for flood hazard.

Parameters

Name	Type	Description	Default
hazard	list	Raw hazard values.	required
reference	str	Reference, either ‘dem’ or ‘datum’.	required
ground_flht	float	The height of the floor of an object (.e.g the door elevation).	required
ground_elevtn	float	Ground height in reference to e.g. the ocean. (Needed when ‘reference’ is ‘datum’)	`0`
method	str	Chose ‘max’ or ‘mean’ for either the maximum value or the average, by default ‘mean’.	`'mean'`

Name	Type	Description
	float	A representative hazard value.