pts.visual.do.plot_density Namespace Reference

Plot planar density cuts or projections from one or more SKIRT simulations. More...

Functions
"plot planar density cuts or projections from one or more SKIRT simulations"	do ((str, "SKIRT simulation output directory") simDirPath,(str,"SKIRT simulation prefix") prefix="",(float,"number of decades to be included in the density range (color bar)") dex=5)

Detailed Description

Plot planar density cuts or projections from one or more SKIRT simulations.

This script creates plots of the density cuts or projections produced by one of the relevant probes in a SKIRT simulation. The script supports DensityProbe, ImportedSourceDensityProbe, and/or ImportedMediumDensityProbe instances with an associated probe form that produces a planar cut (DefaultCutsForm, PlanarCutsForm) or planar projection (ParallelProjectionForm, AllSkyProjectionForm). For cuts, the plotted quantity is a mass or number density; for projections, the plotted quantity is a surface mass density or a column density. If the simulation does not include any supported probes, the script does nothing.

If the output for a given medium component or medium type (dust, gas, or electrons) includes two or three files with names that differ only by orientation labels ("_xy", "_xz", and/or "_yz"), the density maps for these files are included in a single plot and share the same scale.

The script takes the following arguments:

• simDirPath (positional string argument): the path to the SKIRT simulation output directory, or "." for the current directory
• prefix (string): the prefix of the simulation to handle; by default handles all simulations in the directory
• dex (float): if specified, the number of decades to be included in the density range (color bar); default is 5

In all cases, the plot file is placed next to the simulation output file(s) being handled. The filename includes the simulation prefix, the probe name, and the medium component or type indicator, and has the ".pdf" filename extension.