API

The autogenerated API reference below is complemented by the ContMap — continuum map analysis and stacking guide, which highlights the map analysis and stacking workflows most commonly used in practice.

Classes

ContMap(data, *args, **kwargs)

A ContMap object represent a continuum map with additionnal capabilities.

NikaBeam(*args, **kwargs)

NikaBeam describe the beam of a NikaMap.

NikaMap(data, *args, **kwargs)

A NikaMap object represent a nika map with additionnal capabilities.

HalfDifference(filenames[, parity_threshold])

A class to create weighted half differences uncertainty maps from a list of scans.

Jackknife(filenames[, n_samples, ...])

A class to create weighted Jackknife maps from a list of scans.

Bootstrap(filenames[, n_bootstrap])

A class to create bootstraped maps from a list of scans.

Functions

fake_data([shape, beam_fwhm, pixsize, nefd, ...])

Build a synthetic NikaMap-like dataset for tests and examples.