HvsrDiffuseField

Subclass of HvsrCurve.

class HvsrDiffuseField(frequency, amplitude, meta=None)
__init__(frequency, amplitude, meta=None)

Create HvsrCurve from iterables of frequency and amplitude.

Parameters:

  • frequency (ndarray) – Vector of frequencies, one per amplitude.

  • amplitude (ndarray) – Vector of HVSR amplitudes, one per frequency.

  • meta (dict, optional) – Meta information about the object, default is None.

Returns:

HvsrCurve – Initialized with amplitude and frequency.

is_similar(other, atol=1e-09, rtol=0.0)

Check if other is similar to self.

mean_curve(distribution=None)

Mean HVSR curve according to diffuse field theory.

Parameters:

distribution (None, optional) – Not used only kept for symmetry with other HVSR objects.

Returns:

ndarray – Mean HVSR curve according to diffuse field theory.

mean_curve_peak(distribution=None, search_range_in_hz=(None, None), find_peaks_kwargs=None)

Frequency and amplitude of the peak of the mean HVSR curve.

Parameters:

  • distribution (None, optional) – Not used only kept for symmetry with other HVSR objects.

  • search_range_in_hz (tuple, optional) – Frequency range to be searched for peaks. Half open ranges can be specified with None, default is (None, None) indicating the full frequency range will be searched.

  • find_peaks_kwargs (dict) – Keyword arguments for the scipy function find_peaks see scipy documentation for details, default is None indicating defaults will be used.

Returns:

tuple – Frequency and amplitude associated with the peak of the mean HVSR curve of the form (mean_curve_peak_frequency, mean_curve_peak_amplitude).

update_peaks_bounded(search_range_in_hz=(None, None), find_peaks_kwargs=None)

Update peak associated with HVSR curve, can be over bounded range.

Parameters:

  • search_range_in_hz (tuple, optional) – Frequency range to be searched for peaks. Half open ranges can be specified with None, default is (None, None) indicating the full frequency range will be searched.

  • find_peaks_kwargs (dict) – Keyword arguments for the scipy function find_peaks see scipy documentation for details.

Returns:

None – Updates internal peak-related attributes.