Changes between Version 17 and Version 18 of AddFilterAlgorithm

Timestamp:

Dec 4, 2011, 12:51:33 PM (12 years ago)

Author:

lnerger

Comment:

--

AddFilterAlgorithm

@@ -24 +24 @@
 The routine `PDAF_get_state` calls
  * `PDAF_initinfo_filters` - interface routine to `PDAF_X_initinfo`
-   * `PDAF_X_initinfo` displays information on the current configuration of the filter algorithm.
+   * `PDAF_X_initinfo` displays information on the chosen configuration of the filter algorithm.
 
 
@@ -134 +134 @@
  * Available subtypes (At least '0' for standard implementation; '5' for offline mode)
  * Parameters used from the parameter arrays `param_int` and `param_real`.
+
+
+
+=== `PDAF_X_initinfo` ===
+
+The routine `PDAF_X_initinfo` displays information on the chosen configuration of the filter algorithm.
+
+The interface is as follows:
+{{{
+  SUBROUTINE PDAF_X_initinfo()
+}}}
+It has no arguments!
+
+The following functionality is recommended:
+ * Display the name of the filter method
+ * Display a string about the selected subtype of the filter method
+ * Display the ensemble size and value of the forgetting factor
+ * Display additional information on options selected by entries in the parameter arrays `param_int` and `param_real`