sdynpy.modal.sdynpy_modal_test.ModalTest

class ModalTest(geometry=None, time_histories=None, autopower_spectra=None, frfs=None, coherence=None, fit_modes=None, resynthesized_frfs=None, response_unit=None, reference_unit=None, rigid_body_shapes=None, channel_table=None)

Bases: object

__init__(geometry=None, time_histories=None, autopower_spectra=None, frfs=None, coherence=None, fit_modes=None, resynthesized_frfs=None, response_unit=None, reference_unit=None, rigid_body_shapes=None, channel_table=None)

Methods

__init__([geometry, time_histories, ...])
compute_resynthesized_frfs()
compute_spectral_quantities(...)
compute_spectral_quantities_SignalProcessingGUI()
create_documentation_latex([mif_plots, ...])
create_documentation_pptx()
create_documentation_word()
define_spectral_processing_parameters(...)
edit_mode_comments()
fit_modes_PolyPy()
fit_modes_SMAC()
plot_cmif([measured, resynthesized, ...])	Plots the complex mode indicator function
plot_coherence_image()
plot_deflection_shapes()
plot_drive_point_frf_coherence([...])
plot_drive_point_frfs([part, plot_kwargs, ...])
plot_figures_for_documentation([...])
plot_mac(*matrix_plot_args, **matrix_plot_kwargs)
plot_mmif([measured, resynthesized, ...])	Plots the multi mode indicator function
plot_modeshape()
plot_nmif([measured, resynthesized, ...])	Plots the normal mode indicator function
plot_psmif([measured, resynthesized, ...])	Plots the first singular value of the complex mode indicator function
plot_qmif([measured, resynthesized, ...])	Plots the complex mode indicator function computed from the imaginary part of the FRFs
plot_reciprocal_frfs([plot_kwargs, ...])
plot_reference_autospectra([plot_kwargs, ...])
retrieve_modes_PolyPy()
retrieve_modes_SMAC()
retrieve_spectral_quantities_SignalProcessingGUI()
set_autopower_spectra(autopower_spectra)
set_channel_table(channel_table)
set_coherence(coherence)
set_fit_modes(fit_modes)
set_frfs(frfs)
set_geometry(geometry)
set_resynthesized_frfs(resynthesized_frfs)
set_rigid_body_shapes(rigid_body_shapes)
set_time_histories(time_histories)
set_units(response_unit, reference_unit)

Attributes

response_indices

compute_resynthesized_frfs()

compute_spectral_quantities(reference_indices, start_time, end_time, num_samples_per_frame, overlap, window, frf_estimator)

compute_spectral_quantities_SignalProcessingGUI()

create_documentation_latex(mif_plots=['cmif'], latex_root='', figure_folder='figures', document_filename='include.tex', appendix_filename='appendix.tex', frequency_format='{:0.1f}', damping_format='{:0.2f}\\%', comment1_header='Description', comment2_header=None, comment3_header=None, comment4_header=None, comment5_header=None)

create_documentation_pptx()

create_documentation_word()

define_spectral_processing_parameters(reference_indices, num_samples_per_frame, num_averages, start_time, end_time, trigger, trigger_channel_index, trigger_slope, trigger_level, pretrigger, overlap, window, frf_estimator)

edit_mode_comments()

fit_modes_PolyPy()

fit_modes_SMAC()

plot_cmif(measured=True, resynthesized=False, mark_modes=False, measured_plot_kwargs={}, resynthesized_plot_kwargs={}, subplots_kwargs={})

Plots the complex mode indicator function

Parameters

• measured (bool, optional) – If True, plots the measured MIF. The default is True.

• resynthesized (bool, optional) – If True, plots resynthesized MIF. The default is False.

• mark_modes (bool, optional) – If True, plots a vertical line at the frequency of each mode. The default is False.

• measured_plot_kwargs (dict, optional) – Dictionary containing keyword arguments to specify how the measured data is plotted. The default is {}.

• resynthesized_plot_kwargs (dict, optional) – Dictionary containing keyword arguments to specify how the resynthesized data is plotted. The default is {}.

• subplots_kwargs (dict, optional) – Dictionary containing keyword arguments to specify how the figure and axes are created. This is passed to the plt.subplots function. The default is {}.

Raises

ValueError – Raised if a required data has not been computed or assigned yet.

Returns

• fig (matplotlib.figure.Figure) – A reference to the figure on which the plot is plotted.

• ax (matplotlib.axes.Axes) – A reference to the axes on which the plot is plotted.

plot_coherence_image()

plot_deflection_shapes()

plot_drive_point_frf_coherence(plot_kwargs={}, subplots_kwargs={})

plot_drive_point_frfs(part='imag', plot_kwargs={}, subplots_kwargs={})

plot_figures_for_documentation(plot_geometry=True, geometry_kwargs={}, plot_coordinate=True, coordinate_kwargs={}, plot_rigid_body_checks=True, rigid_body_checks_kwargs={}, plot_reference_autospectra=True, reference_autospectra_kwargs={}, plot_drive_point_frfs=True, drive_point_frfs_kwargs={}, plot_reciprocal_frfs=True, reciprocal_frfs_kwargs={}, plot_frf_coherence=True, frf_coherence_kwargs={}, plot_coherence_image=True, coherence_image_kwargs={}, plot_cmif=True, cmif_kwargs={}, plot_qmif=False, qmif_kwargs={}, plot_nmif=False, nmif_kwargs={}, plot_mmif=False, mmif_kwargs={}, plot_modeshapes=True, modeshape_kwargs={}, plot_mac=True, mac_kwargs={})

