HBN

HBN(
    self,
    q_overtopping=0.01,
    levels=None,
    step_size=0.1,
    model_uncertainty=True,
)

Calculate the HBN for a location

Methods

Name	Description
calculate	Execute a calculation
calculate_location	Calculate the exceedance probability of the variable at a given set of levels.
set_critical_overtopping	Change the critical overtopping
set_levels	Change the levels.
set_step_size	Change the step size of the frequency line.
use_model_uncertainty	Use model uncertainty when calculating a frequency line.

calculate

HBN.calculate(input)

Execute a calculation

Parameters

Name	Type	Description	Default
input	Union[Location, HRDatabase]	The input	required

calculate_location

HBN.calculate_location(location)

Calculate the exceedance probability of the variable at a given set of levels. If the levels are not specified, they will be chosen at the 1st and 99th percentile of all values in the database.

Parameter

location : Location The Location object

Returns

Name	Type	Description
	FrequencyLine	Frequency line of the crest level

set_critical_overtopping

HBN.set_critical_overtopping(q_overtopping)

Change the critical overtopping

Parameters

Name	Type	Description	Default
q_overtopping	float	The critical overtopping [m3/m/s]	required

set_levels

HBN.set_levels(levels=None)

Change the levels. If levels is not defined, the frequency line is calculated based upon the 1st and 99th percentile.

Parameters

Name	Type	Description	Default
levels	list	The levels at which the exceedance probability has to be calculated	None

set_step_size

HBN.set_step_size(step_size)

Change the step size of the frequency line.

Parameters

Name	Type	Description	Default
step_size	float	The step size of the frequency line	required

use_model_uncertainty

HBN.use_model_uncertainty(model_uncertainty)

Use model uncertainty when calculating a frequency line.

Parameters

Name	Type	Description	Default
model_uncertainty	bool	Enable or disable the use of model uncertainties	required