Processing Settings

class HvsrTraditionalProcessingSettings(hvsrpy_version='2.2.0rc1', window_type_and_width=['tukey', 0.1], smoothing={'bandwidth': 40, 'center_frequencies_in_hz': array([0.1, 0.10317219, 0.10644501, 0.10982166, 0.11330541, 0.11689968, 0.12060796, 0.12443388, 0.12838116, 0.13245366, 0.13665535, 0.14099032, 0.14546281, 0.15007717, 0.15483791, 0.15974966, 0.16481723, 0.17004555, 0.17543973, 0.18100501, 0.18674684, 0.19267081, 0.1987827, 0.20508848, 0.21159428, 0.21830646, 0.22523156, 0.23237634, 0.23974777, 0.24735303, 0.25519955, 0.26329497, 0.2716472, 0.28026437, 0.2891549, 0.29832745, 0.30779097, 0.3175547, 0.32762815, 0.33802115, 0.34874383, 0.35980666, 0.37122042, 0.38299625, 0.39514563, 0.40768042, 0.42061283, 0.43395548, 0.44772139, 0.46192397, 0.4765771, 0.49169504, 0.50729256, 0.52338486, 0.53998764, 0.55711709, 0.57478992, 0.59302337, 0.61183522, 0.63124382, 0.65126809, 0.67192757, 0.69324242, 0.71523341, 0.73792199, 0.7613303, 0.78548117, 0.81039816, 0.83610555, 0.86262844, 0.88999268, 0.91822497, 0.94735284, 0.9774047, 1.00840987, 1.04039858, 1.07340203, 1.10745242, 1.14258295, 1.17882789, 1.21622259, 1.25480353, 1.29460832, 1.3356758, 1.37804602, 1.4217603, 1.46686129, 1.51339296, 1.56140071, 1.61093136, 1.66203322, 1.71475613, 1.76915151, 1.82527242, 1.88317359, 1.94291149, 2.0045444, 2.06813243, 2.13373758, 2.20142387, 2.27125729, 2.34330596, 2.41764016, 2.49433238, 2.57345742, 2.65509247, 2.73931713, 2.82621357, 2.91586653, 3.00836345, 3.10379456, 3.20225292, 3.30383458, 3.4086386, 3.5167672, 3.62832586, 3.74342337, 3.862172, 3.98468756, 4.11108955, 4.24150126, 4.37604988, 4.51486665, 4.65808695, 4.80585047, 4.95830134, 5.11558824, 5.27786459, 5.44528866, 5.61802375, 5.79623832, 5.98010621, 6.16980674, 6.36552494, 6.5674517, 6.77578396, 6.99072493, 7.21248424, 7.44127819, 7.67732992, 7.92086967, 8.17213497, 8.43137089, 8.69883028, 8.97477399, 9.25947118, 9.5531995, 9.85624546, 10.16890463, 10.49148194, 10.82429203, 11.1676595, 11.52191926, 11.88741681, 12.26450866, 12.65356258, 13.05495805, 13.46908657, 13.89635203, 14.33717119, 14.79197398, 15.26120399, 15.74531889, 16.24479085, 16.76010702, 17.29177002, 17.8402984, 18.40622716, 18.99010827, 19.59251122, 20.21402356, 20.85525147, 21.51682037, 22.19937551, 22.90358262, 23.63012855, 24.37972191, 25.15309383, 25.9509986, 26.77421445, 27.6235443, 28.49981653, 29.40388582, 30.33663392, 31.29897061, 32.29183447, 33.31619389, 34.37304798, 35.46342752, 36.58839601, 37.74905067, 38.94652355, 40.18198257, 41.45663275, 42.7717173, 44.12851887, 45.5283608, 46.97260844, 48.46267039, 50.]), 'operator': 'konno_and_ohmachi'}, fft_settings=None, handle_dissimilar_time_steps_by='frequency_domain_resampling', processing_method='traditional', method_to_combine_horizontals='geometric_mean')
__init__(hvsrpy_version='2.2.0rc1', window_type_and_width=['tukey', 0.1], smoothing={'bandwidth': 40, 'center_frequencies_in_hz': array([0.1, 0.10317219, 0.10644501, 0.10982166, 0.11330541, 0.11689968, 0.12060796, 0.12443388, 0.12838116, 0.13245366, 0.13665535, 0.14099032, 0.14546281, 0.15007717, 0.15483791, 0.15974966, 0.16481723, 0.17004555, 0.17543973, 0.18100501, 0.18674684, 0.19267081, 0.1987827, 0.20508848, 0.21159428, 0.21830646, 0.22523156, 0.23237634, 0.23974777, 0.24735303, 0.25519955, 0.26329497, 0.2716472, 0.28026437, 0.2891549, 0.29832745, 0.30779097, 0.3175547, 0.32762815, 0.33802115, 0.34874383, 0.35980666, 0.37122042, 0.38299625, 0.39514563, 0.40768042, 0.42061283, 0.43395548, 0.44772139, 0.46192397, 0.4765771, 0.49169504, 0.50729256, 0.52338486, 0.53998764, 0.55711709, 0.57478992, 0.59302337, 0.61183522, 0.63124382, 0.65126809, 0.67192757, 0.69324242, 0.71523341, 0.73792199, 0.7613303, 0.78548117, 0.81039816, 0.83610555, 0.86262844, 0.88999268, 0.91822497, 0.94735284, 0.9774047, 1.00840987, 1.04039858, 1.07340203, 1.10745242, 1.14258295, 1.17882789, 1.21622259, 1.25480353, 1.29460832, 1.3356758, 1.37804602, 1.4217603, 1.46686129, 1.51339296, 1.56140071, 1.61093136, 1.66203322, 1.71475613, 1.76915151, 1.82527242, 1.88317359, 1.94291149, 2.0045444, 2.06813243, 2.13373758, 2.20142387, 2.27125729, 2.34330596, 2.41764016, 2.49433238, 2.57345742, 2.65509247, 2.73931713, 2.82621357, 2.91586653, 3.00836345, 3.10379456, 3.20225292, 3.30383458, 3.4086386, 3.5167672, 3.62832586, 3.74342337, 3.862172, 3.98468756, 4.11108955, 4.24150126, 4.37604988, 4.51486665, 4.65808695, 4.80585047, 4.95830134, 5.11558824, 5.27786459, 5.44528866, 5.61802375, 5.79623832, 5.98010621, 6.16980674, 6.36552494, 6.5674517, 6.77578396, 6.99072493, 7.21248424, 7.44127819, 7.67732992, 7.92086967, 8.17213497, 8.43137089, 8.69883028, 8.97477399, 9.25947118, 9.5531995, 9.85624546, 10.16890463, 10.49148194, 10.82429203, 11.1676595, 11.52191926, 11.88741681, 12.26450866, 12.65356258, 13.05495805, 13.46908657, 13.89635203, 14.33717119, 14.79197398, 15.26120399, 15.74531889, 16.24479085, 16.76010702, 17.29177002, 17.8402984, 18.40622716, 18.99010827, 19.59251122, 20.21402356, 20.85525147, 21.51682037, 22.19937551, 22.90358262, 23.63012855, 24.37972191, 25.15309383, 25.9509986, 26.77421445, 27.6235443, 28.49981653, 29.40388582, 30.33663392, 31.29897061, 32.29183447, 33.31619389, 34.37304798, 35.46342752, 36.58839601, 37.74905067, 38.94652355, 40.18198257, 41.45663275, 42.7717173, 44.12851887, 45.5283608, 46.97260844, 48.46267039, 50.]), 'operator': 'konno_and_ohmachi'}, fft_settings=None, handle_dissimilar_time_steps_by='frequency_domain_resampling', processing_method='traditional', method_to_combine_horizontals='geometric_mean')

