pynbody.plot.generic.fourier_map

Contents

pynbody.plot.generic.fourier_map#

pynbody.plot.generic.fourier_map(sim, nbins=100, nmin=1000, nphi=100, mmin=1, mmax=7, rmax=10, levels=[0.01, 0.05, 0.1, 0.2], return_array=False, **kwargs)[source]#

Plot an overdensity map generated from a Fourier expansion of the particle distribution.

A Profile() is made and passed to inv_fourier() to obtain an overdensity map. The map is plotted using matplotlib.contour.

Changed in version 2.0: The subplot keyword has been removed for consistency with other plotting functions. If you want to plot on a specific subplot, select that subplot first using the matplotlib interface.

The ret keyword has been renamed to return_values for consistency with other plotting functions.

Parameters:

  • sim (SimSnap) – The simulation snapshot to analyze.

  • nbins (int, optional) – Number of radial bins to use for the profile. Default is 100.

  • nmin (int, optional) – Minimum number of particles required per bin. Default is 1000.

  • nphi (int, optional) – Number of azimuthal bins to use for the map. Default is 100.

  • mmin (int, optional) – Lowest multiplicity Fourier component. Default is 1.

  • mmax (int, optional) – Highest multiplicity Fourier component. Default is 7.

  • rmax (float, optional) – Maximum radius to use when generating the profile. Default is 10.

  • levels (list, optional) – List of levels for plotting contours. Default is [0.01, 0.05, 0.1, 0.2].

  • return_array (bool, optional) – If True, return the arrays used to make the plot.

Returns:

  • If *return_array is True, return the x, y, and value arrays used to make the plot.*

  • Otherwise, returns None.

Contents