query_layout_obj_instances

LayoutInstance.query_layout_obj_instances(layer_filter=None, net_filter=None, spatial_filter=None)

Query layout object instances using the provided filters.

Parameters:

layer_filterLayerLike or list of LayerLike, default: None

Layers to query. The default is None, in which case all layers are queried.

net_filterNetLike or list of NetLike, default: None

Nets to query. The default is None, in which case all nets are queried.

spatial_filterPolygonData or PointData or None or list of PolygonData or PointData, default: None

Area of the design to query. The default is None, in which case the entire spatial domain of the design is queried.

Returns:

LayoutInstanceQueryResult or list of LayoutInstanceQueryResult

If a single query is provided, one LayoutInstanceQueryResult is returned. If a list of spatial queries is provided, then a list of LayoutInstanceQueryResult is returned where each entry maps to the spatial query at the same index.