Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
GarethCabournDavies authored Jan 22, 2025
1 parent afbc553 commit c9959ad
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
10 changes: 5 additions & 5 deletions pycbc/psd/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ def from_cli(opt, length, delta_f, low_frequency_cutoff,
length : int
The length in samples of the output PSD.
delta_f : float
The frequency step of the output PSD in herz.
The frequency step of the output PSD in hertz.
low_frequency_cutoff: float
The low frequency cutoff to use when calculating the PSD, in herz.
The low frequency cutoff to use when calculating the PSD, in hertz.
strain : {None, TimeSeries}
Time series containing the data from which the PSD should be measured,
when psd_estimation is in use.
Expand Down Expand Up @@ -432,9 +432,9 @@ def generate_overlapping_psds(opt, gwstrain, flen, delta_f, flow,
flen : int
The length in samples of the output PSDs.
delta_f : float
The frequency step of the output PSDs in herz.
The frequency step of the output PSDs in hertz.
flow: float
The low frequency cutoff to use when calculating the PSD, in herz.
The low frequency cutoff to use when calculating the PSD, in hertz.
dyn_range_factor : {1, float}
For PSDs taken from models or text files, if `dyn_range_factor` is
not None, then the PSD is multiplied by `dyn_range_factor` ** 2.
Expand Down Expand Up @@ -524,7 +524,7 @@ def associate_psds_to_segments(opt, fd_segments, gwstrain, flen, delta_f, flow,
delta_f : float
The frequency step of the output PSDs.
flow: float
The low frequency cutoff to use when calculating the PSD.
The low frequency cutoff to use when calculating the PSD, in hertz.
dyn_range_factor : {1, float}
For PSDs taken from models or text files, if `dyn_range_factor` is
not None, then the PSD is multiplied by `dyn_range_factor` ** 2.
Expand Down
8 changes: 4 additions & 4 deletions pycbc/psd/analytical.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,9 @@ def from_string(psd_name, length, delta_f, low_freq_cutoff, **kwargs):
length : int
Length of the frequency series in samples.
delta_f : float
Frequency resolution of the frequency series, in herz.
Frequency resolution of the frequency series, in hertz.
low_freq_cutoff : float
Frequencies below this value (in herz) are set to zero.
Frequencies below this value (in hertz) are set to zero.
**kwargs :
All other keyword arguments are passed to the PSD model.
Expand Down Expand Up @@ -156,9 +156,9 @@ def flat_unity(length, delta_f, low_freq_cutoff):
length : int
Length of output Frequencyseries.
delta_f : float
Frequency step for output FrequencySeries, in herz.
Frequency step for output FrequencySeries, in hertz.
low_freq_cutoff : int
Low-frequency cutoff for output FrequencySeries, in herz.
Low-frequency cutoff for output FrequencySeries, in hertz.
Returns
-------
Expand Down

0 comments on commit c9959ad

Please sign in to comment.