tadasets.torus

tadasets.torus(n: int = 100, c: float = 2.0, a: float = 1.0, noise: float | None = None, ambient: int | None = None, seed: int | None = None) → ndarray[source]

Sample n data points on a torus.

Parameters:

  • n (int, default=100) – Number of data points in shape.

  • c (float, default=2.0) – Distance from center to center of tube.

  • a (float, default=1.0) – Radius of tube.

  • noise (float, optional) – Standard deviation of normally distributed noise added to data.

  • ambient (int, optional) – Embed the torus into a space with ambient dimension equal to ambient. The torus is randomly rotated in this high dimensional space.

  • seed (int, optional) – Seed for random state.

Returns:

data (np.ndarray) – An (n,3) np.ndarray.