Initialize HvsrTraditionalProcessingSettings object.

Parameters:

  • hvsrpy_version (str) – Denotes the version of hvsrpy used to create the Settings object. Should not be changed.

  • window_type_and_width (list, optional) – A list with entries like ["tukey", 0.1] that control the window type and width, respectively.

  • smoothing (dict, optional) – Smoothing information like dict(operator="konno_and_ohmachi", bandwidth=40, center_frequencies_in_hz=np.geomspace(0.1, 50, 200)).

  • fft_settings (dict or None, optional) – Custom settings for np.fft.rfft default is None.

  • handle_dissimilar_time_steps_by ({“frequency_domain_resampling”, “keeping_smallest_time_step”, “keeping_majority_time_step”}, optional) – Method to resolve multiple records with a different time step, default is "frequency_domain_resampling".

  • processing_method (str, optional) – Defines processing_method for later reference, default is 'traditional'. Should not be changed.

  • method_to_combine_horizontals (str, optional) – Defines method for combining the two horizontal components options include: “arithmetic_mean”, “squared_average”, “quadratic_mean”, “geometric_mean”, “total_horizontal_energy”, “vector_summation”, and “maximum_horizontal_value”, default is “geometric_mean”.

Returns:

HvsrTraditionalProcessingSettings – Object contains all user-defined settings to control HVSR processing of microtremor or earthquake recordings.

property attr_dict

Dictionary of Settings object’s attributes.

load(fname)

Load Settings object from file on disk.

Parameters:

fname (str) – Name of file from which the Settings object information will be loaded. Can be a relative or the full path.

Returns:

None – Updates Settings object from information stored in a file on disk.

psummary()

Pretty summary of information in Settings object.

save(fname)

Save Settings object to file on disk.

Parameters:

fname (str) – Name of file to which the Settings object will be saved. Can be a relative or the full path.

Returns:

None – Instead saves Settings object information to file on disk.

