pynbody.plot.stars.sbprofile

Contents

pynbody.plot.stars.sbprofile#

pynbody.plot.stars.sbprofile(sim, band='V', diskheight='3 kpc', rmax='20 kpc', binning='equaln', center=True, fit_exp=None, fit_sersic=None, **kwargs)[source]#

Make a surface brightness profile

Changed in version 2.0: The filename, axes and clear arguments have been removed. Use the matplotlib functions directly to save the figure or modify the axes.

If center is True, the transformation of the simulation is now reverted after the plot is made.

Parameters:

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

  • band (str, optional) – Which band to use; see pynbody.analysis.luminosity for available bands and more information about how surface brightnesses are calculated. Default is ‘v’.

  • diskheight (str, optional) – Height of disk to be profiled. Default is ‘3 kpc’.

  • rmax (str, optional) – Size of disk to be profiled. Default is ‘20 kpc’.

  • binning (str, optional) – How should bin sizes be determined? Default is ‘equaln’. See pynbody.analysis.profile for more information.

  • center (bool, optional) – Automatically align face on and center the simulation. Default is True.

  • fit_exp (float, optional) – If set, fit and plot an exponential profile to the data for radii greater than this value.

  • **kwargs – Additional keyword arguments are passed to the matplotlib plot function.

Returns:

  • r (array.SimArray) – Array of radii in kpc

  • sb (array.SimArray) – Array of surface brightnesses in mag arcsec^-2

  • 1/e (float) – The scale length of the exponential fit, in kpc, if fit_exp is set.

  • exp0 (float) – The central surface brightness of the exponential fit, in mag arcsec^-2, if fit_exp is set.

Contents