diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..939a209 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,13 @@ +cff-version: 1.0.0 +message: "Please cite it as below." +authors: +- family-names: "Linke" + given-names: "Simon" + orcid: "https://orcid.org/0000-0001-9272-2518" +- family-names: "Ziemer" + given-names: "Tim" + orcid: "https://orcid.org/0000-0001-6821-7327" +title: "SOMson - Interactive sonification of self-organizing maps" +version: 1.0.0 +date-released: 2024-04-01 +url: "https://github.com/Simon-Linke/SOMson/" diff --git a/README.md b/README.md index a40c469..fe9bf83 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ # SOMson Interactive sonification of self-organizing maps + +Kohonen Maps, aka. self-organizing maps (SOMs) are neural networks that visualize a high-dimensional feature space on a low-dimensional map. While SOMs are an excellent tool for data examination and exploration, they inherently cause a loss of detail. Visualizations of the underlying data do not integrate well and, therefore, fail to provide an overall picture. Consequently, we suggest SOMson, an interactive sonification of the underlying data, as a data augmentation technique. The sonification increases the amount of information provided simultaneously by the SOM. + +Explore the sonification at https://simon-linke.github.io/SOMson/ + + +An in-depth explanation can be found in the associated publication: + +Linke, S. & Ziemer, T. (2024). SOMson - Sonification of Multidimensional Data in Kohonen Maps. In Proceedings of the 29th International Conference on Auditory Display (ICAD2024) (pp. 50–57). ICAD 2024: The 29th International Conference on Auditory Display. International Community for Auditory Display. https://doi.org/10.21785/icad2024.008 + + +## Dependencies +This project uses p5.sound (https://github.com/processing/p5.js-sound) for sound synthesis. Further, for proper display, js-colormaps (https://github.com/timothygebhard/js-colormaps) and jQuery (https://github.com/jquery/jquery) are used. diff --git a/SOMson/js/librarys/LICENSE_js-colormaps b/SOMson/js/librarys/LICENSE_js-colormaps new file mode 100644 index 0000000..43d82e6 --- /dev/null +++ b/SOMson/js/librarys/LICENSE_js-colormaps @@ -0,0 +1,22 @@ +The MIT License (MIT) + +Copyright (c) 2015 der_herr_g + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + diff --git a/SOMson/js/librarys/LICENSE_p5 b/SOMson/js/librarys/LICENSE_p5 new file mode 100644 index 0000000..6f11e49 --- /dev/null +++ b/SOMson/js/librarys/LICENSE_p5 @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2014-2015 The Processing Foundation + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/SOMsonExtended/js/librarys/LICENSE_js-colormaps b/SOMsonExtended/js/librarys/LICENSE_js-colormaps new file mode 100644 index 0000000..43d82e6 --- /dev/null +++ b/SOMsonExtended/js/librarys/LICENSE_js-colormaps @@ -0,0 +1,22 @@ +The MIT License (MIT) + +Copyright (c) 2015 der_herr_g + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + diff --git a/SOMsonExtended/js/librarys/LICENSE_p5 b/SOMsonExtended/js/librarys/LICENSE_p5 new file mode 100644 index 0000000..6f11e49 --- /dev/null +++ b/SOMsonExtended/js/librarys/LICENSE_p5 @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2014-2015 The Processing Foundation + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE.