tomodrgn.analysis.ipy_tomo_ptcl_viewer#

ipy_tomo_ptcl_viewer(path_to_tomograms: str, tomo_star_mapping: dict[str, str], tomo_id_column: str, df_particles: DataFrame) Box[source]#

An interactive tomogram and particle viewer using plotly and ipywidgets. Allows correlation of tomogram image data with particle locations with particle metadata attributes expressed in df_particles.

Parameters:
  • path_to_tomograms – path to directory containing tomogram volumes

  • tomo_star_mapping – dictionary mapping tomogram filenames to the corresponding string identifying each tomogram in the volumeseries star file tomo_id_column column

  • tomo_id_column – name of the column within the volumeseries star file that contains unique values for each tomogram

  • df_particles – pandas dataframe containing particle information to plot and colormap particles. Minimum required columns are [coordinate X, Y, and Z, tomo_id_column, ‘_UnfilteredParticleInds’]

Returns:

ipywidgets.Box containing the interactive tomogram and particle viewer widget