class HvsrTraditionalSingleAzimuthProcessingSettings(hvsrpy_version='2.2.0rc1', window_type_and_width=['tukey', 0.1], smoothing={'bandwidth': 40, 'center_frequencies_in_hz': array([0.1, 0.10317219, 0.10644501, 0.10982166, 0.11330541, 0.11689968, 0.12060796, 0.12443388, 0.12838116, 0.13245366, 0.13665535, 0.14099032, 0.14546281, 0.15007717, 0.15483791, 0.15974966, 0.16481723, 0.17004555, 0.17543973, 0.18100501, 0.18674684, 0.19267081, 0.1987827, 0.20508848, 0.21159428, 0.21830646, 0.22523156, 0.23237634, 0.23974777, 0.24735303, 0.25519955, 0.26329497, 0.2716472, 0.28026437, 0.2891549, 0.29832745, 0.30779097, 0.3175547, 0.32762815, 0.33802115, 0.34874383, 0.35980666, 0.37122042, 0.38299625, 0.39514563, 0.40768042, 0.42061283, 0.43395548, 0.44772139, 0.46192397, 0.4765771, 0.49169504, 0.50729256, 0.52338486, 0.53998764, 0.55711709, 0.57478992, 0.59302337, 0.61183522, 0.63124382, 0.65126809, 0.67192757, 0.69324242, 0.71523341, 0.73792199, 0.7613303, 0.78548117, 0.81039816, 0.83610555, 0.86262844, 0.88999268, 0.91822497, 0.94735284, 0.9774047, 1.00840987, 1.04039858, 1.07340203, 1.10745242, 1.14258295, 1.17882789, 1.21622259, 1.25480353, 1.29460832, 1.3356758, 1.37804602, 1.4217603, 1.46686129, 1.51339296, 1.56140071, 1.61093136, 1.66203322, 1.71475613, 1.76915151, 1.82527242, 1.88317359, 1.94291149, 2.0045444, 2.06813243, 2.13373758, 2.20142387, 2.27125729, 2.34330596, 2.41764016, 2.49433238, 2.57345742, 2.65509247, 2.73931713, 2.82621357, 2.91586653, 3.00836345, 3.10379456, 3.20225292, 3.30383458, 3.4086386, 3.5167672, 3.62832586, 3.74342337, 3.862172, 3.98468756, 4.11108955, 4.24150126, 4.37604988, 4.51486665, 4.65808695, 4.80585047, 4.95830134, 5.11558824, 5.27786459, 5.44528866, 5.61802375, 5.79623832, 5.98010621, 6.16980674, 6.36552494, 6.5674517, 6.77578396, 6.99072493, 7.21248424, 7.44127819, 7.67732992, 7.92086967, 8.17213497, 8.43137089, 8.69883028, 8.97477399, 9.25947118, 9.5531995, 9.85624546, 10.16890463, 10.49148194, 10.82429203, 11.1676595, 11.52191926, 11.88741681, 12.26450866, 12.65356258, 13.05495805, 13.46908657, 13.89635203, 14.33717119, 14.79197398, 15.26120399, 15.74531889, 16.24479085, 16.76010702, 17.29177002, 17.8402984, 18.40622716, 18.99010827, 19.59251122, 20.21402356, 20.85525147, 21.51682037, 22.19937551, 22.90358262, 23.63012855, 24.37972191, 25.15309383, 25.9509986, 26.77421445, 27.6235443, 28.49981653, 29.40388582, 30.33663392, 31.29897061, 32.29183447, 33.31619389, 34.37304798, 35.46342752, 36.58839601, 37.74905067, 38.94652355, 40.18198257, 41.45663275, 42.7717173, 44.12851887, 45.5283608, 46.97260844, 48.46267039, 50.]), 'operator': 'konno_and_ohmachi'}, handle_dissimilar_time_steps_by='frequency_domain_resampling', fft_settings=None, processing_method='traditional', method_to_combine_horizontals='single_azimuth', azimuth_in_degrees=20.0)
__init__(hvsrpy_version='2.2.0rc1', window_type_and_width=['tukey', 0.1], smoothing={'bandwidth': 40, 'center_frequencies_in_hz': array([0.1, 0.10317219, 0.10644501, 0.10982166, 0.11330541, 0.11689968, 0.12060796, 0.12443388, 0.12838116, 0.13245366, 0.13665535, 0.14099032, 0.14546281, 0.15007717, 0.15483791, 0.15974966, 0.16481723, 0.17004555, 0.17543973, 0.18100501, 0.18674684, 0.19267081, 0.1987827, 0.20508848, 0.21159428, 0.21830646, 0.22523156, 0.23237634, 0.23974777, 0.24735303, 0.25519955, 0.26329497, 0.2716472, 0.28026437, 0.2891549, 0.29832745, 0.30779097, 0.3175547, 0.32762815, 0.33802115, 0.34874383, 0.35980666, 0.37122042, 0.38299625, 0.39514563, 0.40768042, 0.42061283, 0.43395548, 0.44772139, 0.46192397, 0.4765771, 0.49169504, 0.50729256, 0.52338486, 0.53998764, 0.55711709, 0.57478992, 0.59302337, 0.61183522, 0.63124382, 0.65126809, 0.67192757, 0.69324242, 0.71523341, 0.73792199, 0.7613303, 0.78548117, 0.81039816, 0.83610555, 0.86262844, 0.88999268, 0.91822497, 0.94735284, 0.9774047, 1.00840987, 1.04039858, 1.07340203, 1.10745242, 1.14258295, 1.17882789, 1.21622259, 1.25480353, 1.29460832, 1.3356758, 1.37804602, 1.4217603, 1.46686129, 1.51339296, 1.56140071, 1.61093136, 1.66203322, 1.71475613, 1.76915151, 1.82527242, 1.88317359, 1.94291149, 2.0045444, 2.06813243, 2.13373758, 2.20142387, 2.27125729, 2.34330596, 2.41764016, 2.49433238, 2.57345742, 2.65509247, 2.73931713, 2.82621357, 2.91586653, 3.00836345, 3.10379456, 3.20225292, 3.30383458, 3.4086386, 3.5167672, 3.62832586, 3.74342337, 3.862172, 3.98468756, 4.11108955, 4.24150126, 4.37604988, 4.51486665, 4.65808695, 4.80585047, 4.95830134, 5.11558824, 5.27786459, 5.44528866, 5.61802375, 5.79623832, 5.98010621, 6.16980674, 6.36552494, 6.5674517, 6.77578396, 6.99072493, 7.21248424, 7.44127819, 7.67732992, 7.92086967, 8.17213497, 8.43137089, 8.69883028, 8.97477399, 9.25947118, 9.5531995, 9.85624546, 10.16890463, 10.49148194, 10.82429203, 11.1676595, 11.52191926, 11.88741681, 12.26450866, 12.65356258, 13.05495805, 13.46908657, 13.89635203, 14.33717119, 14.79197398, 15.26120399, 15.74531889, 16.24479085, 16.76010702, 17.29177002, 17.8402984, 18.40622716, 18.99010827, 19.59251122, 20.21402356, 20.85525147, 21.51682037, 22.19937551, 22.90358262, 23.63012855, 24.37972191, 25.15309383, 25.9509986, 26.77421445, 27.6235443, 28.49981653, 29.40388582, 30.33663392, 31.29897061, 32.29183447, 33.31619389, 34.37304798, 35.46342752, 36.58839601, 37.74905067, 38.94652355, 40.18198257, 41.45663275, 42.7717173, 44.12851887, 45.5283608, 46.97260844, 48.46267039, 50.]), 'operator': 'konno_and_ohmachi'}, handle_dissimilar_time_steps_by='frequency_domain_resampling', fft_settings=None, processing_method='traditional', method_to_combine_horizontals='single_azimuth', azimuth_in_degrees=20.0)

Initialize HvsrTraditionalSingleAzimuthProcessingSettings object.

Parameters:

  • hvsrpy_version (str) – Denotes the version of hvsrpy used to create the Settings object. Should not be changed.

  • window_type_and_width (list, optional) – A list with entries like ["tukey", 0.1] that control the window type and width, respectively.

  • smoothing (dict, optional) – Smoothing information like dict(operator="konno_and_ohmachi", bandwidth=40, center_frequencies_in_hz=np.geomspace(0.1, 50, 200)).

  • fft_settings (dict or None, optional) – Custom settings for np.fft.rfft default is None.

  • handle_dissimilar_time_steps_by ({“frequency_domain_resampling”, “keeping_smallest_time_step”, “keeping_majority_time_step”}, optional) – Method to resolve multiple records with a different time step, default is "frequency_domain_resampling".

  • processing_method (str, optional) – Defines processing_method for later reference, default is 'traditional'. Should not be changed.

  • method_to_combine_horizontals (str, optional) – Defines method for combining the two horizontal components “single_azimuth”. Do not change.

  • azimuth_in_degrees (float, optional) – Azimuth at which to compute the single azimuth HVSR, measured from north in degrees (clockwise positive). Default is 20 degrees (i.e., 20 degrees to the east from north).

