doughnut

Contents

doughnut#

class brainpy.state.spatial.doughnut(inner_radius, outer_radius)[source]#

Doughnut (annulus) mask (2-D): inner_radius < d <= outer_radius.

The inner boundary is exclusive and the outer boundary inclusive (NEST’s outer-ball-minus-inner-ball DifferenceMask). inner_radius == outer_radius yields an empty mask; inner_radius == 0 matches circular() except at the exact center.

Parameters:

  • inner_radius (float or Quantity) – Inner and outer radii (length); bare floats are taken in micrometres.

  • outer_radius (float or Quantity) – Inner and outer radii (length); bare floats are taken in micrometres.

Returns:

A hard-cutoff annulus mask.

Return type:

_DoughnutMask

Examples

>>> from brainpy import state as bp
>>> mask = bp.spatial.doughnut(0.3, 0.7)
Contents