sdynpy.core.sdynpy_data.multiple_coherence_array

multiple_coherence_array(abscissa, ordinate, coordinate, comment1='', comment2='', comment3='', comment4='', comment5='')[source]

Helper function to create a MultipleCoherenceArray object.

All input arguments to this function are allowed to broadcast to create the final data in the MultipleCoherenceArray object.

Parameters
  • abscissa (np.ndarray) – Numpy array specifying the abscissa of the function

  • ordinate (np.ndarray) – Numpy array specifying the ordinate of the function

  • coordinate (CoordinateArray) – Coordinate for each data in the data array

  • 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

obj – The constructed MultipleCoherenceArray object

Return type

MultipleCoherenceArray