xopto.util.animation.sv.fiber.sds_reflectance module¶
- default_configuration() → dict[source]¶
Returns a copy of the default simulation configuration that can be optionally customized.
- process_config(config: dict) → dict[source]¶
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_distance(filename: str, config: Optional[dict] = None, cl_device: Optional[pyopencl._cl.Device] = None, overwrite: bool = False, verbose: bool = False)[source]¶
Generates data for visualization of the sampling volume in reflectance configuration as a function of the distance between the source and detector fiber.
- 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