sdf_xarray.plotting.get_frame_title

sdf_xarray.plotting.get_frame_title#

sdf_xarray.plotting.get_frame_title(data, frame, display_sdf_name=False, title_custom=None, t='time')[source]#

Generate the title for a frame

Parameters:

  • data (DataArray) – DataArray containing the target data

  • frame (int) – Frame number

  • display_sdf_name (bool) – Display the sdf file name in the animation title

  • title_custom (str | None) – Custom title to add to the plot

  • t (str) – Time coordinate

Return type:

str

Contents