jan/masque
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Clarify docs -- read returns a dict

Browse Source
This commit is contained in:
Jan Petykiewicz 2018-09-16 20:18:04 -07:00
parent f3aa27a7c4
commit 7eda7ea873
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
masque/file/gdsii.py
View File

@ -255,9 +255,9 @@ def read_dtype2dose(filename: str) -> (List[Pattern], Dict[str, Any]):
def read(filename: str, def read(filename: str,
use_dtype_as_dose: bool = False, use_dtype_as_dose: bool = False,
clean_vertices: bool = True, clean_vertices: bool = True,
) -> (List[Pattern], Dict[str, Any]): ) -> (Dict[str, Pattern], Dict[str, Any]):
""" """
Read a gdsii file and translate it into a list of Pattern objects. GDSII structures are Read a gdsii file and translate it into a dict of Pattern objects. GDSII structures are
translated into Pattern objects; boundaries are translated into polygons, and srefs and arefs translated into Pattern objects; boundaries are translated into polygons, and srefs and arefs
are translated into SubPattern objects. are translated into SubPattern objects.
@ -268,7 +268,7 @@ def read(filename: str,
:param clean_vertices: If true, remove any redundant vertices when loading polygons. :param clean_vertices: If true, remove any redundant vertices when loading polygons.
The cleaning process removes any polygons with zero area or <3 vertices. The cleaning process removes any polygons with zero area or <3 vertices.
Default True. Default True.
:return: Tuple: (List of Patterns generated GDSII structures, Dict of GDSII library info) :return: Tuple: (Dict of pattern_name:Patterns generated from GDSII structures, Dict of GDSII library info)
""" """
with open(filename, mode='rb') as stream: with open(filename, mode='rb') as stream: