muspan.helpers.

combine_include_and_exclude_boundaries

combine_include_and_exclude_boundaries(domain, include_boundaries=None, exclude_boundaries=None)

Convert include_boundaries and exclude_boundaries queries into a single set of shapes, add these to the domain, and return the new object IDs. New shapes, including those created as part of the process of combining shapes, are added to the collection __temporary_boundary_shapes.

Parameters:

domainobject

The spatial domain containing the populations.

include_boundariesquery-like, or None, optional

External boundaries for the new shapes. If None, the domain boundary is used. Defaults to None.

exclude_boundariesquery-like, or None, optional

External boundaries for the new shapes. If None, no internal boundaries are added (internal boundaries of shapes in include_boundaries will remain). Defaults to None.

Returns:

boundary_shape_IDsndarray

IDs of the newly created shapes which correspond to this combination of include and exclude boundaries