Skip to content

Commit

Permalink
docs: Add general description of vfloor filter
Browse files Browse the repository at this point in the history
  • Loading branch information
thorbjoernl committed Jan 10, 2025
1 parent a5026a1 commit 2c9ab91
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/pyaro/timeseries/Filter.py
Original file line number Diff line number Diff line change
Expand Up @@ -1208,6 +1208,12 @@ def filter_stations(self, stations: dict[str, Station]) -> dict[str, Station]:
@registered_filter
class ValleyFloorRelativeAltitudeFilter(StationFilter):
"""
Filter for filtering stations based on the difference between the station altitude and valley
floor altitude (defined as the lowest altitude within a radius around the station). This ensures
that plateau sites are treated like "surface" sites, while sites in hilly or mountaineous areas
(eg. Schauinsland) are considered mountain sites. This approach has been used by several papers
(eg. Fowler et al., Lloibl et al. 1994).
:param topo: Topography file path (either a file or a directory). Must be a dataset openable by
xarray, with latitude and longitude stored as "lat" and "lon" respectively. The variable
that contains elevation data is assumed to be in meters. If `topo` is a directory, a
Expand Down

0 comments on commit 2c9ab91

Please sign in to comment.