Returns:

HvsrTraditionalSingleAzimuthProcessingSettings – Object contains all user-defined settings to control HVSR processing of microtremor or earthquake recordings.

property attr_dict

Dictionary of Settings object’s attributes.

load(fname)

Load Settings object from file on disk.

Parameters:

fname (str) – Name of file from which the Settings object information will be loaded. Can be a relative or the full path.

Returns:

None – Updates Settings object from information stored in a file on disk.

psummary()

Pretty summary of information in Settings object.

save(fname)

Save Settings object to file on disk.

Parameters:

fname (str) – Name of file to which the Settings object will be saved. Can be a relative or the full path.

Returns:

None – Instead saves Settings object information to file on disk.

class HvsrTraditionalRotDppProcessingSettings(hvsrpy_version='2.2.0rc1', window_type_and_width=['tukey', 0.1], smoothing={'bandwidth': 40, 'center_frequencies_in_hz': array([0.1, 0.10317219, 0.10644501, 0.10982166, 0.11330541, 0.11689968, 0.12060796, 0.12443388, 0.12838116, 0.13245366, 0.13665535, 0.14099032, 0.14546281, 0.15007717, 0.15483791, 0.15974966, 0.16481723, 0.17004555, 0.17543973, 0.18100501, 0.18674684, 0.19267081, 0.1987827, 0.20508848, 0.21159428, 0.21830646, 0.22523156, 0.23237634, 0.23974777, 0.24735303, 0.25519955, 0.26329497, 0.2716472, 0.28026437, 0.2891549, 0.29832745, 0.30779097, 0.3175547, 0.32762815, 0.33802115, 0.34874383, 0.35980666, 0.37122042, 0.38299625, 0.39514563, 0.40768042, 0.42061283, 0.43395548, 0.44772139, 0.46192397, 0.4765771, 0.49169504, 0.50729256, 0.52338486, 0.53998764, 0.55711709, 0.57478992, 0.59302337, 0.61183522, 0.63124382, 0.65126809, 0.67192757, 0.69324242, 0.71523341, 0.73792199, 0.7613303, 0.78548117, 0.81039816, 0.83610555, 0.86262844, 0.88999268, 0.91822497, 0.94735284, 0.9774047, 1.00840987, 1.04039858, 1.07340203, 1.10745242, 1.14258295, 1.17882789, 1.21622259, 1.25480353, 1.29460832, 1.3356758, 1.37804602, 1.4217603, 1.46686129, 1.51339296, 1.56140071, 1.61093136, 1.66203322, 1.71475613, 1.76915151, 1.82527242, 1.88317359, 1.94291149, 2.0045444, 2.06813243, 2.13373758, 2.20142387, 2.27125729, 2.34330596, 2.41764016, 2.49433238, 2.57345742, 2.65509247, 2.73931713, 2.82621357, 2.91586653, 3.00836345, 3.10379456, 3.20225292, 3.30383458, 3.4086386, 3.5167672, 3.62832586, 3.74342337, 3.862172, 3.98468756, 4.11108955, 4.24150126, 4.37604988, 4.51486665, 4.65808695, 4.80585047, 4.95830134, 5.11558824, 5.27786459, 5.44528866, 5.61802375, 5.79623832, 5.98010621, 6.16980674, 6.36552494, 6.5674517, 6.77578396, 6.99072493, 7.21248424, 7.44127819, 7.67732992, 7.92086967, 8.17213497, 8.43137089, 8.69883028, 8.97477399, 9.25947118, 9.5531995, 9.85624546, 10.16890463, 10.49148194, 10.82429203, 11.1676595, 11.52191926, 11.88741681, 12.26450866, 12.65356258, 13.05495805, 13.46908657, 13.89635203, 14.33717119, 14.79197398, 15.26120399, 15.74531889, 16.24479085, 16.76010702, 17.29177002, 17.8402984, 18.40622716, 18.99010827, 19.59251122, 20.21402356, 20.85525147, 21.51682037, 22.19937551, 22.90358262, 23.63012855, 24.37972191, 25.15309383, 25.9509986, 26.77421445, 27.6235443, 28.49981653, 29.40388582, 30.33663392, 31.29897061, 32.29183447, 33.31619389, 34.37304798, 35.46342752, 36.58839601, 37.74905067, 38.94652355, 40.18198257, 41.45663275, 42.7717173, 44.12851887, 45.5283608, 46.97260844, 48.46267039, 50.]), 'operator': 'konno_and_ohmachi'}, fft_settings=None, handle_dissimilar_time_steps_by='frequency_domain_resampling', processing_method='traditional', method_to_combine_horizontals='rotdpp', ppth_percentile_for_rotdpp_computation=50.0, azimuths_in_degrees=array([0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65, 70, 75, 80, 85, 90, 95, 100, 105, 110, 115, 120, 125, 130, 135, 140, 145, 150, 155, 160, 165, 170, 175]))
__init__(hvsrpy_version='2.2.0rc1', window_type_and_width=['tukey', 0.1], smoothing={'bandwidth': 40, 'center_frequencies_in_hz': array([0.1, 0.10317219, 0.10644501, 0.10982166, 0.11330541, 0.11689968, 0.12060796, 0.12443388, 0.12838116, 0.13245366, 0.13665535, 0.14099032, 0.14546281, 0.15007717, 0.15483791, 0.15974966, 0.16481723, 0.17004555, 0.17543973, 0.18100501, 0.18674684, 0.19267081, 0.1987827, 0.20508848, 0.21159428, 0.21830646, 0.22523156, 0.23237634, 0.23974777, 0.24735303, 0.25519955, 0.26329497, 0.2716472, 0.28026437, 0.2891549, 0.29832745, 0.30779097, 0.3175547, 0.32762815, 0.33802115, 0.34874383, 0.35980666, 0.37122042, 0.38299625, 0.39514563, 0.40768042, 0.42061283, 0.43395548, 0.44772139, 0.46192397, 0.4765771, 0.49169504, 0.50729256, 0.52338486, 0.53998764, 0.55711709, 0.57478992, 0.59302337, 0.61183522, 0.63124382, 0.65126809, 0.67192757, 0.69324242, 0.71523341, 0.73792199, 0.7613303, 0.78548117, 0.81039816, 0.83610555, 0.86262844, 0.88999268, 0.91822497, 0.94735284, 0.9774047, 1.00840987, 1.04039858, 1.07340203, 1.10745242, 1.14258295, 1.17882789, 1.21622259, 1.25480353, 1.29460832, 1.3356758, 1.37804602, 1.4217603, 1.46686129, 1.51339296, 1.56140071, 1.61093136, 1.66203322, 1.71475613, 1.76915151, 1.82527242, 1.88317359, 1.94291149, 2.0045444, 2.06813243, 2.13373758, 2.20142387, 2.27125729, 2.34330596, 2.41764016, 2.49433238, 2.57345742, 2.65509247, 2.73931713, 2.82621357, 2.91586653, 3.00836345, 3.10379456, 3.20225292, 3.30383458, 3.4086386, 3.5167672, 3.62832586, 3.74342337, 3.862172, 3.98468756, 4.11108955, 4.24150126, 4.37604988, 4.51486665, 4.65808695, 4.80585047, 4.95830134, 5.11558824, 5.27786459, 5.44528866, 5.61802375, 5.79623832, 5.98010621, 6.16980674, 6.36552494, 6.5674517, 6.77578396, 6.99072493, 7.21248424, 7.44127819, 7.67732992, 7.92086967, 8.17213497, 8.43137089, 8.69883028, 8.97477399, 9.25947118, 9.5531995, 9.85624546, 10.16890463, 10.49148194, 10.82429203, 11.1676595, 11.52191926, 11.88741681, 12.26450866, 12.65356258, 13.05495805, 13.46908657, 13.89635203, 14.33717119, 14.79197398, 15.26120399, 15.74531889, 16.24479085, 16.76010702, 17.29177002, 17.8402984, 18.40622716, 18.99010827, 19.59251122, 20.21402356, 20.85525147, 21.51682037, 22.19937551, 22.90358262, 23.63012855, 24.37972191, 25.15309383, 25.9509986, 26.77421445, 27.6235443, 28.49981653, 29.40388582, 30.33663392, 31.29897061, 32.29183447, 33.31619389, 34.37304798, 35.46342752, 36.58839601, 37.74905067, 38.94652355, 40.18198257, 41.45663275, 42.7717173, 44.12851887, 45.5283608, 46.97260844, 48.46267039, 50.]), 'operator': 'konno_and_ohmachi'}, fft_settings=None, handle_dissimilar_time_steps_by='frequency_domain_resampling', processing_method='traditional', method_to_combine_horizontals='rotdpp', ppth_percentile_for_rotdpp_computation=50.0, azimuths_in_degrees=array([0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65, 70, 75, 80, 85, 90, 95, 100, 105, 110, 115, 120, 125, 130, 135, 140, 145, 150, 155, 160, 165, 170, 175]))

