API reference

This section gives an overview of all public waveresponse objects, functions and methods.

BasePMSpectrum(freq[, freq_hz])	Base class for handling 1-D Pierson-Moskowtiz (PM) type spectra of the form:
BaseSpectrum1d(freq[, freq_hz])	Base class for handling and generating 1-D wave spectra.
calculate_response(rao, wave, heading[, ...])	Calculate response spectrum.
complex_to_polar(complex_vals[, phase_degrees])	Convert complex numbers to polar form (i.e., amplitude and phase).
CosineFullSpreading([s, degrees])	Cosine-2s type spreading (full directional range).
CosineHalfSpreading([s, degrees])	Cosine-2s type spreading (half directional range).
DirectionalBinSpectrum(freq, dirs, vals[, ...])	Directional binned spectrum.
DirectionalSpectrum(freq, dirs, vals[, ...])	Directional spectrum.
Grid(freq, dirs, vals[, freq_hz, degrees, ...])	Two-dimentional frequency/(wave)direction grid.
JONSWAP(freq[, freq_hz])	JONSWAP spectrum, given as:
ModifiedPiersonMoskowitz(freq[, freq_hz])	Modified Pierson-Moskowitz (i.e., Bretschneider) spectrum, given by:
OchiHubble(freq[, freq_hz])	Ochi-Hubble wave spectrum, given as:
Torsethaugen(freq[, freq_hz])	Torsethaugen spectrum, given as:
multiply(grid1, grid2[, output_type])	Multiply values (element-wise).
polar_to_complex(amp, phase[, phase_degrees])	Convert polar coordinates (i.e., amplitude and phase) to complex numbers.
RAO(freq, dirs, vals[, freq_hz, degrees, ...])	Response amplitude operator (RAO).
mirror(rao, dof[, sym_plane])	Mirrors/folds an RAO object about a symmetry plane.
rigid_transform(t, surge, sway, heave, roll, ...)	Rigid body transformation of (surge, sway and heave) RAOs.
rigid_transform_heave(t, heave, roll, pitch)	Rigid body transformation of heave RAO.
rigid_transform_surge(t, surge, pitch, yaw)	Rigid body transformation of surge RAO.
rigid_transform_sway(t, sway, roll, yaw)	Rigid body transformation of sway RAO.
WaveBinSpectrum(*args, **kwargs)	Binned wave spectrum.
WaveSpectrum(*args, **kwargs)	Wave spectrum.