Commit a4bb4215 authored by thomas.forbriger's avatar thomas.forbriger
Browse files

[WP][DOC] (libstfinv): describe purpose of usage text files

parent 95956dc1
......@@ -100,4 +100,46 @@ doxygen_end_users.txt
doxygen_implementers.txt
doxygen_library_users.txt
end-user usage instructions
---------------------------
summary: more or less just a short list of options or description of purpose
description: a detailed description of theory of operation and all available
parameters; possibly together with examples
description of overall library:
usage/stfinv_summary_usage.txt
usage/stfinv_description_usage.txt
description of prodecure selection and configuration:
usage/stfinvany_description_usage.txt
usage/stfinvany_summary_usage.txt
description of options available for all procedures:
usage/stfinvbase_description_usage.txt
usage/stfinvbase_summary_usage.txt
description of Fourier domain least squares procedure:
usage/stfinvfdleastsquares_description_usage.txt
usage/stfinvfdleastsquares_summary_usage.txt
description of procedure for finite causal filter:
usage/stfinvfinitecausal_description_usage.txt
usage/stfinvfinitecausal_summary_usage.txt
description of procedure for fixed filter:
usage/stfinvfixedstf_description_usage.txt
usage/stfinvfixedstf_summary_usage.txt
description of common options for procedures in the Fourier domain:
usage/stfinvfourier_description_usage.txt
usage/stfinvfourier_summary_usage.txt
description of scaling procedure:
usage/stfinvidentity_description_usage.txt
usage/stfinvidentity_summary_usage.txt
description of normalization procedure:
usage/stfinvnormalize_description_usage.txt
usage/stfinvnormalize_summary_usage.txt
----- END OF README.files -----
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment