fiesta.arepo.ArepoCubicGrid.plot_projection#
- ArepoCubicGrid.plot_projection(projection='z', length_unit=None, ndensity_unit=Unit('1 / cm3'), log=False, mask_below=None, filaments=None, sinks=None, cmap='magma', save=None, **kwargs)[source]#
Plot the 2D projection of the number density grid. Can also plot filaments or AREPO sinks together!
- Parameters:
projection (
str
, optional) – Axis of projection of the grid, eitherx
,y
orz
.length_unit (
Unit
, optional) – The unit of length to use. IfNone
(default), takes the valueu.pix
ifscale='pixel'
, elseu.cm
ifscale='physical'
.ndensity_unit (
Unit
, optional) – The unit of number density to use. Default value isu.cm**-3
.log (
bool
, optional) – IfTrue
, the number density is plotted on a log-scale. IfFalse
(default), it is plotted on a linear scale.mask_below (
float
orQuantity
, optional) – The number density below which all grid points are omitted from the plot. This ensures only certain dense regions are plotted. Iffloat
, then assumed to be inndensity_unit
units.filaments (list of
Filament
’s) – List ofFilament
’s to plot along with the grid. Requires the filaments to have the samescale
as the grid.sinks (
list
oflist
’s, optional) – List of sink positions to plot. Requires the grid to havescale='physical'
.cmap (
str
orColormap
, optional) – Colormap of the plot. Default is'magma'
.save (
str
, optional) – File path to save the plot. IfNone
(default), plot is not saved.**kwargs (dict, optional) – Additional matplotlib-based keyword arguments to control finer details of the plot.
- Returns: