StarCouplerNxM¶

class awg_designer.all.StarCouplerNxM(*args, **kwargs)¶

A star coupler that couples light from N identical input apertures to M identical output apertures.

it places the input and output apertures according to a given mounting_in / mounting_out configuration (circular or rowland) and given set of angles,
it takes care of the DRC-correctness by specifying a pcell class for joining the individual apertures into a ‘MultiAperture’,
it places dummy apertures at the outside of both input and output side to improve the imaging quality.

If you want to use this cell in an AWG design, you will need to carefully define all angles (grating aperture angles, input / output aperture angles). Please check the relevant design functions in the toolbox for this (continue to the “see also” section below).

Parameters

aperture_in_cell: PCell: Aperture cell used for the input
aperture_out_cell: PCell: Aperture cell used for output
multiaperture_class:: Type of multi-aperture to be used
n_dummy_apertures: int and number >= 0: Number of dummy apertures
n_inputs: int and number > 0: Number of input channels.
n_outputs: int and number > 0: Number of output channels.
aperture_in_ports: List with type restriction, allowed types: <class ‘str’>: List of the input aperture port names that are connected to the outside world. The order of this list will determine the numbering of the input ports
aperture_out_ports: List with type restriction, allowed types: <class ‘str’>: list of the output aperture port names that are connected to the outside world. The order of this list will determine the numbering of the output ports
external_port_names: str: Map of the free instance terms/ports to the names of external terms/ports.Format is a dict {‘inst:term’ : ‘new_term_name’}.If a term/port is not listed, the format instname_portname will be used
slab_template: PCell and SlabTemplate: template for free propagation region
name: String that contains only ISO/IEC 8859-1 (extended ASCII py3) or pure ASCII (py2) characters: The unique name of the pcell

Other Parameters

aperture_in: PCell, locked: Input multi-aperture, managed by this cell
aperture_out: PCell, locked: Output multi-aperture, managed by this cell
apertures: locked
child_cells: locked
scatterers: locked
free_propagation_region: PCell and _FreePropagationRegion, locked: unpatterned slab section. This subcomponent is generated automatically to connect elements together.
links: locked