get_star_coupler_apertures

awg_designer.all.get_star_coupler_apertures(apertures_arms, apertures_ports, angles_arms, angles_ports, radius, mounting='confocal', input=True)

Get the MultiApertures for your StarCoupler, along with the transformations of the individual apertures. Expects a list of apertures with dummies already included.

Parameters:

apertures_arms: list

list of aperture cells for the array/arms side of the star coupler (dummies should be included in this list)

apertures_ports: list

list of aperture cells for the ports side of the star coupler (dummies should be included in this list)

angles_arms: list of float

list of angles for the aperture_arms.

angles_ports: list of float

list of angles for the aperture_ports.

radius: float

grating radius for the star coupler

mounting: ‘confocal’ || ‘rowland’

the type of mounting to use, either ‘confocal’ or ‘rowland’. Default is ‘confocal’.

input: boolean

True if the star coupler is an input star coupler, False if it’s an output star coupler.

Returns:

apertures_arms: MultiAperture

the MultiAperture on the arm/array side, of the chosen MultiAperture type

apertures_ports: MultiAperture

the MultiAperture on the ports side, of the chosen MultiAperture type

aperture_arm_xforms: list(Transformation)

the transformations of the arm/array apertures

aperture_port_xforms: list(Transformation)

the transformations of the ports apertures