pybsm.metrics.functional.niirs5

pybsm.metrics.functional.niirs5(*, sensor: Sensor, scenario: Scenario, interp: bool | None = False) → Metrics

Returns NIIRS values calculate using GIQE 5 and all intermediate calculations.

See pybsm.metrics.functional.niirs for the GIQE 3 version. This version of the GIQE replaces the earlier versions and should be used in all future analyses.

Parameters:

  • sensor – an object from the class sensor

  • scenario – an object from the class scenario

Returns:

nm:

an object containing results of the GIQE calculation along with many intermediate calculations