function decimate/resample_poly of RunTS will change the original RunTS.run_metadata.sample_rate

[Leee-Zzq]

platform: Windows-10-10.0.26200-SP0
python: 3.11.14
mth5: 0.6.4
mt_metadata: 1.0.4

The sample code is as follows:

---

run # an Object of RunTS

RunTS Summary:
Survey: 0
Station: mt001
Run: 001
Start: 2020-01-01T00:00:00+00:00
End: 2020-01-01T00:08:31.875000+00:00
Sample Rate: 8.0
Components: ['hx', 'hy', 'hz', 'ex', 'ey', 'temperature']

print(run.run_metadata.sample_rate)

8.0

decimated_run = run.decimate(1) # the behavior is same as run.resample_poly(1)
print(run.run_metadata.sample_rate)

1.0

---

I think that this operation should not modify the metadata of the run.

[kujaku11]

@Leee-Zzq The function is operating correctly. The input that you give decimation and resample_poly is the new sample rate. so if you give it 1 then the new sample rate should be 1. If you want to keep the same then give the original sample rate.

[Leee-Zzq]

The default value of inplace in the decimate function declaration is False.
Since there is an inplace parameter, the original object's sample_rate should not be modified by default.

def decimate(
        self, new_sample_rate: float, inplace: bool = False, max_decimation: int = 8
    ) -> RunTS | None:
        ...
        new_ds.attrs["sample_rate"] = new_sample_rate
        self.run_metadata.sample_rate = new_ds.attrs["sample_rate"]

        if inplace:
            self.dataset = new_ds
        else:
            # return new_ds
            return RunTS(
        ...