summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2013-10-16 10:42:30 +0200
committerMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2013-10-22 20:32:38 +0200
commitc452735ef2f3612779b1cff8081adf1704f94009 (patch)
tree1e98a41b8d3a45db22bf1585b43ccb3678b4d6fd /README.md
parent1d1f7e09f89bc86a9fc540b88e9cbc2316c4056f (diff)
downloadufo-filters-c452735ef2f3612779b1cff8081adf1704f94009.tar.gz
ufo-filters-c452735ef2f3612779b1cff8081adf1704f94009.tar.bz2
ufo-filters-c452735ef2f3612779b1cff8081adf1704f94009.tar.xz
ufo-filters-c452735ef2f3612779b1cff8081adf1704f94009.zip
Add README
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6758e1b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+## UFO base plugins
+
+This repository contains basic plugins used in combination with the UFO data
+processing [framework](https://github.com/ufo-kit/ufo-core).
+
+### Data sources
+
+* TIFF and EDF reader
+* Metaball generator
+* [libuca](https://github.com/ufo-kit/libuca) camera source
+
+### Data filters
+
+* Averager
+* Backprojection, ART and DFI
+* Flat-field correction
+* FFT and inverse FFT for 1-, 2- and 3-dimensional data
+* 1D frequency filters
+* Cropping
+* Complex arithmetics
+* Volume rendering
+* Generic OpenCL
+
+### Data sinks
+
+* TIFF and EDF writer
+* Pipe connection
+
+
+## Further information
+
+A description of each plugins property is given at
+
+* [Task reference](http://ufo.kit.edu/extra/filters/reference/)
+
+
+## License
+
+Both ufo-core and ufo-filters are licensed under LGPL 3.