Initialize HvsrTraditionalRotDppProcessingSettings object.

Parameters:

  • hvsrpy_version (str) – Denotes the version of hvsrpy used to create the Settings object. Should not be changed.

  • window_type_and_width (list, optional) – A list with entries like ["tukey", 0.1] that control the window type and width, respectively.

  • smoothing (dict, optional) – Smoothing information like dict(operator="konno_and_ohmachi", bandwidth=40, center_frequencies_in_hz=np.geomspace(0.1, 50, 200)).

  • fft_settings (dict or None, optional) – Custom settings for np.fft.rfft default is None.

  • handle_dissimilar_time_steps_by ({“frequency_domain_resampling”, “keeping_smallest_time_step”, “keeping_majority_time_step”}, optional) – Method to resolve multiple records with a different time step, default is "frequency_domain_resampling".

  • processing_method (str, optional) – Defines processing_method for later reference, default is 'traditional'. Should not be changed.

  • method_to_combine_horizontals (str, optional) – Defines method for combining the two horizontal components “rotdpp”. Do not change.

  • ppth_percentile_for_rotdpp_computation (float, optional) – The frequency-by-frequency percentile to be selected from the HVSR curves computed, default is 50. which is consistent with RotD50 from ground motion processing.

  • azimuths_in_degrees (iterable of float, optional) – Azimuths measured from north in degrees (clockwise positive) at which to compute single azimuth HVSRs, to then select the frequency-by-frequency ppth precentile.

Returns:

HvsrTraditionalRotDppProcessingSettings – Object contains all user-defined settings to control HVSR processing of microtremor or earthquake recordings.

property attr_dict

Dictionary of Settings object’s attributes.

load(fname)

Load Settings object from file on disk.

Parameters:

fname (str) – Name of file from which the Settings object information will be loaded. Can be a relative or the full path.

Returns:

None – Updates Settings object from information stored in a file on disk.

psummary()

Pretty summary of information in Settings object.

save(fname)

Save Settings object to file on disk.

Parameters:

fname (str) – Name of file to which the Settings object will be saved. Can be a relative or the full path.

Returns:

None – Instead saves Settings object information to file on disk.

