StarQubit.add_qgeometry

StarQubit.add_qgeometry(kind: str, geometry: dict, subtract: bool = False, helper: bool = False, layer: int | str | None = None, chip: str | None = None, **kwargs)

Add QGeometry.

Takes any additional options in options.

Parameters:
  • kind (str) – The kind of QGeometry, such as ‘path’, ‘poly’, etc. All geometry in the dictionary should have the same kind, such as Polygon or LineString.

  • geometry (Dict[BaseGeometry]) – Key-value pairs of name of the geometry you want to add and the value should be a shapely geometry object, such as a Polygon or a LineString.

  • subtract (bool) – Subtract from the layer. Defaults to False.

  • helper (bool) – Is this a helper object. If true, subtract must be false Defaults to False.

  • layer (int, str) – The layer to which the set of QGeometry will belong Defaults to None, which is converted to self.options.chip.

  • chip (str) – Chip name. Defaults to None, which is converted to

  • self.options.chip.

  • kwargs (dict) – Parameters dictionary

Assumptions:
  • Assumes all geometry in the geometry argument are homogeneous in kind; i.e., all lines or polys etc.