Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incomplete docstring #3406

Open
speleos opened this issue Feb 20, 2024 · 0 comments
Open

Incomplete docstring #3406

speleos opened this issue Feb 20, 2024 · 0 comments

Comments

@speleos
Copy link

speleos commented Feb 20, 2024

def array_transff_freqslowness(coords, slim, sstep, fmin, fmax, fstep,
coordsys='lonlat'):
"""
Returns array transfer function as a function of slowness difference and
frequency.
:type coords: numpy.ndarray
:param coords: coordinates of stations in longitude and latitude in degrees
elevation in km, or x, y, z in km
:type coordsys: str
:param coordsys: valid values: 'lonlat' and 'xy', choose which coordinates
to use
:param slim: either a float to use symmetric limits for slowness
differences or the tupel (sxmin, sxmax, symin, symax)
:type fmin: float
:param fmin: minimum frequency in signal
:type fmax: float
:param fmax: maximum frequency in signal
:type fstep: float
:param fstep: frequency sample distance
"""

No description for sstep is provided

It is also acceptable to provide a Stream instead of a numpy.array with the coordinates.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant