DispersionCurve

DispersionCurve class definition.

class DispersionCurve(frequency, velocity)

Bases: swprepost.curve.Curve

Class to define a DispersionCurve object.

Variables:velocity (frequency,) – 1D array of the dispersion curve’s frequency and velocity values, respectively.

__init__(frequency, velocity)

Initialize a DispersionCurve object from dispersion data.

Parameters:frequency, velocity (iterable) – Vector of the dispersion curve’s frequency and velocity values, respectively. Returns:DispersionCurve – Initialized DispersionCurve object.

frequency

classmethod from_geopsy(fname)

Create from text file following the Geopsy format.

Parameters:fname (str) – Name of file to be read, may be a relative or the full path. Returns:DispersionCurve – Instantiated DispersionCurve object.

slowness

txt_repr

Text representation following the Geopsy format.

velocity

wavelength

write_curve(fileobj)

Append DispersionCurve to open file object.

Parameters:fname (str) – Name of file, may be a relative or the full path. Returns:None – Writes file to disk.

write_to_txt(fname, wavetype='rayleigh', mode=0, identifier=0, misfit=0.0)

Write DispersionCurve to Geopsy formated file.

Parameters:

• fname (str) – Name of file, may be a relative or the full path.
• wavetype ({“rayleigh”, “love”}, optional) – Surface wave dispersion wavetype, default is “rayleigh”.
• mode (int, optional) – Mode integer (numbered from zero), default is 0.
• identifier (int, optional) – Model identifier, default is 0.
• misfit (float, optional) – Dispersion misfit of profile, default is 0.0000.

Returns:

None – Write text representation to disk.