treeple.experimental.simulate.simulate_sphere#

treeple.experimental.simulate.simulate_sphere(radius=1, noise_func=None, alpha=0.005, n_samples=1000, return_mi_lb=False, random_seed=None)[source]#

Simulate samples generated on a sphere.

Parameters:
radiusint, optional

The radius of the sphere, by default 1.

noise_funccallable(), optional

The noise function to call to add to samples, by default None, which defaults to sampling from the uniform distribution [-alpha, alpha].

alphafloat, optional

The value of the noise, by default 0.005.

n_samplesint, optional

Number of samples to generate, by default 1000.

return_mi_lbbool, optional

Whether to return the mutual information lower bound, by default False.

random_seedint, optional

Random seed, by default None.

Returns:
latitudefloat

Latitude.

longitudefloat

Longitude.

Y1array_like of shape (n_samples,)

The X coordinate.

Y2array_like of shape (n_samples,)

The Y coordinate.

Y3array_like of shape (n_samples,)

The Z coordinate.

lbfloat

The mutual information lower bound.