Skip to content

Commit

Permalink
Simplify docstring for forward_parallax
Browse files Browse the repository at this point in the history
Simplify the documentation for the forward_parallax function based on a
suggestion by @ghiggi.
  • Loading branch information
gerritholl committed Jul 27, 2022
1 parent 66f02f1 commit a8fce07
Showing 1 changed file with 7 additions and 13 deletions.
20 changes: 7 additions & 13 deletions satpy/modifiers/parallax.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,19 +67,13 @@ class IncompleteHeightWarning(UserWarning):
def forward_parallax(sat_lon, sat_lat, sat_alt, lon, lat, height):
"""Calculate forward parallax effect.
Calculate the forward parallax effect. When a satellite instrument
observes the Earth, the geolocation assumes it sees the Earth surface
at the geoid (elevation zero). In reality, the field of view may
stop short of the geoid as it observes, for example, a cloud or
elevated ground. This function calculates the forward parallax
effect. If the view of a pixel at location (lat, lon) is blocked
by a cloud at height h, we calculate the location of this blocking.
Calculate parallax correction based on satellite position and
(cloud top) height coordinates in geodetic (unprojected) coordinates.
This function calculates the latitude and longitude belonging to the
cloud top, based on the location of the satellite and the location
of the cloud.
Satellite geolocation generally assumes an unobstructed view of a smooth
Earth surface. In reality, this view may be obstructed by clouds or
mountains.
If the view of a pixel at location (lat, lon) is blocked by a cloud
at height h, this function calculates the (lat, lon) coordinates
of the cloud above/in front of the invisible surface.
For scenes that are only partly cloudy, the user might set the cloud top
height for clear-sky pixels to NaN. This function will return a corrected
Expand Down

0 comments on commit a8fce07

Please sign in to comment.