FieldResults

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

Container for field monitor simulation results.

Manages field data (Ex, Ey, Ez) from Lumerical field monitors, providing methods to retrieve and process electromagnetic field distributions.

Parameters:

monitor_namestr

Name of the field monitor in the FDTD simulation.

metricstr

Metric to extract (should be ‘intensity’).

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 field monitor.

valuesanp.ndarray or None

Total field intensity (|Ex|^2 + |Ey|^2 + |Ez|^2), populated after get_results().

wavelengthslist

Requested wavelengths; inherited from BaseResults.

Methods

FieldResults.extract_wavelengths(...)	Extract metric values at specific wavelengths.
FieldResults.get_field_intensity_results(...)	Retrieve field intensity results from a field monitor.
FieldResults.get_results(fdtd_session)	Retrieve and extract field monitor results from the FDTD session.