From 2c9ab9183694b4e79dfd605b15f44273314d2e92 Mon Sep 17 00:00:00 2001
From: thorbjoernl <51087536+thorbjoernl@users.noreply.github.com>
Date: Fri, 10 Jan 2025 13:00:42 +0100
Subject: [PATCH] docs: Add general description of vfloor filter

---
 src/pyaro/timeseries/Filter.py | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/pyaro/timeseries/Filter.py b/src/pyaro/timeseries/Filter.py
index 99ff94b..4058e05 100644
--- a/src/pyaro/timeseries/Filter.py
+++ b/src/pyaro/timeseries/Filter.py
@@ -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