Predefined geometries

stride.utils.geometries.elliptical(num, radius, centre)[source]

Generate a 2D elliptical geometry for a number of points num, centred on centre and with radius radius.

Parameters:
  • num (int) – Number of points on the geometry.

  • radius (array-like) – List or array with each of the two radii of the ellipsis.

  • centre (array-like) – List or array with the coordinates of the centre of the ellipsis.

Returns:

Array containing the coordinates of points in the geometry, with shape (num, 2).

Return type:

2d-array

stride.utils.geometries.ellipsoidal(num, radius, centre, theta=0.0, axis=None, threshold=0.0, angle_range=3.141592653589793)[source]

Generate a 3D ellipsoidal geometry for a number of points num, centred on centre and with radius radius. The geometry can be rotated by an amount theta, and thresholded by eliminating threshold percent of it.

Parameters:
  • num (int) – Number of points on the geometry.

  • radius (array-like) – List or array with each of the two radii of the ellipsis.

  • centre (array-like) – List or array with the coordinates of the centre of the ellipsis.

  • theta

  • axis

  • threshold

  • angle_range

Returns:

Array containing the coordinates of points in the geometry, with shape (num, 3).

Return type:

3d-array