BaseResults

class lumopt2.fom.simulation_results.BaseResults(monitor_name: str, metric: str, wavelengths: List | float | int, tolerance: float = 1e-09, config=None)

Base class for simulation result objects.

Provides common functionality for sorting and organizing wavelength-dependent data.

Parameters:

monitor_namestr

Name of the monitor in the FDTD simulation.

metricstr

Metric to extract from the monitor (e.g., ‘intensity’, ‘transmission’).

wavelengthsUnion[List, float, int]

Wavelength(s) at which to extract metric values, in meters.

tolerancefloat, optional

Maximum allowed difference between requested and available wavelengths, in meters. Default is 1e-9.

configProjectConfig object, optional

Multi-forward configuration (default: None).

Attributes:

monitor_namestr

Name of the monitor.

metricstr

Metric to extract from the monitor.

wavelengthslist

List of wavelengths to extract.

tolerancefloat

Tolerance for wavelength matching.

valuesanp.ndarray or None

Extracted metric values (populated after get_results()).

Methods

BaseResults.extract_wavelengths(...)

Extract metric values at specific wavelengths.