Plotting Functions

The plotting module can be used to plot the dives from the output netCDF files. plot_from_nc() will plot a single dive separated into its pahses and cluster_summary_plot() will five the minimum, maximum, and average depth at time (seconds) into the dive for each cluster.

divebomb.plotting.cluster_summary_plot(folder, ipython_display=True, filename='index.html', title='Dive Cluster Summary', scale={'depth': False, 'time': False})
Parameters:
  • folder – the path to the results folder contianing the cluster folders
  • ipython_display – a boolean indicating whether or not to show the dive in a notebook
  • filename – the filename to save the dive to if it is not shown in a notebook
  • title – the displaye title of the plot
Returns:

a plotly graph summary of all of the dive clusters
divebomb.plotting.plot_deepdive_from_nc(folder, cluster, dive_id, ipython_display=True, filename='index.html', at_depth_threshold=0.15)
Parameters:
  • folder – the path to the results folder contianing the cluster folders
  • cluster – the number of the cluster of the dive
  • dive_id – the number of of the dive
  • ipython_display – a boolean indicating whether or not to show the dive in a notebook
  • filename – the filename to save the dive to if it is not shown in a notebook
  • at_depth_threshold – a value from 0 - 1 indicating distance from the bottom of the dive at which the animal is considered to be at depth
Returns:

a plotly line chart of the dive
divebomb.plotting.plot_dive_from_nc(folder, cluster, dive_id, ipython_display=True, filename='index.html', at_depth_threshold=0.15, title='Clusters')
Parameters:
  • folder – the path to the results folder contianing the cluster folders
  • cluster – the number of the cluster of the dive
  • dive_id – the number of of the dive
  • ipython_display – a boolean indicating whether or not to show the dive in a notebook
  • filename – the filename to save the dive to if it is not shown in a notebook
  • at_depth_threshold – a value from 0 - 1 indicating distance from the bottom of the dive at which the animal is considered to be at depth
  • title – string title of plot
Returns:

a plotly line chart of the dive
divebomb.plotting.plot_from_nc(folder, cluster, dive_id, ipython_display=True, type='dive', filename='index.html', at_depth_threshold=0.15)
Parameters:
  • folder – the path to the results folder contianing the cluster folders
  • cluster – the number of the cluster of the dive
  • dive_id – the number of of the dive
  • type – a string of either either dive or deepdive
  • ipython_display – a boolean indicating whether or not to show the dive in a notebook
  • filename – the filename to save the dive to if it is not shown in a notebook
  • at_depth_threshold – a value from 0 - 1 indicating distance from the bottom of the dive at which the animal is considered to be at depth
Returns:

a plotly line chart of the dive