plot_mac(*matrix_plot_args, **matrix_plot_kwargs)

plot_mmif(measured=True, resynthesized=False, mark_modes=False, measured_plot_kwargs={}, resynthesized_plot_kwargs={}, subplots_kwargs={})

Plots the multi mode indicator function

Parameters

• measured (bool, optional) – If True, plots the measured MIF. The default is True.

• resynthesized (bool, optional) – If True, plots resynthesized MIF. The default is False.

• mark_modes (bool, optional) – If True, plots a vertical line at the frequency of each mode. The default is False.

• measured_plot_kwargs (dict, optional) – Dictionary containing keyword arguments to specify how the measured data is plotted. The default is {}.

• resynthesized_plot_kwargs (dict, optional) – Dictionary containing keyword arguments to specify how the resynthesized data is plotted. The default is {}.

• subplots_kwargs (dict, optional) – Dictionary containing keyword arguments to specify how the figure and axes are created. This is passed to the plt.subplots function. The default is {}.

Raises

ValueError – Raised if a required data has not been computed or assigned yet.

Returns

• fig (matplotlib.figure.Figure) – A reference to the figure on which the plot is plotted.

• ax (matplotlib.axes.Axes) – A reference to the axes on which the plot is plotted.

plot_modeshape()

plot_nmif(measured=True, resynthesized=False, mark_modes=False, measured_plot_kwargs={}, resynthesized_plot_kwargs={}, subplots_kwargs={})

Plots the normal mode indicator function

Parameters

• measured (bool, optional) – If True, plots the measured MIF. The default is True.

• resynthesized (bool, optional) – If True, plots resynthesized MIF. The default is False.

• mark_modes (bool, optional) – If True, plots a vertical line at the frequency of each mode. The default is False.

• measured_plot_kwargs (dict, optional) – Dictionary containing keyword arguments to specify how the measured data is plotted. The default is {}.

• resynthesized_plot_kwargs (dict, optional) – Dictionary containing keyword arguments to specify how the resynthesized data is plotted. The default is {}.

• subplots_kwargs (dict, optional) – Dictionary containing keyword arguments to specify how the figure and axes are created. This is passed to the plt.subplots function. The default is {}.

Raises

ValueError – Raised if a required data has not been computed or assigned yet.

Returns

• fig (matplotlib.figure.Figure) – A reference to the figure on which the plot is plotted.

• ax (matplotlib.axes.Axes) – A reference to the axes on which the plot is plotted.

plot_psmif(measured=True, resynthesized=False, mark_modes=False, measured_plot_kwargs={}, resynthesized_plot_kwargs={}, subplots_kwargs={})

Plots the first singular value of the complex mode indicator function

Parameters

• measured (bool, optional) – If True, plots the measured MIF. The default is True.

• resynthesized (bool, optional) – If True, plots resynthesized MIF. The default is False.

• mark_modes (bool, optional) – If True, plots a vertical line at the frequency of each mode. The default is False.

• measured_plot_kwargs (dict, optional) – Dictionary containing keyword arguments to specify how the measured data is plotted. The default is {}.

• resynthesized_plot_kwargs (dict, optional) – Dictionary containing keyword arguments to specify how the resynthesized data is plotted. The default is {}.

• subplots_kwargs (dict, optional) – Dictionary containing keyword arguments to specify how the figure and axes are created. This is passed to the plt.subplots function. The default is {}.

Raises

ValueError – Raised if a required data has not been computed or assigned yet.

Returns

• fig (matplotlib.figure.Figure) – A reference to the figure on which the plot is plotted.

• ax (matplotlib.axes.Axes) – A reference to the axes on which the plot is plotted.

plot_qmif(measured=True, resynthesized=False, mark_modes=False, measured_plot_kwargs={}, resynthesized_plot_kwargs={}, subplots_kwargs={})

Plots the complex mode indicator function computed from the imaginary part of the FRFs

Parameters

• measured (bool, optional) – If True, plots the measured MIF. The default is True.

• resynthesized (bool, optional) – If True, plots resynthesized MIF. The default is False.

• mark_modes (bool, optional) – If True, plots a vertical line at the frequency of each mode. The default is False.

• measured_plot_kwargs (dict, optional) – Dictionary containing keyword arguments to specify how the measured data is plotted. The default is {}.

• resynthesized_plot_kwargs (dict, optional) – Dictionary containing keyword arguments to specify how the resynthesized data is plotted. The default is {}.

• subplots_kwargs (dict, optional) – Dictionary containing keyword arguments to specify how the figure and axes are created. This is passed to the plt.subplots function. The default is {}.

Raises

ValueError – Raised if a required data has not been computed or assigned yet.

Returns

• fig (matplotlib.figure.Figure) – A reference to the figure on which the plot is plotted.

• ax (matplotlib.axes.Axes) – A reference to the axes on which the plot is plotted.

plot_reciprocal_frfs(plot_kwargs={}, subplots_kwargs={})

plot_reference_autospectra(plot_kwargs={}, subplots_kwargs={})

property response_indices

retrieve_modes_PolyPy()

retrieve_modes_SMAC()

retrieve_spectral_quantities_SignalProcessingGUI()

set_autopower_spectra(autopower_spectra)

set_channel_table(channel_table)

set_coherence(coherence)

set_fit_modes(fit_modes)

set_frfs(frfs)

set_geometry(geometry)

set_resynthesized_frfs(resynthesized_frfs)

set_rigid_body_shapes(rigid_body_shapes)

set_time_histories(time_histories)

set_units(response_unit, reference_unit)