Ctrl+K

pynbody.plot.stars.contour_surface_brightness

pynbody.plot.stars.contour_surface_brightness#

pynbody.plot.stars.contour_surface_brightness(sim, band='v', width=50, resolution=None, axes=None, label=True, contour_kwargs=None, smooth_min=0.0)[source]#

Plot surface brightness contours in the given band.

For information about how surface brightnesses are calculated, see the documentation for pynbody.analysis.luminosity.

Parameters:

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

  • band (str) – The band to plot. Default is ‘v’.

  • width (float | str, optional) – The width of the image to produce

  • resolution (int, optional) – The resolution of the image to produce. The default is determined by the configuration option image-default-resolution.

  • axes (matplotlib axes object, optional) – If not None, the axes object to plot to

  • label (bool, optional) – If True, the contours are labelled with the surface brightness in mag arcsec^-2

  • contour_kwargs (dict or None, optional) – Keyword arguments to pass to the matplotlib contour plot function. For example, this can be used to determine the contour levels.

  • smooth_min (float or str, optional) – The minimum size of the smoothing kernel, either as a float or a unit string. Setting this to a non-zero value makes smoother, clearer contours but loses fine detail. Default is 0.0.

Contents