From 0f1b175e133e41abede4a8f3dd29a85905ebdedd Mon Sep 17 00:00:00 2001 From: r-pascua Date: Mon, 6 Nov 2023 14:49:34 -0500 Subject: [PATCH] doc: note that filter params are in mHz --- hera_cal/frf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/hera_cal/frf.py b/hera_cal/frf.py index edf8c3fa4..fd34940d6 100644 --- a/hera_cal/frf.py +++ b/hera_cal/frf.py @@ -1694,7 +1694,8 @@ def load_tophat_frfilter_and_write( The file must be readable by yaml, with a "filter_centers" entry and a "filter_half_widths" entry. Each of these entries should correspond to dictionaries with antenna pair strings as keys and floating point - numbers as values. When writing filter parameters to a file, ensure + numbers as values. The filter centers and filter half widths are assumed + to be provided in mHz. When writing filter parameters to a file, ensure that the antenna pair keys have been converted to strings prior to dumping the contents to the file. See the file example_filter_params.yaml for an example.