Skip to content

Commit

Permalink
add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
kkappler committed Nov 24, 2023
1 parent ae841ab commit 105e4a1
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions mth5/timeseries/channel_ts.py
Original file line number Diff line number Diff line change
Expand Up @@ -1046,11 +1046,18 @@ def channel_response_filter(self, value):

def get_response_correction_operation_and_units(self):
"""
This is a hack for now until we come up with a standard for
setting up the filter list. Currently it follows the FDSN standard
which has the filter stages starting with physical units to digital
counts.
We need to know if the response removal is done by mulitplication or by division.
FDSN standards use division. This boils down to checking
whether the filters are being "applied" or "unapplied".
Consider changing the attribute "applied", to "correction_applied"
:return:
FDSN standards use division. This boils down to checking whether the
channel_response_filter units_in or units_out match the input time series.
Consider changing the attribute "applied", to "response_removed"
:return: tuple, calibration_operation, either "mulitply" or divide", and a string for calibrated units
:rtype: tuple (of two strings_
"""
if self.channel_response_filter.units_out == self.channel_metadata.units:
calibration_operation = "divide"
Expand Down

0 comments on commit 105e4a1

Please sign in to comment.