class HvsrAzimuthalProcessingSettings(hvsrpy_version='2.2.0rc1', window_type_and_width=['tukey', 0.1], smoothing={'bandwidth': 40, 'center_frequencies_in_hz': array([0.1, 0.10317219, 0.10644501, 0.10982166, 0.11330541, 0.11689968, 0.12060796, 0.12443388, 0.12838116, 0.13245366, 0.13665535, 0.14099032, 0.14546281, 0.15007717, 0.15483791, 0.15974966, 0.16481723, 0.17004555, 0.17543973, 0.18100501, 0.18674684, 0.19267081, 0.1987827, 0.20508848, 0.21159428, 0.21830646, 0.22523156, 0.23237634, 0.23974777, 0.24735303, 0.25519955, 0.26329497, 0.2716472, 0.28026437, 0.2891549, 0.29832745, 0.30779097, 0.3175547, 0.32762815, 0.33802115, 0.34874383, 0.35980666, 0.37122042, 0.38299625, 0.39514563, 0.40768042, 0.42061283, 0.43395548, 0.44772139, 0.46192397, 0.4765771, 0.49169504, 0.50729256, 0.52338486, 0.53998764, 0.55711709, 0.57478992, 0.59302337, 0.61183522, 0.63124382, 0.65126809, 0.67192757, 0.69324242, 0.71523341, 0.73792199, 0.7613303, 0.78548117, 0.81039816, 0.83610555, 0.86262844, 0.88999268, 0.91822497, 0.94735284, 0.9774047, 1.00840987, 1.04039858, 1.07340203, 1.10745242, 1.14258295, 1.17882789, 1.21622259, 1.25480353, 1.29460832, 1.3356758, 1.37804602, 1.4217603, 1.46686129, 1.51339296, 1.56140071, 1.61093136, 1.66203322, 1.71475613, 1.76915151, 1.82527242, 1.88317359, 1.94291149, 2.0045444, 2.06813243, 2.13373758, 2.20142387, 2.27125729, 2.34330596, 2.41764016, 2.49433238, 2.57345742, 2.65509247, 2.73931713, 2.82621357, 2.91586653, 3.00836345, 3.10379456, 3.20225292, 3.30383458, 3.4086386, 3.5167672, 3.62832586, 3.74342337, 3.862172, 3.98468756, 4.11108955, 4.24150126, 4.37604988, 4.51486665, 4.65808695, 4.80585047, 4.95830134, 5.11558824, 5.27786459, 5.44528866, 5.61802375, 5.79623832, 5.98010621, 6.16980674, 6.36552494, 6.5674517, 6.77578396, 6.99072493, 7.21248424, 7.44127819, 7.67732992, 7.92086967, 8.17213497, 8.43137089, 8.69883028, 8.97477399, 9.25947118, 9.5531995, 9.85624546, 10.16890463, 10.49148194, 10.82429203, 11.1676595, 11.52191926, 11.88741681, 12.26450866, 12.65356258, 13.05495805, 13.46908657, 13.89635203, 14.33717119, 14.79197398, 15.26120399, 15.74531889, 16.24479085, 16.76010702, 17.29177002, 17.8402984, 18.40622716, 18.99010827, 19.59251122, 20.21402356, 20.85525147, 21.51682037, 22.19937551, 22.90358262, 23.63012855, 24.37972191, 25.15309383, 25.9509986, 26.77421445, 27.6235443, 28.49981653, 29.40388582, 30.33663392, 31.29897061, 32.29183447, 33.31619389, 34.37304798, 35.46342752, 36.58839601, 37.74905067, 38.94652355, 40.18198257, 41.45663275, 42.7717173, 44.12851887, 45.5283608, 46.97260844, 48.46267039, 50.]), 'operator': 'konno_and_ohmachi'}, fft_settings=None, handle_dissimilar_time_steps_by='frequency_domain_resampling', processing_method='azimuthal', azimuths_in_degrees=array([0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65, 70, 75, 80, 85, 90, 95, 100, 105, 110, 115, 120, 125, 130, 135, 140, 145, 150, 155, 160, 165, 170, 175]))
__init__(hvsrpy_version='2.2.0rc1', window_type_and_width=['tukey', 0.1], smoothing={'bandwidth': 40, 'center_frequencies_in_hz': array([0.1, 0.10317219, 0.10644501, 0.10982166, 0.11330541, 0.11689968, 0.12060796, 0.12443388, 0.12838116, 0.13245366, 0.13665535, 0.14099032, 0.14546281, 0.15007717, 0.15483791, 0.15974966, 0.16481723, 0.17004555, 0.17543973, 0.18100501, 0.18674684, 0.19267081, 0.1987827, 0.20508848, 0.21159428, 0.21830646, 0.22523156, 0.23237634, 0.23974777, 0.24735303, 0.25519955, 0.26329497, 0.2716472, 0.28026437, 0.2891549, 0.29832745, 0.30779097, 0.3175547, 0.32762815, 0.33802115, 0.34874383, 0.35980666, 0.37122042, 0.38299625, 0.39514563, 0.40768042, 0.42061283, 0.43395548, 0.44772139, 0.46192397, 0.4765771, 0.49169504, 0.50729256, 0.52338486, 0.53998764, 0.55711709, 0.57478992, 0.59302337, 0.61183522, 0.63124382, 0.65126809, 0.67192757, 0.69324242, 0.71523341, 0.73792199, 0.7613303, 0.78548117, 0.81039816, 0.83610555, 0.86262844, 0.88999268, 0.91822497, 0.94735284, 0.9774047, 1.00840987, 1.04039858, 1.07340203, 1.10745242, 1.14258295, 1.17882789, 1.21622259, 1.25480353, 1.29460832, 1.3356758, 1.37804602, 1.4217603, 1.46686129, 1.51339296, 1.56140071, 1.61093136, 1.66203322, 1.71475613, 1.76915151, 1.82527242, 1.88317359, 1.94291149, 2.0045444, 2.06813243, 2.13373758, 2.20142387, 2.27125729, 2.34330596, 2.41764016, 2.49433238, 2.57345742, 2.65509247, 2.73931713, 2.82621357, 2.91586653, 3.00836345, 3.10379456, 3.20225292, 3.30383458, 3.4086386, 3.5167672, 3.62832586, 3.74342337, 3.862172, 3.98468756, 4.11108955, 4.24150126, 4.37604988, 4.51486665, 4.65808695, 4.80585047, 4.95830134, 5.11558824, 5.27786459, 5.44528866, 5.61802375, 5.79623832, 5.98010621, 6.16980674, 6.36552494, 6.5674517, 6.77578396, 6.99072493, 7.21248424, 7.44127819, 7.67732992, 7.92086967, 8.17213497, 8.43137089, 8.69883028, 8.97477399, 9.25947118, 9.5531995, 9.85624546, 10.16890463, 10.49148194, 10.82429203, 11.1676595, 11.52191926, 11.88741681, 12.26450866, 12.65356258, 13.05495805, 13.46908657, 13.89635203, 14.33717119, 14.79197398, 15.26120399, 15.74531889, 16.24479085, 16.76010702, 17.29177002, 17.8402984, 18.40622716, 18.99010827, 19.59251122, 20.21402356, 20.85525147, 21.51682037, 22.19937551, 22.90358262, 23.63012855, 24.37972191, 25.15309383, 25.9509986, 26.77421445, 27.6235443, 28.49981653, 29.40388582, 30.33663392, 31.29897061, 32.29183447, 33.31619389, 34.37304798, 35.46342752, 36.58839601, 37.74905067, 38.94652355, 40.18198257, 41.45663275, 42.7717173, 44.12851887, 45.5283608, 46.97260844, 48.46267039, 50.]), 'operator': 'konno_and_ohmachi'}, fft_settings=None, handle_dissimilar_time_steps_by='frequency_domain_resampling', processing_method='azimuthal', azimuths_in_degrees=array([0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65, 70, 75, 80, 85, 90, 95, 100, 105, 110, 115, 120, 125, 130, 135, 140, 145, 150, 155, 160, 165, 170, 175]))

