Merge pull request #96 from amccaugh/dev

1.5.0

Author: amccaugh

.gitignore

@@ -83,3 +83,5 @@ target/
 *.bat
 *.lyp
 *.oas
+
+.vscode/

CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+
+## 1.5.0 (April 19, 2021)
+
+### New features
+- Better interactive windows for `quickplot()`! Now you can use the mousewheel/trackpad scroll to zoom in and out, and right-click or left-click to zoom to a region.
+- Added `blocking` option for `quickplot()` (thanks @giumc)
+
+### Changes
+- Quickplot options (such as displaying ports, subports, or aliases) are now set using `set_quickplot_options()`
+
+### Bugfixes
+- Fix for Path function `smooth()`, which broke when sequential waypoints were co-linear (thanks @giumc)
+- Fix for non-C-continguous arrays in `hash_geometry()`  (thanks Joaquin Matres @joamatab)
+
+
+### Bugfixes
+
 ## 1.4.4 (Feb 23, 2021)
 
 Bugfix release

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Adam N. McCaughan
+Copyright (c) 2021 Adam N. McCaughan
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -6,9 +6,10 @@ GDS scripting that's intuitive, fast, and powerful.  For Python 2 and 3.
 - [**Installation / requirements**](#installation--requirements)
 - [**Tutorial + examples**](https://phidl.readthedocs.io/en/latest/tutorials.html) (or [try an interactive notebook](https://mybinder.org/v2/gh/amccaugh/phidl/master?filepath=phidl_tutorial_example.ipynb))
 - [**Geometry library + function documentation**](https://phidl.readthedocs.io/)
-- [Changelog](https://github.com/amccaugh/phidl/blob/master/CHANGELOG.md) (latest update 1.4.4, Feb 23, 2021)
-    - Allow labels imported through import_gds() to be moved (thanks Joaquin Matres @joamatab)
-    - Fix to Path.smooth() to prevent right-angle turns from accidentally having an additional +180 degrees applied to them (thanks Jeffrey Holzgrafe @jolzgrafe)
+- [Changelog](https://github.com/amccaugh/phidl/blob/master/CHANGELOG.md) (latest update 1.5.0 on April 27, 2021)
+  - Better interactive windows for `quickplot()`! Now you can use the mousewheel/trackpad scroll to zoom in and out, and right-click or left-click to zoom to a region.
+  - Quickplot options (such as displaying ports, subports, or aliases) are now set using `set_quickplot_options()`
+  - A few bugfixes
 
 
 # Gallery

docs/geometry_reference.ipynb

@@ -19,10 +19,9 @@
     "\n",
     "# Configure quickplot to hide subports\n",
     "import functools\n",
-    "from phidl import quickplot as qp\n",
+    "from phidl import quickplot as qp, set_quickplot_options\n",
     "import phidl\n",
-    "qp = functools.partial(qp, show_subports = False)\n",
-    "phidl.quickplot = qp"
+    "set_quickplot_options(show_subports = False)"
    ]
   },
   {
@@ -2247,7 +2246,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.6"
+   "version": "3.9.1"
   }
  },
  "nbformat": 4,

phidl/__init__.py

@@ -1,5 +1,5 @@
 from phidl.device_layout import Device, Group, Path, CrossSection, Port, Layer, LayerSet
 from phidl.device_layout import make_device
-from phidl.quickplotter import quickplot, quickplot2
+from phidl.quickplotter import quickplot, quickplot2, set_quickplot_options
 from phidl.device_layout import __version__, reset
 from phidl.geometry import device_lru_cache

phidl/device_layout.py

@@ -9,13 +9,10 @@
 #==============================================================================
 # Minor TODO
 #==============================================================================
-# Make pg.vstack() and pg.hstack() -- point to grid()
 # Add Group.get_polygons()
 # Allow Boolean to use Groups
-# Add Paths to quickplot2
 # Add pp.delay_sine(distance = 10, length = 20, num_periods = 2)
 # add wire_basic to phidl.routing.  also add endcap parameter
-# check that aliases show up properly in quickplot2
 # phidl add autoarray_xy to pg.geometry()
 # Allow connect(overlap) to be a tuple (0, 0.7)
 # Possibly replace gdspy bezier (font rendering) with
@@ -59,7 +56,7 @@
 import gdspy.library
 gdspy.library.use_current_library = False
 
-__version__ = '1.4.4'
+__version__ = '1.5.0'
 
 
 #==============================================================================
@@ -1701,7 +1698,7 @@ def hash_geometry(self, precision = 1e-4):
         for layer in sorted_layers:
             layer_hash = hashlib.sha1(layer.astype(np.int64)).digest()
             polygons = polygons_by_spec[tuple(layer)]
-            polygons = [((p/precision) + magic_offset).astype(np.int64) for p in polygons]
+            polygons = [np.ascontiguousarray((p/precision) + magic_offset, dtype  = np.int64) for p in polygons]
             polygon_hashes = np.sort([hashlib.sha1(p).digest() for p in polygons])
             final_hash.update(layer_hash)
             for ph in polygon_hashes:
@@ -2256,7 +2253,7 @@ def add(self, element):
         else:
             raise ValueError('[PHIDL] add() Could not add element to Group, the only ' \
                              'allowed element types are ' \
-                             '(Device, DeviceReference, Port, Polygon, CellArray, Label, Group)')
+                             '(Device, DeviceReference, Polygon, CellArray, Label, Group)')
         # Remove non-unique entries
         used = set()
         self.elements = [x for x in self.elements if x not in used and (used.add(x) or True)]
@@ -2344,7 +2341,10 @@ def align(self, alignment = 'ymax'):
         _align(elements = self.elements, alignment = alignment)
         return self
 
-PHIDL_ELEMENTS = (Device, DeviceReference, Port, Polygon, CellArray, Label, Group)
+
+
+
+PHIDL_ELEMENTS = (Device, DeviceReference, Polygon, CellArray, Label, Group)
 
 
 

phidl/geometry.py

@@ -4332,13 +4332,12 @@ def optimal_hairpin(width = 0.2, pitch = 0.6, length = 10, turn_ratio = 4,
     return D
 
 
-# TODO Include parameter which specifies "half" (one edge flat) vs
-# "full" (both edges curved)
 @device_lru_cache
 def optimal_step(start_width = 10, end_width = 22, num_pts = 50,
                  width_tol = 1e-3, anticrowding_factor = 1.2,
                  symmetric = False, layer = 0):
     """ Creates an optimally-rounded step geometry.
+
     Parameters
     ----------
     start_width : int or float
@@ -4349,7 +4348,6 @@ def optimal_step(start_width = 10, end_width = 22, num_pts = 50,
         The number of points comprising the entire step geometry.
     width_tol : float
         Point at which to terminate the calculation of the optimal step
-
     anticrowding_factor : int or float
         Factor to reduce current crowding by elongating
         the structure and reducing the curvature

phidl/path.py

@@ -284,6 +284,18 @@ def spiral(num_turns = 5, gap = 1, inner_gap = 2, num_pts = 10000):
     # print(P.end_angle)
     return P
 
+def _compute_segments(points):
+    points = np.asfarray(points)
+    normals = np.diff(points, axis = 0)
+    normals = (normals.T/np.linalg.norm(normals, axis = 1)).T
+    dx = np.diff(points[:,0])
+    dy = np.diff(points[:,1])
+    ds = np.sqrt(dx**2 + dy**2)
+    theta = np.degrees(np.arctan2(dy,dx))
+    dtheta = np.diff(theta)
+    dtheta = dtheta - 360*np.floor((dtheta + 180)/360)
+    return points, normals, ds, theta, dtheta
+
 
 def smooth(
     points = [(20,0), (40,0), (80,40), (80,10), (100,10),],
@@ -312,16 +324,16 @@ def smooth(
     Path
         A Path object with the specified smoothed path.
     """
-    points = np.asfarray(points)
-    normals = np.diff(points, axis = 0)
-    normals = (normals.T/np.linalg.norm(normals, axis = 1)).T
-    # normals_rev = normals*np.array([1,-1])
-    dx = np.diff(points[:,0])
-    dy = np.diff(points[:,1])
-    ds = np.sqrt(dx**2 + dy**2)
-    theta = np.degrees(np.arctan2(dy,dx))
-    dtheta = np.diff(theta)
-    dtheta = dtheta - 360*np.floor((dtheta + 180)/360)
+
+    points, normals, ds, theta, dtheta = _compute_segments(points)
+    colinear_elements = np.concatenate([[False], np.abs(dtheta) < 1e-6, [False]])
+    if np.any(colinear_elements):
+        new_points = points[~colinear_elements,:]
+        points, normals, ds, theta, dtheta = _compute_segments(new_points)
+
+    if np.any(np.abs(np.abs(dtheta)-180) < 1e-6):
+        raise ValueError('[PHIDL] smooth() received points which double-back on themselves' +
+        '--turns cannot be computed when going forwards then exactly backwards.')
 
     # FIXME add caching
     # Create arcs
@@ -395,6 +407,11 @@ def transition(cross_section1, cross_section2, width_type = 'sine'):
     X1 = cross_section1
     X2 = cross_section2
     Xtrans = CrossSection()
+
+    if not X1.aliases or not X2.aliases:
+        raise ValueError("""[PHIDL] transition() found no named sections in one
+        or both inputs (cross_section1/cross_section2).""")
+
     for alias in X1.aliases.keys():
         if alias in X2.aliases:
 

phidl/phidl_tutorial_example.py

@@ -777,8 +777,8 @@ def complicated_waveguide(width = 10, height = 1, x = 10, y = 25, rotation = 15)
 D['circle3'].x += 15            # Moving the second circle over by 15
 # Note that at this point, D['circle2'] is equivalent to the variable c2
 # we made above
-qp(D['circle2'], label_aliases = True)
-qp(D, label_aliases = True)
+qp(D['circle2'])
+qp(D)
 
 # You can also access the list of aliases for your Device whenever you want
 # to by accessing Device.aliases, which is a Python dictionary.  For example: