libera_utils.scene_identification.scene_definitions.Scene

class libera_utils.scene_identification.scene_definitions.Scene(scene_id: int, variable_ranges: dict[str, tuple[float | None, float | None]])

Bases: object

Represents a single scene with its variable bin definitions.

A scene defines a specific atmospheric state characterized by ranges of multiple variables (e.g., cloud fraction, optical depth, surface type). Data points are classified into scenes when all their variable values fall within the scene’s defined ranges.

Variables:

• scene_id (int) – Unique identifier for this scene

• variable_ranges (dict[str, tuple[float, float]]) – Dictionary mapping variable names to (min, max) tuples defining the acceptable range for each variable. None values indicate unbounded ranges (no min or no max constraint).

Examples

>>> scene = Scene(
...     scene_id=1,
...     variable_ranges={
...         "Cloud_Fraction": (0.0, 50.0),
...         "optical_depth": (0.0, 10.0)
...     }
... )
>>> scene.matches({"Cloud_Fraction": 30.0, "optical_depth": 5.0})
True
>>> scene.matches({"Cloud_Fraction": 60.0, "optical_depth": 5.0})
False

__init__(scene_id: int, variable_ranges: dict[str, tuple[float | None, float | None]]) → None

Methods

get_bin_bounds(variable)	Get the (min, max) bin bounds for a single variable in this scene.
get_bounded_variables()	Get list of variables that have at least one defined bound.
matches(data_point)	Check if a data point falls within all variable ranges for this scene.

get_bin_bounds(variable: str) → tuple[float | None, float | None]

Get the (min, max) bin bounds for a single variable in this scene.

Parameters:

variable (str) – Name of the classification variable.

Returns:

The (min, max) bounds for the variable. None indicates an unbounded side. Variables not constrained by this scene return (None, None).

Return type:

tuple of (float or None, float or None)

get_bounded_variables() → list[str]

Get list of variables that have at least one defined bound.

Returns:

Variable names where at least one of (min, max) is not None

Return type:

list of str

matches(data_point: dict[str, float]) → bool

Check if a data point falls within all variable ranges for this scene.

Only variables with at least one defined bound are checked. Variables with both bounds as None (unbounded) are ignored.