Skip to content

Commit

Permalink
Revise cadence plot docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
bbrzycki committed Dec 1, 2023
1 parent bae5b64 commit 733dc98
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
1 change: 0 additions & 1 deletion setigen/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
lorentzian_f_profile, voigt_f_profile, sinc2_f_profile,
constant_bp_profile
)
from setigen import voltage

from setigen.distributions import fwhm, gaussian, truncated_gaussian, chi2
from setigen.waterfall_utils import (
Expand Down
10 changes: 7 additions & 3 deletions setigen/cadence.py
Original file line number Diff line number Diff line change
Expand Up @@ -176,11 +176,15 @@ def plot(self, *args, **kwargs):
----------
cadence : Cadence
Cadence to plot
xtype : {"fmid", "fmin", "f", "px"}, default: "fmid"
Types of axis labels, particularly the x-axis. "px" puts axes in units
of pixels. The others are all in frequency: "fmid" shows frequencies
ftype : {"fmid", "fmin", "f", "px", "bins"}, default: "fmid"
Type of frequency axis labels. "px" and "bins" put the axis in units of
pixels (bins). The others are all in frequency: "fmid" shows frequencies
relative to the central frequency, "fmin" is relative to the minimum
frequency, and "f" is absolute frequency.
ttype : {"same", "trel", "px", "bins"}, default: "same"
Type of time axis labels. "same" matches time axis style with the
frequency axis. "px" and "bins" put the axis in units of pixels (bins),
and "trel" sets the axis in time units relative to the start.
db : bool, default: True
Option to convert intensities to dB
slew_times : bool, default: False
Expand Down

0 comments on commit 733dc98

Please sign in to comment.