hookeai.miscellaneous.noisy_data.denoise_disp_noise_csv.plot_disp_component_paths

plot_disp_component_paths(disp_paths, disp_paths_labels=None, disp_comp_label='Displacement', filename='displacement_component_paths', save_dir=None, is_save_fig=False, is_stdout_display=False, is_latex=False)[source]

Plot displacement component paths.

Parameters:

  • disp_paths (list) – One or more displacement component paths, each stored as numpy.ndarray(1d) of shape (n_time,).

  • disp_paths_labels (list[str], default=None) – Label of each displacement component path.

  • disp_comp_label (str, default='Displacement') – Displacement component label.

  • filename (str, default='displacement_component_paths') – Figure name.

  • save_dir (str, default=None) – Directory where figure is saved. If None, then figure is saved in current working directory.

  • is_save_fig (bool, default=False) – Save figure.

  • is_stdout_display (bool, default=False) – True if displaying figure to standard output device, False otherwise.

  • is_latex (bool, default=False) – If True, then render all strings in LaTeX. If LaTex is not available, then this option is silently set to False and all input strings are processed to remove $(…)$ enclosure.