xopto.util.animation.sv.fiber.sv_paths_transmittance module

default_configuration() → dict

Returns a copy of the default simulation configuration that can be optionally customized.

process_config(config: dict) → dict

Process the simulation configuration. This will create objects for the Monte Carlo simulator and return the amendded configuration.

Parameters

config (dict) – Customized default configuration.

Returns

config – Configuration with the created Monte Carlo simulator objects.

Return type

dict

sv_fiber_paths_transmittance(filename: str, config: Optional[dict] = None, cl_device: Optional[pyopencl._cl.Device] = None, overwrite: bool = False, verbose: bool = False)

Generates data for visualization of the packet paths in transmittance configuration. Only the paths of photon packets that reach the detector are shown (packets that contribute to the sampling volume).

Parameters

• filename (str) – Output file for the simulation results or None.

• config (dict) – Monte Carlo configuration as returned by default_configuration() and optionally customized.

• cl_device – OpenCL device on which to run the simulations or None.

• overwrite (bool) – If False, existing output files will not be overwritten.

• verbose – If nonzero, progress reports are periodically printed to the console.

Returns

results – Simulation results with and simulation configuration data.

Return type

dict