PortResults

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

Container for port monitor simulation results.

Manages transmission data from Lumerical port monitors, providing methods to retrieve and process transmission values.

Parameters:

monitor_namestr

Name of the port monitor in the FDTD simulation.

metricstr

Metric to extract (should be ‘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 port monitor (inherited from BaseResults).

valuesanp.ndarray or None

Transmission values, populated after get_results().

wavelengthslist

Requested wavelengths; inherited from BaseResults.

Methods

PortResults.extract_wavelengths(...)	Extract metric values at specific wavelengths.
PortResults.get_results(fdtd_session)	Retrieve and extract port monitor results from the FDTD session.
PortResults.get_transmission_results(...)	Retrieve transmission results from a port monitor.