pynkowski

Welcome to Pynkowski's documentation!

A Python package to compute Minkowski Functionals of input fields, as well as their expected values in the case of Gaussian isotropic fields.

The formats supported for input data are the following:

  • Scalar HEALPix maps, as the ones used by healpy (see paper).

...and more to come, feel free to contact us (by email or opening an issue) to implement more schemes.

The theoretical expectation for Gaussian isotropic fields are implemented in the following cases:

  • Gaussian scalar maps on the sphere (such as CMB $T$, see paper).
  • $\chi^2$ maps on the sphere (such as CMB $P^2$, see paper).

...and more to come, feel free to contact us (by email or opening an issue) to implement more theoretical expectations.

Installation

This package can be installed with:

pip install pynkowski

The dependencies are:

Example notebooks

  • Get the Minkowski Functionals of a CMB temperature $T$ map and compare with theory.
  • Get the Minkowski Functionals of a CMB polarization $P^2=Q^2+U^2$ map and compare with theory.
 1'''# Welcome to Pynkowski's documentation!
 2
 3A Python package to compute Minkowski Functionals of input fields, as well as their expected values in the case of Gaussian isotropic fields.
 4
 5The formats supported for **input data** are the following:
 6- Scalar HEALPix maps, as the ones used by [healpy](https://healpy.readthedocs.io/) (see paper).
 7
 8...and more to come, feel free to contact us (by [email](mailto:javier.carron@roma2.infn.it) or opening an issue) to implement more schemes.
 9
10
11The **theoretical expectation** for Gaussian isotropic fields are implemented in the following cases:
12- Gaussian scalar maps on the sphere (such as CMB $T$, see paper).
13- $\chi^2$ maps on the sphere (such as CMB $P^2$, see paper).
14
15...and more to come, feel free to contact us (by [email](mailto:javier.carron@roma2.infn.it) or opening an issue) to implement more theoretical expectations.
16
17## Installation
18
19This package can be installed with: 
20```
21pip install pynkowski
22```
23
24The dependencies are:
25- [numpy](https://numpy.org/)
26- [scipy](https://scipy.org/)
27- [healpy](https://healpy.readthedocs.io/)
28- [tqdm](https://github.com/tqdm/tqdm) (optional, notebook only)
29
30
31## Example notebooks
32
33- Get the Minkowski Functionals of a CMB temperature $T$ map and compare with theory.
34- Get the Minkowski Functionals of a CMB polarization $P^2=Q^2+U^2$ map and compare with theory.
35'''
36
37from .data import Scalar
38
39from .theory import (get_μ,
40                     TheoryTemperature,
41                     TheoryP2)
42
43from .__version import __version__
44
45
46
47
48__docformat__ = "numpy"