ExceedanceFrequencyLine

ExceedanceFrequencyLine(
    self,
    result_variable,
    model_uncertainty=True,
    levels=None,
    step_size=0.1,
)

Calculate a frequency line for a result variable (e.g. h (waterlevel), hs (significant wave height)) for a location

Attributes

Name	Description
model_uncertainty_steps

Methods

Name	Description
calculate	Execute a calculation
calculate_location	Calculate the exceedance probability of the variable at a given set of levels.
set_levels	Change the levels.
set_model_uncertainty_steps	Set the number of model uncertainty steps
set_result_variable	Change the result variable for which the frequency line will be calculated.
set_step_size	Change the step size of the frequency line.
use_model_uncertainty	Use model uncertainty when calculating a frequency line.

calculate

ExceedanceFrequencyLine.calculate(input)

Execute a calculation

Parameters

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

calculate_location

ExceedanceFrequencyLine.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 result variable

set_levels

ExceedanceFrequencyLine.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_model_uncertainty_steps

ExceedanceFrequencyLine.set_model_uncertainty_steps(model_uncertainty_steps)

Set the number of model uncertainty steps

Parameters

Name	Type	Description	Default
model_uncertainty_steps	int	Number of model uncertainty steps	required

set_result_variable

ExceedanceFrequencyLine.set_result_variable(result_variable)

Change the result variable for which the frequency line will be calculated.

Parameters

Name	Type	Description	Default
result_variable	str	The result variable for which the frequency line will be calculated	required

set_step_size

ExceedanceFrequencyLine.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

ExceedanceFrequencyLine.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