Skip to content

Commit

Permalink
Add some comments (#371)
Browse files Browse the repository at this point in the history
  • Loading branch information
@paddyroddy
paddyroddy authored May 22, 2024
1 parent 85e7709 commit f940f16
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions documentation/DOCUMENTATION.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ for ell in range(2, 0, -1):
f.L,
Method="MWSS",
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand Down Expand Up @@ -122,6 +123,7 @@ f_sphere = ssht.inverse(
f.L,
Method="MWSS",
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand Down Expand Up @@ -163,6 +165,7 @@ for ell in range(2, 0, -1):
f.L,
Method="MWSS",
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand Down Expand Up @@ -208,6 +211,7 @@ f_sphere = ssht.inverse(
f.L,
Method="MWSS",
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand All @@ -228,6 +232,7 @@ g_sphere = sleplet.slepian_methods.slepian_inverse(
g.L,
g.slepian,
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
g_sphere,
g.L,
Expand Down Expand Up @@ -261,6 +266,7 @@ for p in [0, 9, 24, 49, 99, 199]:
f.L,
f.slepian,
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand Down Expand Up @@ -305,6 +311,7 @@ for j in [None, *list(range(5))]:
f.L,
f.slepian,
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand Down Expand Up @@ -346,6 +353,7 @@ for j in [None, *list(range(5))]:
f.L,
f.slepian,
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand Down Expand Up @@ -389,6 +397,7 @@ f_sphere = sleplet.slepian_methods.slepian_inverse(
amplitude = sleplet.plot_methods.compute_amplitude_for_noisy_sphere_plots(
f,
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand Down Expand Up @@ -427,6 +436,7 @@ f_sphere = ssht.inverse(
f.L,
Method="MWSS",
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(f_sphere, f.L, "fig_9_a", normalise=False).execute()
# b
region = sleplet.slepian.Region(
Expand All @@ -442,6 +452,7 @@ g_sphere = sleplet.slepian_methods.slepian_inverse(
g.L,
g.slepian,
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
g_sphere,
g.L,
Expand Down Expand Up @@ -483,6 +494,7 @@ for p in [0, 9, 24, 49, 99, 199]:
f.L,
f.slepian,
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand Down Expand Up @@ -521,6 +533,7 @@ for j in [None, *list(range(6))]:
f.L,
f.slepian,
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand Down Expand Up @@ -560,6 +573,7 @@ for j in [None, *list(range(6))]:
f.L,
f.slepian,
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand Down Expand Up @@ -602,6 +616,7 @@ f_sphere = sleplet.slepian_methods.slepian_inverse(
amplitude = sleplet.plot_methods.compute_amplitude_for_noisy_sphere_plots(
f,
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand Down Expand Up @@ -637,6 +652,7 @@ for r in range(2, 10):
f.mesh,
f.coefficients,
)
# creates surface plot on a mesh
sleplet.plotting.PlotMesh(
mesh,
f"fig_2_r_{r}",
Expand Down Expand Up @@ -678,6 +694,7 @@ for p in [0, 9, 24, 49, 99, 199]:
f.mesh_slepian,
f.coefficients,
)
# creates surface plot on a mesh
sleplet.plotting.PlotMesh(
mesh,
f"fig_6_p_{p}",
Expand Down Expand Up @@ -719,6 +736,7 @@ for j in [None, *list(range(5))]:
f.mesh_slepian,
f.coefficients,
)
# creates surface plot on a mesh
sleplet.plotting.PlotMesh(
mesh,
f"fig_8_j_{j}",
Expand Down Expand Up @@ -747,6 +765,7 @@ f_mesh = sleplet.harmonic_methods.mesh_inverse(
f.mesh,
f.coefficients,
)
# creates surface plot on a mesh
sleplet.plotting.PlotMesh(
mesh,
"fig_9",
Expand Down Expand Up @@ -781,6 +800,7 @@ for j in [None, *list(range(5))]:
f.mesh_slepian,
f.coefficients,
)
# creates surface plot on a mesh
sleplet.plotting.PlotMesh(
mesh,
f"fig_10_j_{j}",
Expand Down Expand Up @@ -816,6 +836,7 @@ f_mesh = sleplet.slepian_methods.slepian_mesh_inverse(
f.mesh_slepian,
f.coefficients,
)
# creates surface plot on a mesh
sleplet.plotting.PlotMesh(
mesh,
"fig_11_a",
Expand All @@ -835,6 +856,7 @@ g_mesh = sleplet.slepian_methods.slepian_mesh_inverse(
amplitude = sleplet.plot_methods.compute_amplitude_for_noisy_mesh_plots(
g,
)
# creates surface plot on a mesh
sleplet.plotting.PlotMesh(
mesh,
"fig_11_b",
Expand Down Expand Up @@ -891,6 +913,7 @@ for ell in range(5):
f.L,
Method="MWSS",
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand Down Expand Up @@ -929,6 +952,7 @@ f_sphere = ssht.inverse(
f.L,
Method="MWSS",
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand All @@ -951,6 +975,7 @@ for a, b, g in [
f.L,
Method="MWSS",
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
g_sphere,
f.L,
Expand Down Expand Up @@ -998,6 +1023,7 @@ for j in [None, *list(range(4))]:
f.L,
Method="MWSS",
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand Down Expand Up @@ -1049,6 +1075,7 @@ f_sphere = ssht.inverse(
f.L,
Method="MWSS",
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand All @@ -1065,6 +1092,7 @@ g_sphere = ssht.inverse(
f.L,
Method="MWSS",
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
g_sphere,
f.L,
Expand Down Expand Up @@ -1096,6 +1124,7 @@ f_sphere = ssht.inverse(
f.L,
Method="MWSS",
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand All @@ -1112,6 +1141,7 @@ g_sphere = ssht.inverse(
f.L,
Method="MWSS",
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
g_sphere,
f.L,
Expand Down Expand Up @@ -1143,6 +1173,7 @@ f_sphere = ssht.inverse(
f.L,
Method="MWSS",
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand All @@ -1159,6 +1190,7 @@ g_sphere = ssht.inverse(
f.L,
Method="MWSS",
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
g_sphere,
f.L,
Expand Down Expand Up @@ -1194,6 +1226,7 @@ for ell in range(2, 0, -1):
f.L,
Method="MWSS",
)
# creates surface plot on the sphere
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
Expand Down

0 comments on commit f940f16

Please sign in to comment.