elliptical

Contents

elliptical#

class brainpy.state.spatial.elliptical(major_axis, minor_axis, azimuth_angle=0.0, anchor=None)[source]#

Elliptical mask (2-D): displacement inside a rotated ellipse (NEST elliptical).

Parameters:

  • major_axis (float or Quantity) – Full lengths of the two principal axes (not semi-axes). major_axis == minor_axis degenerates to circular() of radius major_axis / 2.

  • minor_axis (float or Quantity) – Full lengths of the two principal axes (not semi-axes). major_axis == minor_axis degenerates to circular() of radius major_axis / 2.

  • azimuth_angle (float, optional) – Rotation of the ellipse about its anchor, in degrees. Default 0.

  • anchor (sequence of float or Quantity, optional) – Offset of the ellipse centre from the source node (on the displacement). Default origin.

Returns:

A hard-cutoff elliptical mask.

Return type:

_EllipseMask

Examples

>>> from brainpy import state as bp
>>> mask = bp.spatial.elliptical(4.0, 2.0, azimuth_angle=45.0)
Contents