The SKIRT project
advanced radiative transfer for astrophysics
Functions
pts.visual.plotconvergencecuts Namespace Reference

Plot planar cuts through the input and gridded medium density in a SKIRT simulation. More...

Functions

def _convergenceInfoPath (simulation, cutsprobe)
 This private function returns the path to the output file of the first convergence info probe that has the same probeAfter property value as the requesting convergence cuts probe, or None if there is no such probe. More...
 
def _latexForNumber (value)
 This private function returns a latex string for a numeric value with appropriate exponential notation. More...
 
def plotConvergenceCuts (simulation, decades=5, *outDirPath=None, outFileName=None, outFilePath=None, figSize=None, interactive=None)
 This function creates plots of the planar cuts through the input and gridded medium density produced by the convergence cuts probe in a SKIRT simulation. More...
 

Detailed Description

Plot planar cuts through the input and gridded medium density in a SKIRT simulation.

The function in this module creates plots of the planar cuts through the input and gridded medium density produced by the convergence cuts probe in a SKIRT simulation. This allows a visual comparison between the medium density distribution of the input model and the corresponding spatially discretized version used in the simulation.

Function Documentation

◆ _convergenceInfoPath()

def pts.visual.plotconvergencecuts._convergenceInfoPath (   simulation,
  cutsprobe 
)
private

This private function returns the path to the output file of the first convergence info probe that has the same probeAfter property value as the requesting convergence cuts probe, or None if there is no such probe.

◆ _latexForNumber()

def pts.visual.plotconvergencecuts._latexForNumber (   value)
private

This private function returns a latex string for a numeric value with appropriate exponential notation.

◆ plotConvergenceCuts()

def pts.visual.plotconvergencecuts.plotConvergenceCuts (   simulation,
  decades = 5,
outDirPath = None,
  outFileName = None,
  outFilePath = None,
  figSize = None,
  interactive = None 
)

This function creates plots of the planar cuts through the input and gridded medium density produced by the convergence cuts probe in a SKIRT simulation.

This allows a visual comparison between the medium density distribution of the input model and the corresponding spatially discretized version used in the simulation.