Skip to content

HITS-AIN/PINK

Repository files navigation

Build Status Join the chat at https://gitter.im/HITS-AIN-PINK/Lobby ascl:1910.001 PyPI version Open In Colab

Parallelized rotation and flipping INvariant Kohonen maps (PINK)

SOM of radio-synthesis data taken from the Radio Galaxy Zoo

Requirements

  • C++ with ISO 17 standard
  • CMake >= 3.18
  • CUDA >= 9.1 (highly recommended)
  • conan.io (optional for C++ dependencies) or
  • doxygen 1.8.13 (optional for developer documentation)

Conan.io will install automatically the C++ dependencies (PyBind11 and google-test). Otherwise you can also install these libraries yourself.

Installation

We provide deb- and rpm-packages at https://github.com/HITS-AIN/PINK/releases

or you can install PINK from the sources:

cmake -DCMAKE_INSTALL_PREFIX=<INSTALL_PATH> .
make install

PyPI installation

PINK is also available as PyPi package which can be installed by

pip install astro-pink

HPC deployment with EasyBuild

The EasyBuild recipe is available at https://github.com/BerndDoser/easybuild-easyconfigs/tree/hits/easybuild/easyconfigs/p/PINK.

Usage

To train a the self-organizing map (SOM) please execute

Pink --train <image-file> <result-file>

where image-file is the input file of images for the training and result-file is the output file for the trained SOM. All files are in binary mode described here.

To map an image to the trained SOM please execute

Pink --map <image-file> <result-file> <SOM-file>

where image-file is the input file of images for the mapping, SOM-file is the input file for the trained SOM, and result-file is the output file for the resulting heatmap.

Please use also the command Pink -h to get more informations about the usage and the options.

Python scripts

For conversion and visualization of images and SOM some python scripts are available.

  • convert_data_binary_file.py Convert binary data file from PINK version 1 to 2
  • show_heatmap.py: Visualize the mapping result
  • show_images.py: Visualize binary images file format
  • show_som.py: Visualize binary SOM file format
  • train.py: SOM training using the PINK Python interface

Publication

Kai Lars Polsterer, Fabian Gieseke, Christian Igel, Bernd Doser, and Nikos Gianniotis. Parallelized rotation and flipping INvariant Kohonen maps (PINK) on GPUs. 24th European Symposium on Artificial Neural Networks, Computational Intelligence and Machine Learning (ESANN), pp. 405-410, 2016. pdf

License

Distributed under the GNU GPLv3 License. See accompanying file LICENSE or copy at http://www.gnu.org/licenses/gpl-3.0.html.