sdynpy.core.sdynpy_data.decayed_sine_table

• Module: sdynpy.core.sdynpy_data

• Source: GitHub

Signature¶

def sdynpy.core.sdynpy_data.decayed_sine_table(frequency, amplitude, decay, delay, coordinate, comment1='', comment2='', comment3='', comment4='', comment5='')

Helper function to create a DecayedSineTable object.

Parameters¶

• frequency : np.ndarray Frequencies of the decaying sine waves

• amplitude : np.ndarray Amplitudes of the decaying sine waves.

• decay : np.ndarray Damping values of the decaying sine waves.

• delay : np.ndarray Delay values of the decaying sine waves.

• coordinate : np.ndarray Coordinate information for each of the decaying sine waves. Must match the coordinate shape of a TimeHistoryArray, which means it must have shape (...,1)

• comment1 : np.ndarray, optional Comment used to describe the data in the data array. The default is ‘’.

• comment2 : np.ndarray, optional Comment used to describe the data in the data array. The default is ‘’.

• comment3 : np.ndarray, optional Comment used to describe the data in the data array. The default is ‘’.

• comment4 : np.ndarray, optional Comment used to describe the data in the data array. The default is ‘’.

• comment5 : np.ndarray, optional Comment used to describe the data in the data array. The default is ‘’.

Returns¶

• SineTable A SineTable object containing the specified information