From 105e4a11a149d835e786e0129d360c43dd5e3d0f Mon Sep 17 00:00:00 2001 From: kkappler Date: Fri, 24 Nov 2023 00:46:52 -0800 Subject: [PATCH] add doc --- mth5/timeseries/channel_ts.py | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/mth5/timeseries/channel_ts.py b/mth5/timeseries/channel_ts.py index 45e5ee5c..3a7a0298 100644 --- a/mth5/timeseries/channel_ts.py +++ b/mth5/timeseries/channel_ts.py @@ -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"