tapsap.plot package
Submodules
tapsap.plot.plot_tap module
- tapsap.plot.plot_tap.plot_tap(x: ndarray, y: ndarray, y_names: Optional[list] = None, save_path: Optional[str] = None, x_lab: str = 'Time (s)', y_lab: str = 'Flux (V)', font_size: float = 30, legend: bool = False, min_max_x_tick: Optional[list] = None, min_max_y_tick: Optional[list] = None) list
This function leverages plotly for plotting flux information. Note that in some cases, the amount of information to plot may be large and will increase the time to plot. The values for x and y may be either an 1d numpy array or a DataFrame. If there is a mismatch of shapes between the data, then the smallest array will be repeated to match the larger.
- Args:
x (ndarray | DataFrame): This can be either a 1d numpy array or a DataFrame. If 1d, then the values will be repeated by the max shape of information.
y (ndarray | DataFrame): This can be either a 1d numpy array or a DataFrame. If 1d, then the values will be repeated by the max shape of information.
y_names (str list): A list of specific column names to plot in the data frame.
save_path (str): A string path, e.g., plots/flux_results.png, where an image can be saved.
x_lab (str): The value of the x label axis.
y_lab (str): The value of the y label axis.
z_lab (str): The value of the z label axis.
font_size (int): The font size of the plot.
legend (bool): A boolean indicator to plot the legend or not.
min_max_x_tick (list): A start, stop and length of the x ticks.
min_max_y_tick (list): A start, stop and length of the x ticks.
- Returns:
fig (plotly.express): The plotly figure if the save_path is not none. Can be shown using fig.show().
- Citation:
None
- Implementor:
Ross Kunz
- Link:
None