plot_real_vs_sampled

behavenet.plotting.arhmm_utils.plot_real_vs_sampled(latents, latents_samp, states, states_samp, save_file=None, xtick_locs=None, frame_rate=None, format='png')[source]

Plot real and sampled latents overlaying real and (potentially sampled) states.

Parameters:

  • latents (np.ndarray) – shape (n_frames, n_latents)

  • latents_samp (np.ndarray) – shape (n_frames, n_latents)

  • states (np.ndarray) – shape (n_frames,)

  • states_samp (np.ndarray) – shape (n_frames,) if latents_samp are not conditioned on states, otherwise shape (0,)

  • save_file (str) – full save file (path and filename)

  • xtick_locs (array-like, optional) – tick locations in bin values for plot

  • frame_rate (float, optional) – behavioral video framerate; to properly relabel xticks

  • format (str, optional) – any accepted matplotlib save format, e.g. ‘png’ | ‘pdf’ | ‘jpeg’

Returns:

matplotlib figure handle

Return type:

matplotlib.figure.Figure