ross.visualize_matrix

ross.visualize_matrix(rotor, matrix, frequency=None, **kwargs)

Visualize global matrix.

This function gives some visualization of a given matrix, displaying values on a heatmap.

Parameters:

rotor: rs.Rotor

The rotor object.

matrix: str

String for the desired matrix.

frequency: float, optional

Excitation frequency. Defaults to rotor speed.

kwargsoptional

Additional key word arguments can be passed to change the plot layout only (e.g. coloraixs=dict(colorscale=”Rainbow”), width=1000, height=800, …). *See Plotly Python Figure Reference for more information.

Returns:

figPlotly graph_objects.Figure()

The figure object with the plot.

Examples

>>> import ross as rs
>>> rotor = rs.rotor_example()

Visualizing Mass Matrix: >>> fig = rs.visualize_matrix(rotor, “M”, frequency=100)

Visualizing Stiffness Matrix: >>> fig = rs.visualize_matrix(rotor, “K”, frequency=100)

Visualizing Gyroscopic Matrix: >>> fig = rs.visualize_matrix(rotor, “G”)