From fbd251521d910798be65e1cfba16d8934f5828b6 Mon Sep 17 00:00:00 2001
From: Peter Luenenschloss <peter.luenenschloss@ufz.de>
Date: Thu, 5 Dec 2019 17:24:25 +0100
Subject: [PATCH] Update FunctionDescriptions.md
---
docs/FunctionDescriptions.md | 35 +++++++++++++++++++++--------------
1 file changed, 21 insertions(+), 14 deletions(-)
diff --git a/docs/FunctionDescriptions.md b/docs/FunctionDescriptions.md
index 506b84bae..74a807157 100644
--- a/docs/FunctionDescriptions.md
+++ b/docs/FunctionDescriptions.md
@@ -624,7 +624,7 @@ NOTE, that, if:
Key word overview:
-`inter_method`:
+`inter_method` - keywords
1. Shifts:
* `"fshift"`: every grid point gets assigned its ultimately preceeding value - if there is one available in the preceeding sampling interval.
@@ -657,22 +657,29 @@ Key word overview:
special cases and do not properly interpolate grid-only.).
-`reshape_method` - (format currently broken - will solve tomorrow!)
+`reshape_method` - Keywords
- * `"fshift"`/`"'bshift"`: forward/backward projection. Only the very
- first/last flag will be projected onto the last/next grid point.
- Extra flag fields like "comment", just get shifted along with the flag.
+
+1. Shifts:
+ * `"fshift"`: every grid point gets assigned its ultimately preceeding flag
+ if there is one available in the preceeding sampling interval. If not, BAD - flag gets assigned.
+ * `"bshift"`: every grid point gets assigned its first succeeding flag
+ if there is one available in the succeeding sampling interval. If not, BAD - flag gets assigned.
+ * `"nearest_shift"`: every grid point gets assigned the flag in its range. ( range = +/- `freq`/2 ).
+ * Extra flag fields like "comment", just get shifted along with the flag.
Only inserted flags for empty intervals will take the **kwargs argument.
Set "`set_shift_comment`"" to `True`, to apply kwargs** to all flags.
- * `"fagg"`/`"bagg"`:All flags, referring to a sampling intervals measurements get aggregated forward/backward
- with the agg_method selected.
-
- * `"nearest_shift"`: Every grid point gets assigned the nearest flag in its range
- (range = grid_point +/-(`"freq"`/2)).Extra flag fields like comment,
- just get shifted along with the flag. Only inserted flags for empty intervals will take the
- **kwargs argument.
- * `"nearest_agg"`: Every grid point gets assigned the aggregation (generated by the function passed to `agg_method`),
- of all the flags in its range.
+2. Aggregations:
+ * `"fagg"`: all falgs in a sampling interval get aggregated with the function passed to `agg_method`
+ , and the result gets assigned to the last grid point.
+ * `"bagg"`: all flags in a sampling interval get aggregated with the function passed to `agg_method`
+ , and the result gets assigned to the next grid point.
+ * `"nearest_agg"`: all flags in the range (+/- freq/2) of a grid point get
+ aggregated with the function passed to agg_method and assigned to it.
+
+
+
+
--
GitLab