aspsim.room.generatepoints.equiangular_circle

aspsim.room.generatepoints.equiangular_circle(num_points, radius, start_angle=0, z=None, rng=None)

Generates equiangularly spaced points on a circle

Parameters:

• num_points (int) – number of points on the circle

• radius (int or 2-tuple) – radius of the circle if a tuple is suppled, as (inner_radius, outer_radius) each point will be placed randomly (uniform distribution) between the inner and outer radius

• start_angle (float) – the angle in radians of the first point

• z (None or float) – if z is supplied, the all points are given the same z-coordinate according to the value of the argument

• rng (None or numpy Generator object) – can be supplied to control the seed of the random number generator

Returns:

coordinates – if argument z was supplied

Return type:

ndarray of shape (num_points, 2) or (num_points, 3)