API reference

Classes

• photonforge.AmplitudeModTimeStepper Time-stepper for a uniform electro-optic amplitude modulator.
• photonforge.AnalyticDirectionalCouplerModel Analytic model for a 4-port directional coupler.
• photonforge.AnalyticMZIModel Analytic model for a 4-port Mach-Zehnder interferometer.
• photonforge.AnalyticWaveguideModel Analytic model for waveguides, bends, and EO modulators.
• photonforge.AnalyticWaveguideTimeStepper Analytic waveguide time-stepper with power-dependent effects.
• photonforge.AvalanchePhotodiodeTimeStepper Avalanche photodiode with excess noise and a gain-bandwidth limit.
• photonforge.BraggGratingModel Waveguide Bragg grating from coupled-mode theory.
• photonforge.CWLaserTimeStepper Time-stepper for a continuous-wave (CW) laser source.
• photonforge.Capacitor Two-terminal capacitor.
• photonforge.Circle Circular primitives including circles, ellipses, rings and sectors.
• photonforge.CircuitModel Model based on circuit-level S-parameter calculation.
• photonforge.CircuitTimeStepper Circuit-level time stepper.
• photonforge.CirculatorModel Data model for a 3-port circulator.
• photonforge.Component Component object.
• photonforge.ConstructiveSolid Constructive geometry based on combinations of solids.
• photonforge.CrossingModel Data model for a 4-port waveguide crossing.
• photonforge.DMLaserTimeStepper Time-stepper for a directly modulated laser source.
• photonforge.DRCResults Results of a DRC run, from any engine.
• photonforge.DataModel Model based on existing S matrix data.
• photonforge.DelayedTimeStepper Time stepper that adds time delays to other time steppers.
• photonforge.DifferentialTimeStepper Time stepper for differentiating electrical signals in time.
• photonforge.DirectionalCouplerCircuitModel Model for directional couplers based on circuit decomposition.
• photonforge.DirectionalCouplerModel Data model for a 4-port directional coupler.
• photonforge.DualRingModel Dual ring resonator/modulator model with single or double bus.
• photonforge.EMEModel S matrix model based on Eigenmode Expansion calculation.
• photonforge.ElectricalAmplifierTimeStepper Time-stepper for a broadband amplifier or modulator driver.
• photonforge.ElectroAbsorptionModTimeStepper Time-stepper for an electro-absorption modulator (EAM).
• photonforge.Expression Numerical parametric expression object.
• photonforge.ExpressionTimeStepper Expression time stepper for electrical signals.
• photonforge.Extruded Extruded volumetric object.
• photonforge.ExtrusionSpec Extrusion specification for masks.
• photonforge.ExtrusionTable Extrusion specification table viewer.
• photonforge.FiberPort Fiber beam port.
• photonforge.FilterTimeStepper Filter time stepper for electrical signals
• photonforge.GaussianPort Gaussian beam port.
• photonforge.IdealTransformer Ideal transformer with turns ratio n:1.
• photonforge.IdealTransmissionLine Lossless transmission line.
• photonforge.Inductor Two-terminal inductor.
• photonforge.IntegralTimeStepper Time stepper for integrating electrical signals in time.
• photonforge.Interpolator Interpolator object.
• photonforge.IsolatorModel Data model for a 2-port isolator.
• photonforge.LVSResults Results of an LVS run, from any engine.
• photonforge.Label Text label.
• photonforge.LayerSpec Layer specification.
• photonforge.LayerTable Layer specification table viewer.
• photonforge.LumpedModel Abstract lumped model class for computing MNA (Modified Nodal Analysis) stamps.
• photonforge.MNAMatrix Modified Nodal Analysis (MNA) matrix.
• photonforge.MZMTimeStepper Time-stepper for a push-pull or dual-drive Mach-Zehnder modulator.
• photonforge.MaskSpec Mask specification.
• photonforge.Model Abstract model class to calculate a component’s S matrix.
• photonforge.MultimodeInterferometerModel Multimode interferometer model.
• photonforge.MuxDemuxModel Wavelength multiplexer/demultiplexer (WDM).
• photonforge.OpticalAmplifierTimeStepper Time-stepper for a unidirectional optical amplifier.
• photonforge.OpticalNoiseTimeStepper Time-stepper for an optical white-noise source.
• photonforge.OpticalPulseTimeStepper Time-stepper for a Gaussian optical pulse source.
• photonforge.ParallelRLC Parallel RLC circuit between two terminals.
• photonforge.Path Planar path object.
• photonforge.PathLengthMatching Path-length matching specification for one group of nets.
• photonforge.PhaseModTimeStepper Time-stepper for a uniform electro-optic phase modulator.
• photonforge.PhfStream Create a PhfStream object for writing or loading phf files.
• photonforge.PhotodiodeTimeStepper Time-stepper for a photodiode and a transimpedance amplifier (TIA).
• photonforge.PolarizationBeamSplitterModel Data model for a 3-port polarization beam splitter.
• photonforge.PolarizationModeDispersionModel Frequency-dependent Jones matrix of a randomly birefringent fibre.
• photonforge.PolarizationModeDispersionTimeStepper Time stepper for PolarizationModeDispersionModel.
• photonforge.PolarizationSplitterRotatorModel Data model for a polarization splitter rotator.
• photonforge.PoleResidueMatrix Pole-residue representation of an S matrix.
• photonforge.Polygon Polygonal geometric object.
• photonforge.Polyhedron Triangulated volumetric object.
• photonforge.Port 2D port.
• photonforge.PortSpec Optical or electrical port specification.
• photonforge.PortSpecTable Port specification table viewer.
• photonforge.PowerSplitterModel Data model for a 3-port power splitter.
• photonforge.Properties Properties container.
• photonforge.Rectangle Rectangular geometric object.
• photonforge.Reference Reference to a 2D component.
• photonforge.Resistor Two-terminal resistor.
• photonforge.RingModel Analytic ring resonator/modulator model with single or double bus.
• photonforge.RingTimeStepper Analytic ring resonator time-stepper with single or double bus.
• photonforge.SMatrix S matrix object.
• photonforge.SMatrixTimeStepper Time stepper based on a time-domain model.
• photonforge.SemiconductorAmplifierTimeStepper Time-stepper for a semiconductor optical amplifier (SOA).
• photonforge.SeriesRLC Series RLC circuit between two terminals.
• photonforge.Technology Technology specifications.
• photonforge.Terminal Electrical terminal.
• photonforge.TerminatedModTimeStepper Time-stepper for a travelling-wave electro-optic phase modulator.
• photonforge.TerminationModel Data model for a 1-port device.
• photonforge.Tidy3DAutogradConfig Configuration for Tidy3D-specific autograd finite-difference behavior.
• photonforge.Tidy3DModel S matrix model based on Tidy3D FDTD calculation.
• photonforge.TimeDomainModel Time-domain model based on a pole-residue representation of an S matrix.
• photonforge.TimeSeries Time series data.
• photonforge.TimeStepper Abstract time stepper class used to time step a component.
• photonforge.TwoPortModel Data model for a 2-port component.
• photonforge.WaveformTimeStepper Time-stepper for a signal generator from several waveforms.
• photonforge.WaveguideModel Data model for straight waveguides.
• photonforge.YMatrix Nodal admittance matrix (Y matrix).
• photonforge.ZMatrix Nodal impedance matrix (Z matrix).
• photonforge.live_viewer.LiveViewer Live viewer for PhotonForge objects and layout files.
• photonforge.monte_carlo.RandomVariable Args
• photonforge.pda.AttachmentStatus What a project holds, and which of its files no longer describe it.
• photonforge.pda.BoundQuery A saved pointer attached to a component, and what it points at.
• photonforge.pda.Edit One change in a document’s chain, with the state it produced.
• photonforge.pda.EditLog The chain behind one document, oldest first.
• photonforge.pda.History An ordered view of the versions and tags on one or more documents.
• photonforge.pda.HistoryEntry One version or tag, as a plain dict with convenience accessors.
• photonforge.pda.Project Live view of a PDA project or library document.
• photonforge.pda.ProjectTree What a project holds, as a tree of nodes. A mapping over its plain data.
• photonforge.pda.Trace The result of walking one attachment back to a component.
• photonforge.pda.TraceabilityMatrix Which file belongs to which version: one row per file, one column per version.
• photonforge.pda.Version What one call to Project.add_version did.
• photonforge.pda.Watcher A running watch. Call cancel when you are done with it.
• photonforge.verification.DRCCell A cell of the results.
• photonforge.verification.DRCCellReference An example placement of a cell in another cell; parent is that cell’s key.
• photonforge.verification.DRCMarker Marker of one violation, with the cell it was found in.
• photonforge.verification.DRCViolation The markers of one rule (category).
• photonforge.verification.EdgeMarker One edge, for rules that report edges.
• photonforge.verification.EdgePairMarker Two edges; symmetric for same-layer rules (width, space), directed otherwise,
• photonforge.verification.LVSCircuit A circuit of a netlist, with lookups by id or index that raise KeyError.
• photonforge.verification.LVSComparison The comparison of a layout circuit with a schematic circuit.
• photonforge.verification.LVSConnection What a net connects to: a circuit pin, a subcircuit pin, or a device terminal.
• photonforge.verification.LVSDevice An extracted or schematic device; terminals maps terminal names to net ids.
• photonforge.verification.LVSDeviceAbstract The geometry of an extracted device, per terminal and layer.
• photonforge.verification.LVSDeviceClass A device class; template names KLayout’s built-in class it derives from.
• photonforge.verification.LVSDevicePart One of the extracted devices combined into a device.
• photonforge.verification.LVSGeometry A polygon attached to a message.
• photonforge.verification.LVSLabel A text label KLayout attached to a layout net.
• photonforge.verification.LVSLayer A layer of the extraction and the layers and global nets it connects to.
• photonforge.verification.LVSMessage A comparison or extraction message.
• photonforge.verification.LVSNet A net of a circuit, with its connections and, for the layout, its geometry per layer.
• photonforge.verification.LVSNetlist The layout or the schematic netlist; circuits is in file order, children first.
• photonforge.verification.LVSPair Two objects KLayout paired; either side is None when it found no partner.
• photonforge.verification.LVSParameterDefinition A parameter of a device class; primary parameters are compared by LVS.
• photonforge.verification.LVSPin A circuit pin and the net it connects to.
• photonforge.verification.LVSSubcircuit An instance of another circuit; pins maps its pin indices to net ids.
• photonforge.verification.Placement Magnification, then mirroring about x, then counter-clockwise rotation, then displacement.
• photonforge.verification.PolygonMarker A polygon with optional holes; boxes and paths are reported as polygons.
• photonforge.verification.TextMarker A text output and its position.
• photonforge.verification.ValueMarker Any other marker value, as the engine prints it (KLayout only).

