Utilities

Classes

• photonforge.Expression Numerical parametric expression object.
• photonforge.Interpolator Interpolator object.
• photonforge.Properties Properties container.
• photonforge.PathLengthMatching Path-length matching specification for one group of nets.
• photonforge.LayerTable Layer specification table viewer.
• photonforge.ExtrusionTable Extrusion specification table viewer.
• photonforge.PortSpecTable Port specification table viewer.
• photonforge.live_viewer.LiveViewer Live viewer for PhotonForge objects and layout files.

Layout Functions

• photonforge.grid_layout Arrange components or other structures in a grid layout.
• photonforge.pack_layout Arrange components or other structures in a grid layout.
• photonforge.s_bend_length Compute the ideal S bend length for a given offset and radius.
• photonforge.match_path_lengths Match the (optical) path lengths of existing routes, in place.

Grid Functions

• photonforge.grid_ceil Snap the value to the current grid rounding towards $+\infty$.
• photonforge.grid_floor Snap the value to the current grid rounding towards $-\infty$.
• photonforge.snap_to_grid Snap the value to the current grid.

Plot Functions

• photonforge.plot_s_matrix Helper function to plot a component S matrix.
• photonforge.tidy3d_plot Helper function to plot a component through Tidy3D.

Live Viewer Functions

• photonforge.live_viewer.replay_edits Make, on a component a script has just built, the edits made to it in a LiveViewer.

Constants

• photonforge.C_0 Speed of light in vacuum (in μm/s)
• photonforge.Z_INF Extrusion limit (in μm) that stands for an infinite extent along z.