current_spiral: Get the current spiral object

In jokergoo/spiralize: Visualize Data on Spirals

Get the current spiral object

Description

Get the current spiral object

Usage

current_spiral()

Details

The returned value is an object of spiral reference class. The following methods might be useful (assume the object is named s):

• s$curve(): It returns the radius for given angles (in radians).

• s$spiral_length(): It returns the length of the spiral (from the origin) for a given angle (in radians), thus if you want to get the length of a spiral segment, it will be s$spiral_length(theta2) - s$spiral_length(theta1).

Also there are the following meta-data for the current spiral:

• s$xlim: Data range.

• s$xrange: s$xlim[2] - s$xlim[1].

• s$theta_lim: The corresponding range of theta.

• s$theta_range: s$theta_lim[2] - s$theta_lim[1].

• s$spiral_length_lim: The corresponding range of spiral length.

• s$spiral_length_range: s$spiral_length_lim[2] - s$spiral_length_lim[1].

• s$max_radius: Radius at s$theta_lim[2].

Value

A spiral object.

Examples

spiral_initialize()
s = current_spiral()
s$curve(2*pi*2)
s$spiral_length(2*pi*2)

jokergoo/spiralize documentation built on June 16, 2024, 4:35 a.m.