Skip to main content
The visualization helpers render interactive Plotly figures for both metadata and converted data, and can auto-route data to the right plot based on its detected type.
Every function returns a Plotly Figure, so you can .show() it, embed it, or .write_html(...) it.

Metadata visualization

Data visualization

Convert a file first, then plot the resulting xarray.Dataset. Dedicated visualizers ship for AFM, the three PFM variants, and XRD.

AFM and PFM

visualize_afm_data() accepts plot_type ("combined", "surface", "heatmap", or "line"), a colormap, and optional zmin/zmax color limits. The PFM helpers follow the same pattern for single-frequency, vector, and DART piezoresponse data.

XRD

Auto-routing by data type

visualize_data() inspects a dataset’s detected data type and dispatches to the matching visualizer, so you don’t have to pick the plot yourself:
It raises VisualizationNotFoundError when the detected type has no registered plot (or none can be detected). See which data types have a registered visualizer with list_available_visualizations():
To support a new type, register a visualizer with register_visualization(name, func) — see Add a format.