MaxFilter: Filters the output of a element according to a maximum value

In albgarre/biorisk: What the Package Does (One Line, Title Case)

Filters the output of a element according to a maximum value

Description

Filters the output of a element according to a maximum value

Filters the output of a element according to a maximum value

Super class

biorisk::RiskElement -> MaxFilter

Methods

Public methods

• MaxFilter$new()

• MaxFilter$get_output_type()

• MaxFilter$point_estimate()

• MaxFilter$clone()

Inherited methods

• biorisk::RiskElement$boxplot()
• biorisk::RiskElement$check_input_types()
• biorisk::RiskElement$cummulative_plot()
• biorisk::RiskElement$cummulative_plot_2D()
• biorisk::RiskElement$density_plot()
• biorisk::RiskElement$density_plot_2D()
• biorisk::RiskElement$get_output()
• biorisk::RiskElement$get_output_2D()
• biorisk::RiskElement$histogram()
• biorisk::RiskElement$map_input()
• biorisk::RiskElement$quantiles()
• biorisk::RiskElement$quantiles_2D()
• biorisk::RiskElement$save_as_distribution()
• biorisk::RiskElement$save_as_vector()
• biorisk::RiskElement$simulate()
• biorisk::RiskElement$simulate_2D()
• biorisk::RiskElement$simulate_level()

---

Method new()

Usage

MaxFilter$new(name, max_value, units = NA, output_unit = NA, rule = 1)

---

Method get_output_type()

Get the data type of the output.

Usage

MaxFilter$get_output_type()

---

Method point_estimate()

Returns the expected value

Usage

MaxFilter$point_estimate()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

MaxFilter$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

albgarre/biorisk documentation built on Feb. 23, 2025, 5:19 a.m.