Initialize HvsrAzimuthalProcessingSettings object.

Parameters:

  • hvsrpy_version (str) – Denotes the version of hvsrpy used to create the Settings object. Should not be changed.

  • window_type_and_width (list, optional) – A list with entries like ["tukey", 0.1] that control the window type and width, respectively.

  • smoothing (dict, optional) – Smoothing information like dict(operator="konno_and_ohmachi", bandwidth=40, center_frequencies_in_hz=np.geomspace(0.1, 50, 200)).

  • fft_settings (dict or None, optional) – Custom settings for np.fft.rfft default is None.

  • handle_dissimilar_time_steps_by ({“frequency_domain_resampling”, “keeping_smallest_time_step”, “keeping_majority_time_step”}, optional) – Method to resolve multiple records with a different time step, default is "frequency_domain_resampling".

  • processing_method (str, optional) – Defines processing_method for later reference, default is 'azimuthal'. Should not be changed.

  • azimuths_in_degrees (iterable of float, optional) – Azimuths measured from north in degrees (clockwise positive) at which to compute single azimuth HVSRs.

Returns:

HvsrAzimuthalProcessingSettings – Object contains all user-defined settings to control azimuthal HVSR processing of microtremor or earthquake recordings.

property attr_dict

Dictionary of Settings object’s attributes.

load(fname)

Load Settings object from file on disk.

Parameters:

fname (str) – Name of file from which the Settings object information will be loaded. Can be a relative or the full path.

Returns:

None – Updates Settings object from information stored in a file on disk.

psummary()

Pretty summary of information in Settings object.

save(fname)

Save Settings object to file on disk.

Parameters:

fname (str) – Name of file to which the Settings object will be saved. Can be a relative or the full path.

Returns:

None – Instead saves Settings object information to file on disk.