Functions

• photonforge.abort_pending_tasks Abort all known pending Tidy3D pending tasks.
• photonforge.basic_technology Create a basic technology to be used as an example.
• photonforge.boolean Compute the boolean operation between 2 sets of polygons.
• photonforge.cache_s_matrix Decorator that can be used in Model.start to cache results.
• photonforge.component_from_netlist Create a component from a netlist description.
• photonforge.cpw_spec Template to generate a coplanar transmission line PortSpec.
• photonforge.dispersion_from_beta2 Convert $\beta_2$, $\beta_3$ to PhotonForge’s D and S.
• photonforge.drc_check Run a design rule check (DRC) on a layout.
• photonforge.effective_route_length Measure the effective length of waveguides.
• photonforge.envelope Create an envelope for the given structures.
• photonforge.eo_s21 Electro-optic response of a terminated traveling-wave modulator.
• photonforge.find_top_level Filter a set of components to return only top-level ones.
• photonforge.franz_keldysh_absorption Franz-Keldysh absorption table for a bulk electro-absorber.
• photonforge.frequency_classification Return a classification for the frequencies: “optical” or “electrical”.
• 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.grid_layout Arrange components or other structures in a grid layout.
• photonforge.heal Heal a set of polygons by removing small features.
• photonforge.intersects Check whether 2 sets of polygons share any point.
• photonforge.load_drc_results Read the results database of an earlier design rule check.
• photonforge.load_full_phf Load all the contents of a phf file.
• photonforge.load_layout Load a layout file as components.
• photonforge.load_lvs_results Read the results of an earlier layout-versus-schematic comparison.
• photonforge.load_phf Load the contents of a phf file.
• photonforge.load_snp Load an S matrix from a Touchstone (snp) file.
• photonforge.lvs_check Run a layout-versus-schematic (LVS) comparison.
• photonforge.match_path_lengths Match the (optical) path lengths of existing routes, in place.
• photonforge.miller_gain Tabulate Miller’s empirical multiplication curve.
• photonforge.offset Dilate or erode a set of polygons.
• photonforge.pack_layout Arrange components or other structures in a grid layout.
• photonforge.parametric_component Decorator to create parametric components from functions.
• photonforge.parametric_technology Decorator to create parametric technologies from functions.
• photonforge.plot_s_matrix Helper function to plot a component S matrix.
• photonforge.pole_residue_fit Fit S matrix elements with rational functions sharing a set of poles.
• photonforge.port_modes Compute the port modes using Tidy3D’s mode solver.
• photonforge.reference_chain Create a chain of connected references from a text sequence.
• photonforge.register_model_class Register a model class derived from Model.
• photonforge.register_time_stepper_class Register a time stepper class derived from TimeStepper.
• photonforge.route_length Measure the length of parametric routes.
• photonforge.routing_collisions Find route collisions with obstacles and sibling route segments.
• photonforge.s_bend_length Compute the ideal S bend length for a given offset and radius.
• photonforge.s_to_y_matrix Convert an S-matrix (scattering matrix) to a Y-matrix (admittance matrix).
• photonforge.s_to_z_matrix Convert an S-matrix (scattering matrix) to a Z-matrix (impedance matrix).
• photonforge.saturation_output_power Output power at which the gain has dropped 3 dB from unsaturated.
• photonforge.select_references Paths of the references a query selects, as updates would.
• photonforge.set_unique_names Ensure the set of components and their dependencies have unique names.
• photonforge.snap_to_grid Snap the value to the current grid.
• photonforge.srh_lifetime Shockley-Read-Hall carrier lifetime as a function of excess density.
• photonforge.text Create polygonal text.
• photonforge.tidy3d_plot Helper function to plot a component through Tidy3D.
• photonforge.tidy3d_structures_from_layout Convert a layout cell to Tidy3D structures according to a technology specification.
• photonforge.virtual_port_spec Template to generate a virtual PortSpec.
• photonforge.write_layout Export this component as a GDSII or OASIS file.
• photonforge.write_phf Save a phf file with photonforge or other objects.
• photonforge.y_to_s_matrix Convert a Y-matrix (admittance matrix) to an S-matrix (scattering matrix).
• photonforge.y_to_z_matrix Convert a Y-matrix (admittance matrix) to a Z-matrix (impedance matrix).
• photonforge.z_to_s_matrix Convert a Z-matrix (impedance matrix) to an S-matrix (scattering matrix).
• photonforge.z_to_y_matrix Convert a Z-matrix (impedance matrix) to a Y-matrix (admittance matrix).
• photonforge.abstract.absolute Absolute value of the input signal.
• photonforge.abstract.adder Abstract electrical adder: linearly combine 2 inputs.
• photonforge.abstract.amplitude_modulator Abstract amplitude modulator.
• photonforge.abstract.avalanche_photodiode Abstract avalanche photodiode.
• photonforge.abstract.awg Abstract arrayed waveguide grating.
• photonforge.abstract.bend Abstract bend waveguide section.
• photonforge.abstract.bragg_grating Abstract waveguide Bragg grating.
• photonforge.abstract.circulator Abstract 3-port optical circulator.
• photonforge.abstract.crossing Abstract waveguide crossing.
• photonforge.abstract.cw_laser Abstract CW Laser source.
• photonforge.abstract.differentiator Derivative of the input signal.
• photonforge.abstract.directional_coupler Abstract directional coupler.
• photonforge.abstract.dm_laser Abstract directly modulated laser source.
• photonforge.abstract.edge_coupler Abstract edge coupler.
• photonforge.abstract.electrical_amplifier Abstract electrical amplifier with constant gain.
• photonforge.abstract.electrical_termination Abstract electrical one-port termination.
• photonforge.abstract.electro_absorption_modulator Abstract electro-absorption modulator (EAM).
• photonforge.abstract.fiber A fiber, as one element stepped in one or more sections.
• photonforge.abstract.filter Abstract filter for electrical signals.
• photonforge.abstract.grating_coupler Abstract grating coupler.
• photonforge.abstract.impedance_mismatch Abstract transmission line impedance mismatch.
• photonforge.abstract.integrator Integral of the input signal.
• photonforge.abstract.isolator Abstract 2-port optical isolator.
• photonforge.abstract.mach_zehnder_modulator Abstract Mach-Zehnder modulator.
• photonforge.abstract.multiplier Abstract electrical multiplier: compute the product of 2 inputs.
• photonforge.abstract.mux_demux Abstract wavelength multiplexer/demultiplexer (WDM).
• photonforge.abstract.nonlinear_ring Abstract nonlinear microring resonator.
• photonforge.abstract.optical_amplifier Abstract optical amplifier with constant gain.
• photonforge.abstract.optical_noise Abstract optical noise source.
• photonforge.abstract.optical_pulse Abstract optical pulse source.
• photonforge.abstract.optical_termination Abstract optical one-port termination.
• photonforge.abstract.phase_modulator Abstract phase modulator.
• photonforge.abstract.photodiode Abstract photodiode.
• photonforge.abstract.pmd_fiber Two-port, two-mode component carrying only the PMD of a fiber span.
• photonforge.abstract.polarization_beam_splitter Abstract polarization beam splitter (PBS).
• photonforge.abstract.polarization_splitter_grating_coupler Abstract polarization splitter grating coupler (PSGC).
• photonforge.abstract.polarization_splitter_rotator Abstract polarization splitter-rotator.
• photonforge.abstract.ring_resonator Abstract ring resonator with optional electrical tuning.
• photonforge.abstract.scaler Abstract electrical scaler: constant gain multiplier.
• photonforge.abstract.semiconductor_amplifier Abstract semiconductor optical amplifier (SOA).
• photonforge.abstract.signal_source Abstract electrical signal generator.
• photonforge.abstract.straight Abstract waveguide section.
• photonforge.abstract.taper Abstract waveguide taper.
• photonforge.abstract.terminated_modulator Abstract terminated travelling-wave phase modulator.
• photonforge.abstract.transition Abstract waveguide transition.
• photonforge.abstract.vcsel Abstract vertical-cavity surface-emitting laser.
• photonforge.abstract.y_splitter Abstract 3-port optical Y-splitter.
• photonforge.cache.cache_capacity Set the runtime cache capacity.
• photonforge.cache.clear_cache Clear the runtime caches, but not the file cache.
• photonforge.fiber.brillouin_gain_spectrum Normalised Brillouin gain, a Lorentzian centred on the Stokes shift.
• photonforge.fiber.brillouin_threshold Critical power for stimulated Brillouin scattering.
• photonforge.fiber.fiber_parameters Convert a fibre datasheet into PhotonForge units.
• photonforge.fiber.filter_taps Dispersion filter length needed for one section.
• photonforge.fiber.raman_efficiency_at_shift Raman gain efficiency against Stokes shift.
• photonforge.fiber.raman_on_off_gain Undepleted-pump on/off Raman gain, in dB.
• photonforge.fiber.raman_profile Solve the coupled Raman power equations along the fibre.
• photonforge.fiber.section_count Sections needed to keep the nonlinear phase per section below a limit.
• photonforge.live_viewer.replay_edits Make, on a component a script has just built, the edits made to it in a LiveViewer.
• photonforge.monte_carlo.s_matrix Compute variations of a component’s S matrix.
• photonforge.parametric.bend Waveguide bend section.
• photonforge.parametric.circular_spiral Circular spiral.
• photonforge.parametric.crossing Waveguide crossing.
• photonforge.parametric.crossing45 45° waveguide crossing.
• photonforge.parametric.dual_ring_coupler Dual ring coupling region.
• photonforge.parametric.extend_ports Extend component ports, optionally changing their specifications.
• photonforge.parametric.fill Regular array of tiles filling a region around keep-out areas.
• photonforge.parametric.rectangular_spiral Rectangular spiral.
• photonforge.parametric.ring_coupler Ring/straight coupling region.
• photonforge.parametric.route Route the connection between 2 compatible ports.
• photonforge.parametric.route_auto Automatic optical routing between reference ports.
• photonforge.parametric.route_electrical Route between terminals, around obstacles and across layers.
• photonforge.parametric.route_l Route the connection between orthogonal ports.
• photonforge.parametric.route_manhattan Create a Manhattan path connecting 2 terminals.
• photonforge.parametric.route_s_bend Create an S bend connecting 2 compatible ports.
• photonforge.parametric.route_taper Create a taper connecting 2 terminals.
• photonforge.parametric.route_u Route the connection between parallel ports.
• photonforge.parametric.route_z Route the connection between parallel ports.
• photonforge.parametric.s_bend S bend waveguide section.
• photonforge.parametric.s_bend_coupler S bend coupling region.
• photonforge.parametric.s_bend_ring_coupler Ring coupling through an S bend curve.
• photonforge.parametric.s_bend_straight_coupler S bend/straight coupling region.
• photonforge.parametric.straight Straight waveguide section.
• photonforge.parametric.transition Straight waveguide that works as a transition between port profiles.
• photonforge.pda.create_project Create a new PDA project from current PhotonForge configuration.
• photonforge.pda.init Initialize global clients.
• photonforge.pda.last_timing_report Return the most recent rendered PDA timing report.
• photonforge.pda.list_libraries List versioned project libraries with optional metadata filters.
• photonforge.pda.list_projects List projects matching metadata, sharing, and retirement filters.
• photonforge.pda.load_project Load one project by name or document reference.
• photonforge.pda.restore_project Restore a previously retired project document.
• photonforge.pda.retire_project Retire a project document by name or identifier.
• photonforge.pda.stop Close and clear global clients.
• photonforge.pda.user_info Return current user ID and organization ID.
• photonforge.stencil.apodized_focused_grating Create an apodized focused grating.
• photonforge.stencil.apodized_grating Create an apodized grating.
• photonforge.stencil.as_component Create a parametric component from a stencil.
• photonforge.stencil.cross Create an equal-armed cross.
• photonforge.stencil.focused_grating Create a focused grating.
• photonforge.stencil.grating Create a linear grating.
• photonforge.stencil.linear_taper Create a linear taper.
• photonforge.stencil.mmi Create an MxN MMI.
• photonforge.stencil.ruler Create a ruler.
• photonforge.stencil.vernier_scale Create a Vernier scale.
• photonforge.typing.annotate Annotate a type with metadata.
• photonforge.typing.array Type for arrays with specified number of dimensions.
• photonforge.typing.expression Type for Expression with a minimal number of values.
• photonforge.typing.kwargs_for Type that represents keyword arguments for a function or class.
• photonforge.verification.layout_pins Pre-export function that draws pins over Port.

