calc_rays

qdflow.generate.calc_rays(physics, centers, rays, resolution, numerics=None, include_excited=False, include_converged=False, include_current=False)

Calculates ray data, varying multiple plunger voltages at once to move along an arbitrary ray in voltage space.

Parameters:
  • physics (PhysicsParameters) – The physical parameters of the device to simulate.

  • centers (ndarray[float]) – An array with shape (n_centers, n_dots) indicating the points from which rays should start.

  • rays (ndarray[float]) – An array with shape (n_rays, n_dots) indicating the direction and length of from each ray that extends from a single center point.

  • resolution (int) – The number of points per ray to simulate.

  • numerics (NumericsParameters | None) – The numeric parameters to be used during the simulation.

  • include_excited (bool) – Whether to include excited state data for applying latching effects.

  • include_converged (bool) – Whether to include data about whether the simulation properly converged at each pixel.

Returns:

A RaysOutput object wrapping the results of the computation.

Return type:

RaysOutput