masw

Masw class definition.

class Masw

Bases: object

Customizable Multichannel Analysis of Surface Waves workflow.

Convenient customer-facing interface for implementing different and extensible MASW processing workflows.

static create_settings_dict(workflow='time-domain', trim=False, trim_begin=0.0, trim_end=1.0, mute=False, method='interactive', window_kwargs=None, pad=False, df=1.0, transform='fdbf', fmin=5, fmax=100, vmin=100, vmax=1000, nvel=200, vspace='linear', weighting='sqrt', steering='cylindrical', snr=False, noise_begin=-0.5, noise_end=0.0, signal_begin=0.0, signal_end=0.5, pad_snr=True, df_snr=1.0, min_offset=0, max_offset=inf)

Create settings dict using function arguments.

See Masw.create_settings_file() for details.

static run(fnames, settings, map_x=<function Masw.<lambda>>, map_y=<function Masw.<lambda>>)

Run an MASW workflow from SU or SEGY files.

Create an instance of an Masw object for a specific Masw workflow. Note that each file should contain multiple traces where each trace corresponds to a single receiver. The header information for these files must be correct and readable. Currently supported file types are SEGY and SU.

Parameters:

  • fnames (str or iterable of str) – File name or iterable of file names.

  • settings_fname (str) – JSON settings file detailing how MASW should be performed. See meth: Masw.create_settings_file() for more information.

  • map_x, map_y (function, optional) – Functions to convert the x and y coordinates of source and receiver information, default is no transformation. Useful for converting between coordinate systems.

Returns:

AbstractTransform-like – Initialized subclass (i.e., child) of AbstractTransform.

Raises:

TypeError – If fnames is not of type str or iterable.

class MaswXcorr

Bases: Masw

static run(fnames_rec, fnames_src, src_channel, settings, map_x=<function MaswXcorr.<lambda>>, map_y=<function MaswXcorr.<lambda>>)

Run an MASW workflow from SU or SEGY files.

Create an instance of an Masw object for a specific Masw workflow. Note that each file should contain multiple traces where each trace corresponds to a single receiver. The header information for these files must be correct and readable. Currently supported file types are SEGY and SU.

Parameters:

  • fnames (str or iterable of str) – File name or iterable of file names.

  • settings_fname (str) – JSON settings file detailing how MASW should be performed. See meth: Masw.create_settings_file() for more information.

  • map_x, map_y (function, optional) – Functions to convert the x and y coordinates of source and receiver information, default is no transformation. Useful for converting between coordinate systems.

Returns:

AbstractTransform-like – Initialized subclass (i.e., child) of AbstractTransform.

Raises:

TypeError – If fnames is not of type str or iterable.