Geometry overlay

[mfiaudrin-epsyl]

This feature aims to display geometries in overlay of other plots.

There are the changes:

• Add contour visualization and includes UX changes to select the type of visualization
• Overlay geometries in contour plots
• Allow to swap x & y axis with geometries

[read-the-docs-community]

Documentation build overview

📚 imas-ibex | 🛠️ Build #33475905 | 📁 Comparing 4a8e9a9 against latest (d786f12)

  🔍 Preview build  

133 files changed · + 83 added · ± 50 modified

+ Added

• developers_manual/backend_development/adding_new_data_manipulation_method.html
• developers_manual/backend_development/data_manipulation.html
• developers_manual/backend_development/generated/ibex.core.data_manipulation_methods.InterpolationMethod.html
• developers_manual/backend_development/generated/ibex.core.data_manipulation_methods.SmoothingMethod.html
• developers_manual/backend_development/generated/ibex.core.data_manipulation_methods.html
• developers_manual/backend_development/generated/ibex.core.ibex_service.array_summary.html
• developers_manual/backend_development/generated/ibex.core.ibex_service.data_entry_exists.html
• developers_manual/backend_development/generated/ibex.core.ibex_service.find_paths.html
• developers_manual/backend_development/generated/ibex.core.ibex_service.get_data.html
• developers_manual/backend_development/generated/ibex.core.ibex_service.get_geometry_overlay_nodes.html
• and 73 more...

± Modified

• genindex.html
• index.html
• py-modindex.html
• users_manual/features.html
• users_manual/how_to_launch.html
• developers_manual/backend_development/adding_new_data_source.html
• developers_manual/backend_development/adding_new_downsampling_method.html
• developers_manual/backend_development/api-hidden.html
• developers_manual/backend_development/api.html
• developers_manual/backend_development/backend_development.html
• and 40 more...

[mfiaudrin-epsyl]

Hello @olivhoenen,

In order to finalize the geometry overlay feature, I need @jwasikpsnc works to use his new endpoint. So that I could mark the PR as ready for reviews.

Can you please merge the PR #79 if you approve it ?

[mfiaudrin-epsyl]

Hello @olivhoenen,

I have finalized the geometry overlay feature. As agreed during our meeting on June 12, I have grouped the selection of geometries of type 'geometry/' together for ux reasons.

The PR is ready to be merged since we are currently using PSNC endpoints.

[olivhoenen]

Currently the geometry overlay feature exposes structures that are dynamic, e.g. equilibrium/time_slice/boundary*/outline:

While one can argue that it may be of interest to plot the boundary/outline for this equilibrium, this is not the intended feature target and becomes misleading while the outline being overlayed is the one at the first time point while the rest of the psi data evolves in time:

I guess that generalizing the load of geometries to take into account time-dependent geometries will be an overkill at that stage, but would it be possible to make sure that the exposed geometries concern only static data? @imbeauf do you foresee an issue with such restriction?
(I am guessing this would be more for the backend and may not change at all the frontend, @jwasikpsnc please confirm)

[imbeauf]

Indeed, if the dynamic quantities are not plotted at the same time, this is problematic. If they cannot be synchronized or interpolated easily, I agree with @olivhoenen that it is better to restrict the geometry display to static/constant data only.

[jwasikpsnc]

So, as far i understand the issue: backend should not return dynamic goemetries in the geometry_overlay endpoint.
How can i identify this type of geometries? Check for time in coordinates? Check for AoS in node path?

[olivhoenen]

How can i identify this type of geometries? Check for time in coordinates? Check for AoS in node path?

If you check fields (e.g. outline.r and outline.z), you can use metadata.type (see https://imas-python.readthedocs.io/en/stable/generated/imas.ids_metadata.IDSMetadata.html#imas.ids_metadata.IDSMetadata.type).

There is also metadata._is_dynamic which is defined at the node/structure level (e.g. outline), but this is not directly in the API of IMAS-Python.

Maybe @maarten-ic knows a better way?

[maarten-ic]

Maybe @maarten-ic knows a better way?

I suppose the easiest is to exclude the dynamic outlines when searching for geometry nodes?

IBEX/backend/ibex/data_source/imas_python_source.py

Line 199 in fcf3bb9

is_outline_rz = "outline" in metadata.name and node_type in {"rz1d_static", "rz1d_dynamic_aos"}

The rz1d_dynamic_aos are inside a dynamic Array of Structures. rz1d_static is an outline that doesn't change over time.