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.

Sign up for GitHub

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

Jump to bottom

Clarify documentation regarding attributes used in get_angles #2020

Merged
merged 5 commits into from Feb 15, 2022
Merged

Clarify documentation regarding attributes used in get_angles #2020

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d988f11
Update get_angles documentation
ghiggi Feb 14, 2022
e27f7d1
Remove trailing space
ghiggi Feb 14, 2022
e0ed411
Ready for RW
ghiggi Feb 14, 2022
bd73aee
Remove satellite_<lat/lon/alt> doc since deprecated
ghiggi Feb 14, 2022
ef57885
Fix dataset_metadata reference in sphinx to be above section title
djhoese Feb 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 6 additions & 1 deletion satpy/modifiers/angles.py
View file
Open in desktop
Expand Up @@ -250,13 +250,18 @@ def get_angles(data_arr: xr.DataArray) -> tuple[xr.DataArray, xr.DataArray, xr.D

Args:
data_arr: DataArray to get angles for. Information extracted from this
object are ``.attrs["area"]`` and ``.attrs["start_time"]``.
object are ``.attrs["area"]``,``.attrs["start_time"]``, and
``.attrs["orbital_parameters"]`` or the available
``.attrs["satellite_longitude"]``, ``.attrs["satellite_latitude"]``,
and ``.attrs["satellite_altitude"]``.
ghiggi marked this conversation as resolved.
Show resolved Hide resolved
Additionally, the dask array chunk size is used when generating
new arrays. The actual data of the object is not used.

Returns:
Four DataArrays representing sensor azimuth angle, sensor zenith angle,
solar azimuth angle, and solar zenith angle. All values are in degrees.
Sensor angles are provided in the [0, 360] degree range.
Solar angles are provided in the [-180, 180] degree range.

"""
sata, satz = _get_sensor_angles(data_arr)
Expand Down