helix: Toroidal Helix Data Set

In jlmelville/snedata: SNE Simulation Dataset Functions

Toroidal Helix Data Set

Description

Simulation data in the shape of a 3D toroidal helix.

Usage

helix(n = 1000, rmajor = 2, rminor = 1, nwinds = 8)

Arguments

n	Number of points to create.
rmajor	Major radius.
rminor	Minor radius.
nwinds	Number of winds the helix makes.

Details

Creates a series of points sampled from a 3D helix with the ends joined to each other.

Unlike ball and sphere, this data set is not randomly sampled.

Points are colored based on their distances from the origin.

Value

Data frame with x, y, z columns containing the coordinates of the points and color the RGB color.

References

A dataset like this was used in: Lee, J. A., Peluffo-Ordo'nez, D. H., & Verleysen, M. (2015). Multi-scale similarities in stochastic neighbour embedding: Reducing dimensionality while preserving both local and global structure. Neurocomputing, 169, 246-261.

Examples

## Not run: 
helix1000 <- helix(n = 1000)
# Coloring should be obvious with a 2D plot of the cross section:
plot(helix1000$x, helix1000$y, col = helix1000$color, pch = 20)

## End(Not run)

jlmelville/snedata documentation built on March 5, 2025, 12:22 p.m.