class HvsrDiffuseFieldProcessingSettings(hvsrpy_version='2.2.0rc1', window_type_and_width=['tukey', 0.1], smoothing={'bandwidth': 40, 'center_frequencies_in_hz': array([0.1, 0.10317219, 0.10644501, 0.10982166, 0.11330541, 0.11689968, 0.12060796, 0.12443388, 0.12838116, 0.13245366, 0.13665535, 0.14099032, 0.14546281, 0.15007717, 0.15483791, 0.15974966, 0.16481723, 0.17004555, 0.17543973, 0.18100501, 0.18674684, 0.19267081, 0.1987827, 0.20508848, 0.21159428, 0.21830646, 0.22523156, 0.23237634, 0.23974777, 0.24735303, 0.25519955, 0.26329497, 0.2716472, 0.28026437, 0.2891549, 0.29832745, 0.30779097, 0.3175547, 0.32762815, 0.33802115, 0.34874383, 0.35980666, 0.37122042, 0.38299625, 0.39514563, 0.40768042, 0.42061283, 0.43395548, 0.44772139, 0.46192397, 0.4765771, 0.49169504, 0.50729256, 0.52338486, 0.53998764, 0.55711709, 0.57478992, 0.59302337, 0.61183522, 0.63124382, 0.65126809, 0.67192757, 0.69324242, 0.71523341, 0.73792199, 0.7613303, 0.78548117, 0.81039816, 0.83610555, 0.86262844, 0.88999268, 0.91822497, 0.94735284, 0.9774047, 1.00840987, 1.04039858, 1.07340203, 1.10745242, 1.14258295, 1.17882789, 1.21622259, 1.25480353, 1.29460832, 1.3356758, 1.37804602, 1.4217603, 1.46686129, 1.51339296, 1.56140071, 1.61093136, 1.66203322, 1.71475613, 1.76915151, 1.82527242, 1.88317359, 1.94291149, 2.0045444, 2.06813243, 2.13373758, 2.20142387, 2.27125729, 2.34330596, 2.41764016, 2.49433238, 2.57345742, 2.65509247, 2.73931713, 2.82621357, 2.91586653, 3.00836345, 3.10379456, 3.20225292, 3.30383458, 3.4086386, 3.5167672, 3.62832586, 3.74342337, 3.862172, 3.98468756, 4.11108955, 4.24150126, 4.37604988, 4.51486665, 4.65808695, 4.80585047, 4.95830134, 5.11558824, 5.27786459, 5.44528866, 5.61802375, 5.79623832, 5.98010621, 6.16980674, 6.36552494, 6.5674517, 6.77578396, 6.99072493, 7.21248424, 7.44127819, 7.67732992, 7.92086967, 8.17213497, 8.43137089, 8.69883028, 8.97477399, 9.25947118, 9.5531995, 9.85624546, 10.16890463, 10.49148194, 10.82429203, 11.1676595, 11.52191926, 11.88741681, 12.26450866, 12.65356258, 13.05495805, 13.46908657, 13.89635203, 14.33717119, 14.79197398, 15.26120399, 15.74531889, 16.24479085, 16.76010702, 17.29177002, 17.8402984, 18.40622716, 18.99010827, 19.59251122, 20.21402356, 20.85525147, 21.51682037, 22.19937551, 22.90358262, 23.63012855, 24.37972191, 25.15309383, 25.9509986, 26.77421445, 27.6235443, 28.49981653, 29.40388582, 30.33663392, 31.29897061, 32.29183447, 33.31619389, 34.37304798, 35.46342752, 36.58839601, 37.74905067, 38.94652355, 40.18198257, 41.45663275, 42.7717173, 44.12851887, 45.5283608, 46.97260844, 48.46267039, 50.]), 'operator': 'konno_and_ohmachi'}, fft_settings=None, handle_dissimilar_time_steps_by='keeping_majority_time_step', processing_method='diffuse_field')
__init__(hvsrpy_version='2.2.0rc1', window_type_and_width=['tukey', 0.1], smoothing={'bandwidth': 40, 'center_frequencies_in_hz': array([0.1, 0.10317219, 0.10644501, 0.10982166, 0.11330541, 0.11689968, 0.12060796, 0.12443388, 0.12838116, 0.13245366, 0.13665535, 0.14099032, 0.14546281, 0.15007717, 0.15483791, 0.15974966, 0.16481723, 0.17004555, 0.17543973, 0.18100501, 0.18674684, 0.19267081, 0.1987827, 0.20508848, 0.21159428, 0.21830646, 0.22523156, 0.23237634, 0.23974777, 0.24735303, 0.25519955, 0.26329497, 0.2716472, 0.28026437, 0.2891549, 0.29832745, 0.30779097, 0.3175547, 0.32762815, 0.33802115, 0.34874383, 0.35980666, 0.37122042, 0.38299625, 0.39514563, 0.40768042, 0.42061283, 0.43395548, 0.44772139, 0.46192397, 0.4765771, 0.49169504, 0.50729256, 0.52338486, 0.53998764, 0.55711709, 0.57478992, 0.59302337, 0.61183522, 0.63124382, 0.65126809, 0.67192757, 0.69324242, 0.71523341, 0.73792199, 0.7613303, 0.78548117, 0.81039816, 0.83610555, 0.86262844, 0.88999268, 0.91822497, 0.94735284, 0.9774047, 1.00840987, 1.04039858, 1.07340203, 1.10745242, 1.14258295, 1.17882789, 1.21622259, 1.25480353, 1.29460832, 1.3356758, 1.37804602, 1.4217603, 1.46686129, 1.51339296, 1.56140071, 1.61093136, 1.66203322, 1.71475613, 1.76915151, 1.82527242, 1.88317359, 1.94291149, 2.0045444, 2.06813243, 2.13373758, 2.20142387, 2.27125729, 2.34330596, 2.41764016, 2.49433238, 2.57345742, 2.65509247, 2.73931713, 2.82621357, 2.91586653, 3.00836345, 3.10379456, 3.20225292, 3.30383458, 3.4086386, 3.5167672, 3.62832586, 3.74342337, 3.862172, 3.98468756, 4.11108955, 4.24150126, 4.37604988, 4.51486665, 4.65808695, 4.80585047, 4.95830134, 5.11558824, 5.27786459, 5.44528866, 5.61802375, 5.79623832, 5.98010621, 6.16980674, 6.36552494, 6.5674517, 6.77578396, 6.99072493, 7.21248424, 7.44127819, 7.67732992, 7.92086967, 8.17213497, 8.43137089, 8.69883028, 8.97477399, 9.25947118, 9.5531995, 9.85624546, 10.16890463, 10.49148194, 10.82429203, 11.1676595, 11.52191926, 11.88741681, 12.26450866, 12.65356258, 13.05495805, 13.46908657, 13.89635203, 14.33717119, 14.79197398, 15.26120399, 15.74531889, 16.24479085, 16.76010702, 17.29177002, 17.8402984, 18.40622716, 18.99010827, 19.59251122, 20.21402356, 20.85525147, 21.51682037, 22.19937551, 22.90358262, 23.63012855, 24.37972191, 25.15309383, 25.9509986, 26.77421445, 27.6235443, 28.49981653, 29.40388582, 30.33663392, 31.29897061, 32.29183447, 33.31619389, 34.37304798, 35.46342752, 36.58839601, 37.74905067, 38.94652355, 40.18198257, 41.45663275, 42.7717173, 44.12851887, 45.5283608, 46.97260844, 48.46267039, 50.]), 'operator': 'konno_and_ohmachi'}, fft_settings=None, handle_dissimilar_time_steps_by='keeping_majority_time_step', processing_method='diffuse_field')

Initialize HvsrDiffuseFieldProcessingSettings object.

Parameters:

  • hvsrpy_version (str) – Denotes the version of hvsrpy used to create the Settings object. Should not be changed.

  • window_type_and_width (list, optional) – A list with entries like ["tukey", 0.1] that control the window type and width, respectively.

  • smoothing (dict, optional) – Smoothing information like dict(operator="konno_and_ohmachi", bandwidth=40, center_frequencies_in_hz=np.geomspace(0.1, 50, 200)).

  • fft_settings (dict or None, optional) – Custom settings for np.fft.rfft default is None.

  • handle_dissimilar_time_steps_by ({“frequency_domain_resampling”, “keeping_smallest_time_step”, “keeping_majority_time_step”}, optional) – Method to resolve multiple records with a different time step, default is "frequency_domain_resampling".

  • processing_method (str, optional) – Defines processing_method for later reference, default is 'diffuse_field'. Should not be changed.

Returns:

HvsrDiffuseFieldProcessingSettings – Object contains all user-defined settings to control diffuse-field HVSR processing of microtremor or earthquake recordings.

property attr_dict

Dictionary of Settings object’s attributes.

load(fname)

Load Settings object from file on disk.

Parameters:

fname (str) – Name of file from which the Settings object information will be loaded. Can be a relative or the full path.

Returns:

None – Updates Settings object from information stored in a file on disk.

psummary()

Pretty summary of information in Settings object.

save(fname)

Save Settings object to file on disk.

Parameters:

fname (str) – Name of file to which the Settings object will be saved. Can be a relative or the full path.

Returns:

None – Instead saves Settings object information to file on disk.