Constants

• photonforge.C_0 Speed of light in vacuum (in μm/s)
• photonforge.Z_INF Value: 20000000.0
• photonforge.config Global configuration is accessible as config. Do not instantiate
• photonforge.fiber.BRILLOUIN_SHIFT_1550 Value: 10900000000.0
• photonforge.fiber.RAMAN_PEAK_SHIFT Value: 13200000000000.0
• photonforge.fiber.SMF28 Value: {'attenuation': 0.2, 'dispersion': 17.0, 'dispersion_slope': 0.056, 'effective_area': 80.0, 'kerr_index': 2.6e-20}
• photonforge.live_viewer.MAX_TILE_LAYOUT_BYTES The largest layout SVG a library tile draws, in bytes; a bigger cell keeps its symbol. A three-turn spiral is about 130 kB.
• photonforge.typing.Angle Value: typing.Annotated[float, units='°']
• photonforge.typing.Capacitance Value: typing.Annotated[float, exclusiveMinimum=0, units='F']
• photonforge.typing.ComplexFieldAmplitude Value: typing.Annotated[complex, units='√W']
• photonforge.typing.Coordinate Value: typing.Annotated[float, units='μm']
• photonforge.typing.Coordinate2D Value: typing.Annotated[collections.abc.Sequence[typing.Annotated[float, units='μm']], maxItems=2, minItems=2]
• photonforge.typing.Dimension Value: typing.Annotated[float, minimum=0, units='μm']
• photonforge.typing.Dimension2D Value: typing.Annotated[collections.abc.Sequence[typing.Annotated[float, minimum=0, units='μm']], maxItems=2, minItems=2]
• photonforge.typing.Dispersion Value: typing.Annotated[float, units='s/μm²']
• photonforge.typing.DispersionSlope Value: typing.Annotated[float, units='s/μm³']
• photonforge.typing.FieldAmplitude Value: typing.Annotated[float, units='√W']
• photonforge.typing.Fraction Value: typing.Annotated[float, maximum=1, minimum=0]
• photonforge.typing.Frequency Value: typing.Annotated[float, minimum=0, units='Hz']
• photonforge.typing.Gain Value: typing.Annotated[float, units='dB']
• photonforge.typing.Impedance Value: typing.Annotated[complex, units='Ω']
• photonforge.typing.Inductance Value: typing.Annotated[float, minimum=0, units='H']
• photonforge.typing.Layer Value: typing.Annotated[str | tuple[int, int], _]
• photonforge.typing.Loss Value: typing.Annotated[float, minimum=0, units='dB']
• photonforge.typing.Medium Annotated keeps the union intact in Medium | None so schemas can recognize it
• photonforge.typing.NegativeFloat Value: typing.Annotated[float, exclusiveMaximum=0]
• photonforge.typing.NegativeInt Value: typing.Annotated[int, exclusiveMaximum=0]
• photonforge.typing.NonNegativeFloat Value: typing.Annotated[float, minimum=0]
• photonforge.typing.NonNegativeInt Value: typing.Annotated[int, minimum=0]
• photonforge.typing.NonPositiveFloat Value: typing.Annotated[float, maximum=0]
• photonforge.typing.NonPositiveInt Value: typing.Annotated[int, maximum=0]
• photonforge.typing.PositiveDimension Value: typing.Annotated[float, exclusiveMinimum=0, units='μm']
• photonforge.typing.PositiveDimension2D Value: typing.Annotated[collections.abc.Sequence[typing.Annotated[float, exclusiveMinimum=0, units='μm']], maxItems=2, minItems=2]
• photonforge.typing.PositiveFloat Value: typing.Annotated[float, exclusiveMinimum=0]
• photonforge.typing.PositiveInt Value: typing.Annotated[int, exclusiveMinimum=0]
• photonforge.typing.Power Value: typing.Annotated[float, minimum=0, units='W']
• photonforge.typing.Power_dBm Value: typing.Annotated[float, units='dBm']
• photonforge.typing.PropagationLoss Value: typing.Annotated[float, minimum=0, units='dB/μm']
• photonforge.typing.Resistance Value: typing.Annotated[float, exclusiveMinimum=0, units='Ω']
• photonforge.typing.Temperature Value: typing.Annotated[float, minimum=0, units='K']
• photonforge.typing.Time Value: typing.Annotated[float, units='s']
• photonforge.typing.TimeDelay Value: typing.Annotated[float, minimum=0, units='s']
• photonforge.typing.Velocity Value: typing.Annotated[float, exclusiveMinimum=0, units='μm/s']
• photonforge.typing.Voltage Value: typing.Annotated[float, units='V']
• photonforge.utils.H Planck’s constant (in Js)
• photonforge.utils.HBAR : Reduced Planck constant, in J s.
• photonforge.utils.K_B Boltzmann constant (in J/K)
• photonforge.utils.M_0 : Electron rest mass, in kg.
• photonforge.utils.Q Elementary charge (in C)
• photonforge.verification.Edge Built-in immutable sequence.
• photonforge.verification.LVSSeverity
• photonforge.verification.LVSStatus
• photonforge.verification.LVSVerdict
• photonforge.verification.Point Built-in immutable sequence.
• photonforge.verification.Polygon Built-in immutable sequence.