Skip to content

Commit

Permalink
doc: note that filter params are in mHz
Browse files Browse the repository at this point in the history
  • Loading branch information
r-pascua authored and jsdillon committed Nov 7, 2023
1 parent d7d69b2 commit 0f1b175
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion hera_cal/frf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 0f1b175

Please sign in to comment.