Skip to content

Analysis reference

photonhub.analysis holds the analysis layer that sits on top of a run: mode solvers, EME, S-matrix assembly, near-to-far-field projection, resonance extraction. It is imported explicitly:

from photonhub import analysis

Everything here is pure Python in the Apache-2.0 SDK.

Mode solving

Eigenmode solvers for waveguide cross-sections: the general ModeSolver, the full-vector solver, and the grid-consistent family whose modes are grid-consistent with the FDTD fields they will drive.

Mode sources and monitors

The recommended way to launch and read a guided mode. mode_launch builds a matched source/monitor pair; transmission turns a finished run into a power spectrum.

Eigenmode expansion (EME)

Mode-matching propagation through a sequence of uniform sections. Use the convergence helpers to assess the retained modes and interfaces.

S-matrix

Drive each port in turn and assemble the complex scattering matrix, with reciprocity and passivity checks, Touchstone files and wavelength-interpolated circuit models.

Beams and imported sources

Excitations built from phased source planes: focused Gaussian beams, thin-lens fields, and fields imported from another calculation.

Far field and diffraction

Near-to-far-field projection from a closed or open monitor box, the fields of a recorded plane colocated on its grid nodes, and grating diffraction-order analysis. The far-field guide walks through a projection and states its measured accuracy.

Spectra and resonances

Extract resonances from a ring-down by harmonic inversion, and complete a truncated spectrum when a run is stopped before the fields have fully decayed.