filter_objects_to_included_regions

filter_objects_to_included_regions(domain, object_IDs, included_region_IDs, boundary_exclude_distance=0)

Helper function to filter objects returned by a query down to those inside (or on the boundary of) a set of include_regions, specified by a set of shape IDs

Parameters:

domaindomain

A muspan domain

object_IDsarray like

A list of object IDs

included_regions_IDsarray like

A list of shape IDs

boundary_exclude_distancefloat, optional

Optionally exclude objects which are within distance boundary_exclude_distance of a shape boundary. Defaults to None.

Returns

——-

object_IDsndarray

The object IDs that match the query.