Version 0.0.5

* Add self.get_start_point() for AEMD_grating. * New Class: SBend & ASBend. * Add a constant: pi = math.pi.
Hideousmon · Jul 24, 2021 · 7d2086f · 7d2086f
1 parent 2fe0e26
commit 7d2086f
Show file tree

Hide file tree

Showing 6 changed files with 327 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -47,4 +47,11 @@ The documentation can be found [here](https://splayout.readthedocs.io/en/latest/
 ### Version 0.0.4 (Jul 21, 2021)
 
 * Lift restrictions on taper length.
-* Support coordinate transfer for MAKE_COMPONENT.
+* Support coordinate transfer for MAKE_COMPONENT.
+
+### Version 0.0.5 (Jul 24, 2021)
+
+* Add self.get_start_point() for AEMD_grating.
+* New Class: SBend & ASBend.
+* Add a constant: pi = math.pi.
+
diff --git a/setup.py b/setup.py
@@ -7,7 +7,7 @@
     long_description = fin.read()
 
 setup(name='SPLayout',
-      version='0.0.4',
+      version='0.0.5',
       description='Silicon Photonics Design Tools for GDSII Files.',
       # long_description=long_description,
       author='Zhenyu ZHAO',

diff --git a/splayout/AEMDgrating.py b/splayout/AEMDgrating.py
@@ -86,4 +86,8 @@ def draw(self, cell, *args):
 
             return self.start_point
 
+        def get_start_point(self):
+
+            return self.start_point
+
     return AEMDgrating
diff --git a/splayout/__init__.py b/splayout/__init__.py
@@ -1,4 +1,4 @@
-__version__ = "0.0.4"
+__version__ = "0.0.5"
 
 from splayout.AEMDgrating import MAKE_AEMD_GRATING
 from splayout.bend import Bend
@@ -10,4 +10,5 @@
 from splayout.taper import Taper
 from splayout.text import Text
 from splayout.utils import *
-from splayout.waveguide import Waveguide
+from splayout.waveguide import Waveguide
+from splayout.sbend import SBend,ASBend
diff --git a/splayout/sbend.py b/splayout/sbend.py
@@ -0,0 +1,310 @@
+from splayout.utils import *
+from splayout.bend import Bend
+
+class SBend:
+    """
+    S-Bend Definition with a First Clockwise Bend in SPLayout.
+
+    Parameters
+    ----------
+    start_point : Point
+        Start point of the S-Bend.
+    end_point : Point
+        End point of the S-Bend.
+    width : float
+        Width of the waveguides (μm).
+    length : float
+        Length of the S-Bend (μm).
+    radius : float
+        Radius of the S-Bend once length is specified (μm).
+
+    Notes
+    --------
+    Once length is specified, the end_point of the S-Bend will be re-calculated.
+
+    """
+    def __init__(self,start_point, end_point, width,length=None,radius=5):
+        if (length != None and radius != None): # overwrite the properties of S-Bend
+            self.start_point = start_point
+            self.length = length
+            self.radius = radius
+            self.width = width
+            self.radian = self.length/2/self.radius
+            if (start_point.x > end_point.x and start_point.y > end_point.y): ## left down type
+                self.delta_y = self.radius * math.sin(self.radian) * 2
+                self.delta_x = (self.radius - self.radius * math.cos(self.radian)) * 2
+                self.end_point = self.start_point + (-self.delta_x,-self.delta_y)
+            if (start_point.x < end_point.x and start_point.y > end_point.y):  ## right down type
+                self.delta_x = self.radius * math.sin(self.radian) * 2
+                self.delta_y = (self.radius - self.radius * math.cos(self.radian)) * 2
+                self.end_point = self.start_point + (self.delta_x, -self.delta_y)
+            if (start_point.x < end_point.x and start_point.y < end_point.y):  ## right up type
+                self.delta_y = self.radius * math.sin(self.radian) * 2
+                self.delta_x = (self.radius - self.radius * math.cos(self.radian)) * 2
+                self.end_point = self.start_point + (self.delta_x, self.delta_y)
+            if (start_point.x > end_point.x and start_point.y < end_point.y):  ## left up type
+                self.delta_x = self.radius * math.sin(self.radian) * 2
+                self.delta_y = (self.radius - self.radius * math.cos(self.radian)) * 2
+                self.end_point = self.start_point + (-self.delta_x, self.delta_y)
+
+        else:
+            self.start_point = start_point
+            self.end_point = end_point
+            self.width = width
+
+            ## calculate radius and angle
+            self.delta_x = abs(start_point.x - end_point.x)
+            self.delta_y = abs(start_point.y - end_point.y)
+
+            if (start_point.x > end_point.x and start_point.y > end_point.y) or (start_point.x < end_point.x and start_point.y < end_point.y):
+                self.theta = math.atan(self.delta_y / self.delta_x)
+            else:
+                self.theta = math.atan(self.delta_x / self.delta_y)
+            self.radian = math.pi - 2 * self.theta
+            self.radius = math.sin(self.theta) * math.sqrt(
+                math.pow(self.delta_x / 2, 2) + math.pow(self.delta_y / 2, 2)) / math.sin(self.radian)
+            if (self.radius < 5):
+                print("Warning! The radius of the bends in SBend is too small! The radius now is:" + str(
+                    self.radius) + "μm.")
+            self.length = self.radian * self.radius
+
+
+
+        ## identify the type of S-Bend
+        if (start_point.x > end_point.x and start_point.y > end_point.y): ## left down type
+            self.first_bend_center_point = self.start_point + (-self.radius,0)
+            self.first_bend = Bend(self.first_bend_center_point,-self.radian,0,self.width,self.radius)
+            self.second_bend_center_point = self.end_point + (self.radius,0)
+            self.second_bend = Bend(self.second_bend_center_point,math.pi - self.radian, math.pi,self.width,self.radius)
+
+        if (start_point.x < end_point.x and start_point.y > end_point.y): ## right down type
+            self.first_bend_center_point = self.start_point + (0, -self.radius)
+            self.first_bend = Bend(self.first_bend_center_point, math.pi/2 - self.radian, math.pi/2, self.width, self.radius)
+            self.second_bend_center_point = self.end_point + (0, self.radius)
+            self.second_bend = Bend(self.second_bend_center_point, math.pi*3/2 - self.radian, math.pi*3/2, self.width,
+                                    self.radius)
+
+        if (start_point.x < end_point.x and start_point.y < end_point.y):  ## right up type
+            self.first_bend_center_point = self.start_point + (self.radius, 0)
+            self.first_bend = Bend(self.first_bend_center_point, math.pi - self.radian, math.pi, self.width, self.radius)
+            self.second_bend_center_point = self.end_point + (-self.radius, 0)
+            self.second_bend = Bend(self.second_bend_center_point, - self.radian, 0, self.width,
+                                    self.radius)
+
+        if (start_point.x > end_point.x and start_point.y < end_point.y): ## left up type
+            self.first_bend_center_point = self.start_point + (0, self.radius)
+            self.first_bend = Bend(self.first_bend_center_point, math.pi*3 / 2 - self.radian, math.pi*3 / 2, self.width,
+                                   self.radius)
+            self.second_bend_center_point = self.end_point + (0, -self.radius)
+            self.second_bend = Bend(self.second_bend_center_point, math.pi / 2 - self.radian, math.pi / 2,
+                                    self.width,
+                                    self.radius)
+
+    def draw(self, cell, layer):
+        """
+        Draw the Component on the layout.
+
+        Parameters
+        ----------
+        cell : Cell
+            Cell to draw the component.
+        layer : Layer
+            Layer to draw.
+
+        Returns
+        -------
+        out : Point,Point
+            Start point and end point.
+        """
+        self.first_bend.draw(cell, layer)
+        self.second_bend.draw(cell, layer)
+        return self.start_point, self.end_point
+
+    def get_start_point(self):
+        """
+        Derive the start point of the S-Bend.
+
+        Returns
+        -------
+        out : Point
+            Start point.
+        """
+        return self.start_point
+
+    def get_end_point(self):
+        """
+        Derive the end point of the S-Bend.
+
+        Returns
+        -------
+        out : Point
+            End point.
+        """
+        return self.end_point
+
+    def get_length(self):
+        """
+        Derive the length of the S-Bend.
+
+        Returns
+        -------
+        out : Point
+            End point.
+        """
+        return self.length
+
+
+class ASBend:
+    """
+    S-Bend Definition with a First Anti-Clockwise Bend in SPLayout.
+
+    Parameters
+    ----------
+    start_point : Point
+        Start point of the S-Bend.
+    end_point : Point
+        End point of the S-Bend.
+    width : float
+        Width of the waveguides (μm).
+    length : float
+        Length of the S-Bend (μm).
+    radius : float
+        Radius of the S-Bend once length is specified (μm).
+
+    Notes
+    --------
+    Once length is specified, the end_point of the S-Bend will be re-calculated.
+
+    """
+
+    def __init__(self, start_point, end_point, width, length=None, radius=5):
+        if (length != None and radius != None):  # overwrite the properties of S-Bend
+            self.start_point = start_point
+            self.length = length
+            self.radius = radius
+            self.width = width
+            self.radian = self.length / 2 / self.radius
+
+            if (start_point.x > end_point.x and start_point.y > end_point.y):  ## left down type
+                self.delta_x = self.radius * math.sin(self.radian) * 2
+                self.delta_y = (self.radius - self.radius * math.cos(self.radian)) * 2
+                self.end_point = self.start_point + (-self.delta_x, -self.delta_y)
+            if (start_point.x < end_point.x and start_point.y > end_point.y):  ## right down type
+                self.delta_y = self.radius * math.sin(self.radian) * 2
+                self.delta_x = (self.radius - self.radius * math.cos(self.radian)) * 2
+                self.end_point = self.start_point + (self.delta_x, -self.delta_y)
+            if (start_point.x < end_point.x and start_point.y < end_point.y):  ## right up type
+                self.delta_x = self.radius * math.sin(self.radian) * 2
+                self.delta_y = (self.radius - self.radius * math.cos(self.radian)) * 2
+                self.end_point = self.start_point + (self.delta_x, self.delta_y)
+            if (start_point.x > end_point.x and start_point.y < end_point.y):  ## left up type
+                self.delta_y = self.radius * math.sin(self.radian) * 2
+                self.delta_x = (self.radius - self.radius * math.cos(self.radian)) * 2
+                self.end_point = self.start_point + (-self.delta_x, self.delta_y)
+
+        else:
+            self.start_point = start_point
+            self.end_point = end_point
+            self.width = width
+
+            ## calculate radius and angle
+            self.delta_x = abs(start_point.x - end_point.x)
+            self.delta_y = abs(start_point.y - end_point.y)
+
+            if (start_point.x < end_point.x and start_point.y > end_point.y) or (
+                    start_point.x > end_point.x and start_point.y < end_point.y):
+                self.theta = math.atan(self.delta_y / self.delta_x)
+            else:
+                self.theta = math.atan(self.delta_x / self.delta_y)
+            self.radian = math.pi - 2 * self.theta
+            self.radius = math.sin(self.theta) * math.sqrt(
+                math.pow(self.delta_x / 2, 2) + math.pow(self.delta_y / 2, 2)) / math.sin(self.radian)
+            if (self.radius < 5):
+                print("Warning! The radius of the bends in SBend is too small! The radius now is:" + str(
+                    self.radius) + "μm.")
+            self.length = self.radian * self.radius
+
+        ## identify the type of S-Bend
+        if (start_point.x > end_point.x and start_point.y > end_point.y): ## left down type
+            self.first_bend_center_point = self.start_point + (0,-self.radius)
+            self.first_bend = Bend(self.first_bend_center_point,math.pi/2,math.pi/2 + self.radian,self.width,self.radius)
+            self.second_bend_center_point = self.end_point + (0,self.radius)
+            self.second_bend = Bend(self.second_bend_center_point,math.pi*3/2 , math.pi*3/2 + self.radian,self.width,self.radius)
+
+        if (start_point.x < end_point.x and start_point.y > end_point.y): ## right down type
+            self.first_bend_center_point = self.start_point + (self.radius, 0)
+            self.first_bend = Bend(self.first_bend_center_point, math.pi , math.pi + self.radian, self.width,
+                                   self.radius)
+            self.second_bend_center_point = self.end_point + (-self.radius, 0)
+            self.second_bend = Bend(self.second_bend_center_point,0,  self.radian,
+                                    self.width, self.radius)
+
+        if (start_point.x < end_point.x and start_point.y < end_point.y):  ## right up type
+            self.first_bend_center_point = self.start_point + (0, self.radius)
+            self.first_bend = Bend(self.first_bend_center_point, math.pi*3 / 2, math.pi*3 / 2 + self.radian, self.width,
+                                   self.radius)
+            self.second_bend_center_point = self.end_point + (0, -self.radius)
+            self.second_bend = Bend(self.second_bend_center_point, math.pi / 2, math.pi / 2 + self.radian,
+                                    self.width, self.radius)
+
+        if (start_point.x > end_point.x and start_point.y < end_point.y): ## left up type
+            self.first_bend_center_point = self.start_point + (-self.radius, 0)
+            self.first_bend = Bend(self.first_bend_center_point, 0 ,  self.radian, self.width,
+                                   self.radius)
+            self.second_bend_center_point = self.end_point + (self.radius, 0)
+            self.second_bend = Bend(self.second_bend_center_point, math.pi,  math.pi + self.radian,
+                                    self.width, self.radius)
+
+    def draw(self, cell, layer):
+        """
+        Draw the Component on the layout.
+
+        Parameters
+        ----------
+        cell : Cell
+            Cell to draw the component.
+        layer : Layer
+            Layer to draw.
+
+        Returns
+        -------
+        out : Point,Point
+            Start point and end point.
+        """
+        self.first_bend.draw(cell, layer)
+        self.second_bend.draw(cell, layer)
+        return self.start_point, self.end_point
+
+    def get_start_point(self):
+        """
+        Derive the start point of the S-Bend.
+
+        Returns
+        -------
+        out : Point
+            Start point.
+        """
+        return self.start_point
+
+    def get_end_point(self):
+        """
+        Derive the end point of the S-Bend.
+
+        Returns
+        -------
+        out : Point
+            End point.
+        """
+        return self.end_point
+
+    def get_length(self):
+        """
+        Derive the length of the S-Bend.
+
+        Returns
+        -------
+        out : Point
+            End point.
+        """
+        return self.length
+
diff --git a/splayout/utils.py b/splayout/utils.py
@@ -8,6 +8,7 @@
 DOWN = 270
 VERTICAL = 0
 HORIZONTAL = 1
+pi = math.pi
 
 ## global library
 common_lib = gdspy.GdsLibrary(unit=1.0e-6, precision=1.0e-9)