Skip to content

Commit

Permalink
Minor beam docstring improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
bhazelton committed Dec 18, 2024
1 parent fda905a commit e7491e0
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
6 changes: 4 additions & 2 deletions src/pyuvdata/beam_interface.py
Original file line number Diff line number Diff line change
Expand Up @@ -266,13 +266,15 @@ def compute_response(
spline_opts : dict
Provide options to numpy.RectBivariateSpline. This includes spline
order parameters `kx` and `ky`, and smoothing parameter `s`. Only
applies if beam is a UVBeam and interpolation_function is "az_za_simple".
applies if beam is a UVBeam and interpolation_function is "az_za_simple"
or "az_za_map_coordinates".
check_azza_domain : bool
Whether to check the domain of az/za to ensure that they are covered by the
intrinsic data array. Checking them can be quite computationally expensive.
Conversely, if the passed az/za are outside of the domain, they will be
silently extrapolated and the behavior is not well-defined. Only
applies if beam is a UVBeam and interpolation_function is "az_za_simple".
applies if beam is a UVBeam and interpolation_function is "az_za_simple"
or "az_za_map_coordinates".
Returns
-------
Expand Down
4 changes: 2 additions & 2 deletions src/pyuvdata/uvbeam/uvbeam.py
Original file line number Diff line number Diff line change
Expand Up @@ -2064,7 +2064,7 @@ def interp(
or for frequency only interpolation.
reuse_spline : bool
Save the interpolation functions for reuse. Only applies for
`az_za_simple` interpolation.
`az_za_simple` and `az_za_map_coordinates` interpolation.
spline_opts : dict
Provide options to numpy.RectBivariateSpline. This includes spline
order parameters `kx` and `ky`, and smoothing parameter `s`.
Expand All @@ -2083,7 +2083,7 @@ def interp(
intrinsic data array. Checking them can be quite computationally expensive.
Conversely, if the passed az/za are outside of the domain, they will be
silently extrapolated and the behavior is not well-defined. Only
applies for `az_za_simple` interpolation.
applies for `az_za_simple` and `az_za_map_coordinates` interpolation.
return_basis_vector : bool
Whether to return the interpolated basis vectors. Prior to v3.1.1 these
were always returned. In v3.3+ they will _not_ be returned by default
Expand Down

0 comments on commit e7491e0

Please sign in to comment.